pulumi-aws-native-kotlin/com.pulumi.awsnative.cloudwatch.kotlin.outputs

Package-level declarations

Types

data class AlarmDimension(val name: String, val value: String)

Dimension is an embedded property of the `AWS::CloudWatch::Alarm` type. Dimensions are name/value pairs that can be associated with a CW metric. You can specify a maximum of 10 dimensions for a given metric.

AlarmMetric

data class AlarmMetric(val dimensions: List<AlarmDimension>? = null, val metricName: String? = null, val namespace: String? = null)

The `Metric` property type represents a specific metric. `Metric` is a property of the MetricStat property type.

AlarmMetricDataQuery

data class AlarmMetricDataQuery(val accountId: String? = null, val expression: String? = null, val id: String, val label: String? = null, val metricStat: AlarmMetricStat? = null, val period: Int? = null, val returnData: Boolean? = null)

The `MetricDataQuery` property type specifies the metric data to return, and whether this call is just retrieving a batch set of data for one metric, or is performing a math expression on metric data. Any expression used must return a single time series. For more information, see Metric Math Syntax and Functions in the User Guide.

AlarmMetricStat

data class AlarmMetricStat(val metric: AlarmMetric, val period: Int, val stat: String, val unit: String? = null)

This structure defines the metric to be returned, along with the statistics, period, and units. `MetricStat` is a property of the MetricDataQuery property type.

GetAlarmResult

data class GetAlarmResult(val actionsEnabled: Boolean? = null, val alarmActions: List<String>? = null, val alarmDescription: String? = null, val arn: String? = null, val comparisonOperator: String? = null, val datapointsToAlarm: Int? = null, val dimensions: List<AlarmDimension>? = null, val evaluateLowSampleCountPercentile: String? = null, val evaluationPeriods: Int? = null, val extendedStatistic: String? = null, val insufficientDataActions: List<String>? = null, val metricName: String? = null, val metrics: List<AlarmMetricDataQuery>? = null, val namespace: String? = null, val okActions: List<String>? = null, val period: Int? = null, val statistic: String? = null, val tags: List<Tag>? = null, val threshold: Double? = null, val thresholdMetricId: String? = null, val treatMissingData: String? = null, val unit: String? = null)

GetCompositeAlarmResult

data class GetCompositeAlarmResult(val actionsEnabled: Boolean? = null, val actionsSuppressor: String? = null, val actionsSuppressorExtensionPeriod: Int? = null, val actionsSuppressorWaitPeriod: Int? = null, val alarmActions: List<String>? = null, val alarmDescription: String? = null, val alarmRule: String? = null, val arn: String? = null, val insufficientDataActions: List<String>? = null, val okActions: List<String>? = null, val tags: List<Tag>? = null)

GetDashboardResult

data class GetDashboardResult(val dashboardBody: String? = null)

GetMetricStreamResult

data class GetMetricStreamResult(val arn: String? = null, val creationDate: String? = null, val excludeFilters: List<MetricStreamFilter>? = null, val firehoseArn: String? = null, val includeFilters: List<MetricStreamFilter>? = null, val includeLinkedAccountsMetrics: Boolean? = null, val lastUpdateDate: String? = null, val outputFormat: String? = null, val roleArn: String? = null, val state: String? = null, val statisticsConfigurations: List<MetricStreamStatisticsConfiguration>? = null, val tags: List<Tag>? = null)

MetricStreamFilter

data class MetricStreamFilter(val metricNames: List<String>? = null, val namespace: String)

This structure defines the metrics that will be streamed.

MetricStreamStatisticsConfiguration

data class MetricStreamStatisticsConfiguration(val additionalStatistics: List<String>, val includeMetrics: List<MetricStreamStatisticsMetric>)

This structure specifies a list of additional statistics to stream, and the metrics to stream those additional statistics for. All metrics that match the combination of metric name and namespace will be streamed with the extended statistics, no matter their dimensions.

MetricStreamStatisticsMetric

data class MetricStreamStatisticsMetric(val metricName: String, val namespace: String)

A structure that specifies the metric name and namespace for one metric that is going to have additional statistics included in the stream.