Package software.amazon.awscdk.services.lightsail

Class CfnAlarm.Builder

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

  • Method Details

    • create

      @Stability(Stable) public static CfnAlarm.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnAlarm.Builder.

    • alarmName

      @Stability(Stable) public CfnAlarm.Builder alarmName(String alarmName)
      The name of the alarm.

      Parameters:
      alarmName - The name of the alarm. This parameter is required.
      Returns:
      this

    • comparisonOperator

      @Stability(Stable) public CfnAlarm.Builder comparisonOperator(String comparisonOperator)
      The arithmetic operation to use when comparing the specified statistic and threshold.

      Parameters:
      comparisonOperator - The arithmetic operation to use when comparing the specified statistic and threshold. This parameter is required.
      Returns:
      this

    • evaluationPeriods

      @Stability(Stable) public CfnAlarm.Builder evaluationPeriods(Number evaluationPeriods)
      The number of periods over which data is compared to the specified threshold.

      Parameters:
      evaluationPeriods - The number of periods over which data is compared to the specified threshold. This parameter is required.
      Returns:
      this

    • metricName

      @Stability(Stable) public CfnAlarm.Builder metricName(String metricName)
      The name of the metric associated with the alarm.

      Parameters:
      metricName - The name of the metric associated with the alarm. This parameter is required.
      Returns:
      this

    • monitoredResourceName

      @Stability(Stable) public CfnAlarm.Builder monitoredResourceName(String monitoredResourceName)
      The name of the Lightsail resource that the alarm monitors.

      Parameters:
      monitoredResourceName - The name of the Lightsail resource that the alarm monitors. This parameter is required.
      Returns:
      this

    • threshold

      @Stability(Stable) public CfnAlarm.Builder threshold(Number threshold)
      The value against which the specified statistic is compared.

      Parameters:
      threshold - The value against which the specified statistic is compared. This parameter is required.
      Returns:
      this

    • contactProtocols

      @Stability(Stable) public CfnAlarm.Builder contactProtocols(List<String> contactProtocols)
      The contact protocols for the alarm, such as Email , SMS (text messaging), or both.

      Allowed Values : Email | SMS

      Parameters:
      contactProtocols - The contact protocols for the alarm, such as Email , SMS (text messaging), or both. This parameter is required.
      Returns:
      this

    • datapointsToAlarm

      @Stability(Stable) public CfnAlarm.Builder datapointsToAlarm(Number datapointsToAlarm)
      The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state.

      Parameters:
      datapointsToAlarm - The number of data points within the evaluation periods that must be breaching to cause the alarm to go to the ALARM state. This parameter is required.
      Returns:
      this

    • notificationEnabled

      @Stability(Stable) public CfnAlarm.Builder notificationEnabled(Boolean notificationEnabled)
      A Boolean value indicating whether the alarm is enabled.

      Parameters:
      notificationEnabled - A Boolean value indicating whether the alarm is enabled. This parameter is required.
      Returns:
      this

    • notificationEnabled

      @Stability(Stable) public CfnAlarm.Builder notificationEnabled(IResolvable notificationEnabled)
      A Boolean value indicating whether the alarm is enabled.

      Parameters:
      notificationEnabled - A Boolean value indicating whether the alarm is enabled. This parameter is required.
      Returns:
      this

    • notificationTriggers

      @Stability(Stable) public CfnAlarm.Builder notificationTriggers(List<String> notificationTriggers)
      The alarm states that trigger a notification.

      To specify the OK and INSUFFICIENT_DATA values, you must also specify ContactProtocols values. Otherwise, the OK and INSUFFICIENT_DATA values will not take effect and the stack will drift.

      Allowed Values : OK | ALARM | INSUFFICIENT_DATA

      Parameters:
      notificationTriggers - The alarm states that trigger a notification. This parameter is required.
      Returns:
      this

    • treatMissingData

      @Stability(Stable) public CfnAlarm.Builder treatMissingData(String treatMissingData)
      Specifies how the alarm handles missing data points.

      An alarm can treat missing data in the following ways:

      • breaching - Assumes the missing data is not within the threshold. Missing data counts towards the number of times that the metric is not within the threshold.
      • notBreaching - Assumes the missing data is within the threshold. Missing data does not count towards the number of times that the metric is not within the threshold.
      • ignore - Ignores the missing data. Maintains the current alarm state.
      • missing - Missing data is treated as missing.

      Parameters:
      treatMissingData - Specifies how the alarm handles missing data points. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnAlarm build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnAlarm>
      Returns:
      a newly built instance of CfnAlarm.