Package com.pulumi.aws.cloudwatch

Class MetricAlarmArgs

  • public final class MetricAlarmArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • actionsEnabled

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> actionsEnabled()
        Returns:
        Indicates whether or not actions should be executed during any changes to the alarm's state. Defaults to `true`.

      • alarmActions

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> alarmActions()
        Returns:
        List of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an ARN.

      • alarmDescription

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> alarmDescription()
        Returns:
        The description for the alarm.

      • comparisonOperator

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> comparisonOperator()
        Returns:
        The arithmetic operation to use when comparing the specified Statistic and Threshold. The specified Statistic value is used as the first operand. Either of the following is supported: `GreaterThanOrEqualToThreshold`, `GreaterThanThreshold`, `LessThanThreshold`, `LessThanOrEqualToThreshold`. Additionally, the values `LessThanLowerOrGreaterThanUpperThreshold`, `LessThanLowerThreshold`, and `GreaterThanUpperThreshold` are used only for alarms based on anomaly detection models.

      • datapointsToAlarm

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> datapointsToAlarm()
        Returns:
        The number of data points that must be breaching to trigger the alarm.

      • dimensions

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> dimensions()
        Returns:
        The dimensions for the alarm's associated metric. For the list of available dimensions see the AWS documentation [here](http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).

      • evaluateLowSampleCountPercentiles

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> evaluateLowSampleCountPercentiles()
        Returns:
        Used only for alarms based on percentiles. If you specify `ignore`, the alarm state will not change during periods with too few data points to be statistically significant. If you specify `evaluate` or omit this parameter, the alarm will always be evaluated and possibly change state no matter how many data points are available. The following values are supported: `ignore`, and `evaluate`.

      • evaluationCriteria

        public java.util.Optional<com.pulumi.core.Output<MetricAlarmEvaluationCriteriaArgs>> evaluationCriteria()
        Returns:
        The evaluation criteria for PromQL alarms. Cannot be used with traditional metric alarm parameters.

      • evaluationInterval

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> evaluationInterval()
        Returns:
        The frequency, in seconds, at which the alarm is evaluated. Valid values are `10`, `20`, `30`, and any multiple of `60`. Required when using `evaluationCriteria`.

      • evaluationPeriods

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> evaluationPeriods()
        Returns:
        The number of periods over which data is compared to the specified threshold. Required for traditional metric alarms.

      • evaluationWindow

        public java.util.Optional<com.pulumi.core.Output<MetricAlarmEvaluationWindowArgs>> evaluationWindow()
        Returns:
        Configures the alarm to use a wall clock evaluation window instead of the default sliding window. Not supported for alarms that use `evaluationCriteria`. See `evaluationWindow` below.

      • extendedStatistic

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> extendedStatistic()
        Returns:
        The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

      • insufficientDataActions

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> insufficientDataActions()
        Returns:
        List of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an ARN.

      • metricName

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> metricName()
        Returns:
        The name for the alarm's associated metric. See docs for [supported metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).

      • metricQueries

        public java.util.Optional<com.pulumi.core.Output<java.util.List<MetricAlarmMetricQueryArgs>>> metricQueries()
        Returns:
        Enables you to create an alarm based on a metric math expression. You may specify at most 20.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        The descriptive name for the alarm. This name must be unique within the user's AWS account

      • namespace

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> namespace()
        Returns:
        The namespace for the alarm's associated metric. See docs for the [list of namespaces](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/aws-namespaces.html). See docs for [supported metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/CW_Support_For_AWS.html).

      • okActions

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> okActions()
        Returns:
        List of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an ARN.

      • period

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> period()
        Returns:
        The period in seconds over which the specified `statistic` is applied. Valid values are `10`, `20`, `30`, or any multiple of `60`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • statistic

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> statistic()
        Returns:
        The statistic to apply to the alarm's associated metric. Either of the following is supported: `SampleCount`, `Average`, `Sum`, `Minimum`, `Maximum`

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        A map of tags to assign to the resource. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level. See [related part of AWS Docs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricAlarm.html) for details about valid values. > **NOTE:** If you specify at least one `metricQuery`, you may not specify a `metricName`, `namespace`, `period` or `statistic`. If you do not specify a `metricQuery`, you must specify each of these (although you may use `extendedStatistic` instead of `statistic`).

      • threshold

        public java.util.Optional<com.pulumi.core.Output<java.lang.Double>> threshold()
        Returns:
        The value against which the specified statistic is compared. This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.

      • thresholdMetricId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> thresholdMetricId()
        Returns:
        If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.

      • treatMissingData

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> treatMissingData()
        Returns:
        Sets how this alarm is to handle missing data points. The following values are supported: `missing`, `ignore`, `breaching` and `notBreaching`. Defaults to `missing`.

      • unit

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> unit()
        Returns:
        The unit for the alarm's associated metric.

      • warmUpConfiguration

        public java.util.Optional<com.pulumi.core.Output<MetricAlarmWarmUpConfigurationArgs>> warmUpConfiguration()
        Returns:
        Warm-up period that delays alarm evaluation after the alarm is created. During the warm-up period the alarm stays in `INSUFFICIENT_DATA` and does not perform alarm actions. See `warmUpConfiguration` below.