Package com.pulumi.aws.cloudwatch.outputs

Class MetricAlarmMetricQuery

  • public final class MetricAlarmMetricQuery
extends java.lang.Object

    • Method Detail

      • accountId

        public java.util.Optional<java.lang.String> accountId()
        Returns:
        The ID of the account where the metrics are located, if this is a cross-account alarm.

      • expression

        public java.util.Optional<java.lang.String> expression()
        Returns:
        A Metrics Insights query or a metric math expression to be evaluated on the returned data. For details about Metrics Insights queries, see [Metrics Insights query components and syntax](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage) in the AWS documentation. For details about metric math expressions, see [Metric Math Syntax and Functions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax) in the AWS documentation.

      • id

        public java.lang.String id()
        Returns:
        A short name used to tie this object to the results in the response. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

      • label

        public java.util.Optional<java.lang.String> label()
        Returns:
        A human-readable label for this metric or expression. This is especially useful if this is an expression, so that you know what the value represents.

      • metric

        public java.util.Optional<MetricAlarmMetricQueryMetric> metric()
        Returns:
        The metric to be returned, along with statistics, period, and units. Use this parameter only if this object is retrieving a metric and not performing a math expression on returned data.

      • period

        public java.util.Optional<java.lang.Integer> period()
        Returns:
        Granularity in seconds of returned data points. For metrics with regular resolution, valid values are any multiple of `60`. For high-resolution metrics, valid values are `1`, `5`, `10`, `20`, `30`, or any multiple of `60`.

      • returnData

        public java.util.Optional<java.lang.Boolean> returnData()
        Returns:
        Specify exactly one `metricQuery` to be `true` to use that `metricQuery` result as the alarm. > **NOTE:** You must specify either `metric` or `expression`. Not both.