Package software.amazon.awscdk.services.cloudwatch

Class CfnAlarmProps.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.CfnAlarmProps.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnAlarmProps>
Enclosing interface:
CfnAlarmProps
@Stability(Stable) public static final class CfnAlarmProps.Builder extends Object implements software.amazon.jsii.Builder<CfnAlarmProps>
A builder for CfnAlarmProps

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • comparisonOperator

      @Stability(Stable) public CfnAlarmProps.Builder comparisonOperator(String comparisonOperator)
      Sets the value of CfnAlarmProps.getComparisonOperator()
      Parameters:
      comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. This parameter is required. The specified statistic value is used as the first operand.
      Returns:
      this

    • evaluationPeriods

      @Stability(Stable) public CfnAlarmProps.Builder evaluationPeriods(Number evaluationPeriods)
      Sets the value of CfnAlarmProps.getEvaluationPeriods()
      Parameters:
      evaluationPeriods - The number of periods over which data is compared to the specified threshold. This parameter is required. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N, and DatapointsToAlarm is the M.

      For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

      Returns:
      this

    • actionsEnabled

      @Stability(Stable) public CfnAlarmProps.Builder actionsEnabled(Boolean actionsEnabled)
      Sets the value of CfnAlarmProps.getActionsEnabled()
      Parameters:
      actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
      Returns:
      this

    • actionsEnabled

      @Stability(Stable) public CfnAlarmProps.Builder actionsEnabled(IResolvable actionsEnabled)
      Sets the value of CfnAlarmProps.getActionsEnabled()
      Parameters:
      actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
      Returns:
      this

    • alarmActions

      @Stability(Stable) public CfnAlarmProps.Builder alarmActions(List<String> alarmActions)
      Sets the value of CfnAlarmProps.getAlarmActions()
      Parameters:
      alarmActions - The list of actions to execute when this alarm transitions into an ALARM state from any other state. Specify each action as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutMetricAlarm in the Amazon CloudWatch API Reference .
      Returns:
      this

    • alarmDescription

      @Stability(Stable) public CfnAlarmProps.Builder alarmDescription(String alarmDescription)
      Sets the value of CfnAlarmProps.getAlarmDescription()
      Parameters:
      alarmDescription - The description of the alarm.
      Returns:
      this

    • alarmName

      @Stability(Stable) public CfnAlarmProps.Builder alarmName(String alarmName)
      Sets the value of CfnAlarmProps.getAlarmName()
      Parameters:
      alarmName - The name of the alarm. If you don't specify a name, AWS CloudFormation generates a unique physical ID and uses that ID for the alarm name.

      If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.

      Returns:
      this

    • datapointsToAlarm

      @Stability(Stable) public CfnAlarmProps.Builder datapointsToAlarm(Number datapointsToAlarm)
      Sets the value of CfnAlarmProps.getDatapointsToAlarm()
      Parameters:
      datapointsToAlarm - The number of datapoints that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M, and the value that you set for EvaluationPeriods is the N value. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide .

      If you omit this parameter, CloudWatch uses the same value here that you set for EvaluationPeriods , and the alarm goes to alarm state if that many consecutive periods are breaching.

      Returns:
      this

    • dimensions

      @Stability(Stable) public CfnAlarmProps.Builder dimensions(IResolvable dimensions)
      Sets the value of CfnAlarmProps.getDimensions()
      Parameters:
      dimensions - The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .
      Returns:
      this

    • dimensions

      @Stability(Stable) public CfnAlarmProps.Builder dimensions(List<? extends Object> dimensions)
      Sets the value of CfnAlarmProps.getDimensions()
      Parameters:
      dimensions - The dimensions for the metric associated with the alarm. For an alarm based on a math expression, you can't specify Dimensions . Instead, you use Metrics .
      Returns:
      this

    • evaluateLowSampleCountPercentile

      @Stability(Stable) public CfnAlarmProps.Builder evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
      Sets the value of CfnAlarmProps.getEvaluateLowSampleCountPercentile()
      Parameters:
      evaluateLowSampleCountPercentile - Used only for alarms based on percentiles. If ignore , the alarm state does not change during periods with too few data points to be statistically significant. If evaluate or this parameter is not used, the alarm is always evaluated and possibly changes state no matter how many data points are available.
      Returns:
      this

    • extendedStatistic

      @Stability(Stable) public CfnAlarmProps.Builder extendedStatistic(String extendedStatistic)
      Sets the value of CfnAlarmProps.getExtendedStatistic()
      Parameters:
      extendedStatistic - The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100. For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

      For an alarm based on a math expression, you can't specify ExtendedStatistic . Instead, you use Metrics .

      Returns:
      this

    • insufficientDataActions

      @Stability(Stable) public CfnAlarmProps.Builder insufficientDataActions(List<String> insufficientDataActions)
      Sets the value of CfnAlarmProps.getInsufficientDataActions()
      Parameters:
      insufficientDataActions - The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).
      Returns:
      this

    • metricName

      @Stability(Stable) public CfnAlarmProps.Builder metricName(String metricName)
      Sets the value of CfnAlarmProps.getMetricName()
      Parameters:
      metricName - The name of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you use Metrics instead and you can't specify MetricName .
      Returns:
      this

    • metrics

      @Stability(Stable) public CfnAlarmProps.Builder metrics(IResolvable metrics)
      Sets the value of CfnAlarmProps.getMetrics()
      Parameters:
      metrics - An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.

      If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .

      Returns:
      this

    • metrics

      @Stability(Stable) public CfnAlarmProps.Builder metrics(List<? extends Object> metrics)
      Sets the value of CfnAlarmProps.getMetrics()
      Parameters:
      metrics - An array that enables you to create an alarm based on the result of a metric math expression. Each item in the array either retrieves a metric or performs a math expression.

      If you specify the Metrics parameter, you cannot specify MetricName , Dimensions , Period , Namespace , Statistic , ExtendedStatistic , or Unit .

      Returns:
      this

    • namespace

      @Stability(Stable) public CfnAlarmProps.Builder namespace(String namespace)
      Sets the value of CfnAlarmProps.getNamespace()
      Parameters:
      namespace - The namespace of the metric associated with the alarm. This is required for an alarm based on a metric. For an alarm based on a math expression, you can't specify Namespace and you use Metrics instead.

      For a list of namespaces for metrics from AWS services, see AWS Services That Publish CloudWatch Metrics.

      Returns:
      this

    • okActions

      @Stability(Stable) public CfnAlarmProps.Builder okActions(List<String> okActions)
      Sets the value of CfnAlarmProps.getOkActions()
      Parameters:
      okActions - The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).
      Returns:
      this

    • period

      @Stability(Stable) public CfnAlarmProps.Builder period(Number period)
      Sets the value of CfnAlarmProps.getPeriod()
      Parameters:
      period - The period, in seconds, over which the statistic is applied. This is required for an alarm based on a metric. Valid values are 10, 30, 60, and any multiple of 60.

      For an alarm based on a math expression, you can't specify Period , and instead you use the Metrics parameter.

      Minimum: 10

      Returns:
      this

    • statistic

      @Stability(Stable) public CfnAlarmProps.Builder statistic(String statistic)
      Sets the value of CfnAlarmProps.getStatistic()
      Parameters:
      statistic - The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic . For an alarm based on a metric, you must specify either Statistic or ExtendedStatistic but not both.

      For an alarm based on a math expression, you can't specify Statistic . Instead, you use Metrics .

      Returns:
      this

    • threshold

      @Stability(Stable) public CfnAlarmProps.Builder threshold(Number threshold)
      Sets the value of CfnAlarmProps.getThreshold()
      Parameters:
      threshold - The value to compare with the specified statistic.
      Returns:
      this

    • thresholdMetricId

      @Stability(Stable) public CfnAlarmProps.Builder thresholdMetricId(String thresholdMetricId)
      Sets the value of CfnAlarmProps.getThresholdMetricId()
      Parameters:
      thresholdMetricId - In an alarm based on an anomaly detection model, this is the ID of the ANOMALY_DETECTION_BAND function used as the threshold for the alarm.
      Returns:
      this

    • treatMissingData

      @Stability(Stable) public CfnAlarmProps.Builder treatMissingData(String treatMissingData)
      Sets the value of CfnAlarmProps.getTreatMissingData()
      Parameters:
      treatMissingData - Sets how this alarm is to handle missing data points. Valid values are breaching , notBreaching , ignore , and missing . For more information, see Configuring How CloudWatch Alarms Treat Missing Data in the Amazon CloudWatch User Guide .

      If you omit this parameter, the default behavior of missing is used.

      Returns:
      this

    • unit

      @Stability(Stable) public CfnAlarmProps.Builder unit(String unit)
      Sets the value of CfnAlarmProps.getUnit()
      Parameters:
      unit - The unit of the metric associated with the alarm. Specify this only if you are creating an alarm based on a single metric. Do not specify this if you are specifying a Metrics array.

      You can specify the following values: 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.

      Returns:
      this

    • build

      @Stability(Stable) public CfnAlarmProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAlarmProps>
      Returns:
      a new instance of CfnAlarmProps
      Throws:
      NullPointerException - if any required attribute was not provided