com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmMetricStat.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation

Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.

There is a newer version: 1.24.0.0

Show newest version

@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.cloudwatch.kotlin.outputs

import kotlin.Int
import kotlin.String
import kotlin.Suppress

/**
 * This structure defines the metric to be returned, along with the statistics, period, and units.
 *   ``MetricStat`` is a property of the [MetricDataQuery](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudwatch-alarm-metricdataquery.html) property type.
 * @property metric The metric to return, including the metric name, namespace, and dimensions.
 * @property period The granularity, in seconds, of the returned data points. For metrics with regular resolution, a period can be as short as one minute (60 seconds) and must be a multiple of 60. For high-resolution metrics that are collected at intervals of less than one minute, the period can be 1, 5, 10, 30, 60, or any multiple of 60. High-resolution metrics are those metrics stored by a ``PutMetricData`` call that includes a ``StorageResolution`` of 1 second.
 *  If the ``StartTime`` parameter specifies a time stamp that is greater than 3 hours ago, you must specify the period as follows or no data points in that time range is returned:
 *   +  Start time between 3 hours and 15 days ago - Use a multiple of 60 seconds (1 minute).
 *   +  Start time between 15 and 63 days ago - Use a multiple of 300 seconds (5 minutes).
 *   +  Start time greater than 63 days ago - Use a multiple of 3600 seconds (1 hour).
 * @property stat The statistic to return. It can include any CW statistic or extended statistic. For a list of valid values, see the table in [Statistics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Statistic) in the *User Guide*.
 * @property unit The unit to use for the returned data points.
 *  Valid values are: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, or None.
 */
public data class AlarmMetricStat(
    public val metric: AlarmMetric,
    public val period: Int,
    public val stat: String,
    public val unit: String? = null,
) {
    public companion object {
        public fun toKotlin(javaType: com.pulumi.awsnative.cloudwatch.outputs.AlarmMetricStat): AlarmMetricStat = AlarmMetricStat(
            metric = javaType.metric().let({ args0 ->
                com.pulumi.awsnative.cloudwatch.kotlin.outputs.AlarmMetric.Companion.toKotlin(args0)
            }),
            period = javaType.period(),
            stat = javaType.stat(),
            unit = javaType.unit().map({ args0 -> args0 }).orElse(null),
        )
    }
}