Class PutMetricAlarmRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutMetricAlarmRequest extends CloudWatchRequest implements ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

  • Method Details

    • alarmName

      public final String alarmName()

      The name for the alarm. This name must be unique within the Region.

      The name must contain only UTF-8 characters, and can't contain ASCII control characters

      Returns:
      The name for the alarm. This name must be unique within the Region.

      The name must contain only UTF-8 characters, and can't contain ASCII control characters

    • alarmDescription

      public final String alarmDescription()

      The description for the alarm.

      Returns:
      The description for the alarm.

    • actionsEnabled

      public final Boolean actionsEnabled()

      Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

      Returns:
      Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.

    • hasOkActions

      public final boolean hasOkActions()
      For responses, this returns true if the service returned a value for the OKActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • okActions

      public final List<String> okActions()

      The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

      EC2 actions:

      • arn:aws:automate:region:ec2:stop

      • arn:aws:automate:region:ec2:terminate

      • arn:aws:automate:region:ec2:reboot

      • arn:aws:automate:region:ec2:recover

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

      Autoscaling action:

      • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      SNS notification action:

      • arn:aws:sns:region:account-id:sns-topic-name

      SSM integration actions:

      • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

      • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOkActions() method.

      Returns:
      The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

      EC2 actions:

      • arn:aws:automate:region:ec2:stop

      • arn:aws:automate:region:ec2:terminate

      • arn:aws:automate:region:ec2:reboot

      • arn:aws:automate:region:ec2:recover

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

      Autoscaling action:

      • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      SNS notification action:

      • arn:aws:sns:region:account-id:sns-topic-name

      SSM integration actions:

      • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

      • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

    • hasAlarmActions

      public final boolean hasAlarmActions()
      For responses, this returns true if the service returned a value for the AlarmActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • alarmActions

      public final List<String> alarmActions()

      The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

      EC2 actions:

      • arn:aws:automate:region:ec2:stop

      • arn:aws:automate:region:ec2:terminate

      • arn:aws:automate:region:ec2:reboot

      • arn:aws:automate:region:ec2:recover

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

      Autoscaling action:

      • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      SNS notification action:

      • arn:aws:sns:region:account-id:sns-topic-name

      SSM integration actions:

      • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

      • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

      Start a Amazon Q Developer operational investigation

      arn:aws:aiops:region:account-id:investigation-group:investigation-group-id

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlarmActions() method.

      Returns:
      The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:

      EC2 actions:

      • arn:aws:automate:region:ec2:stop

      • arn:aws:automate:region:ec2:terminate

      • arn:aws:automate:region:ec2:reboot

      • arn:aws:automate:region:ec2:recover

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

      Autoscaling action:

      • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      SNS notification action:

      • arn:aws:sns:region:account-id:sns-topic-name

      SSM integration actions:

      • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

      • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

      Start a Amazon Q Developer operational investigation

      arn:aws:aiops:region:account-id:investigation-group:investigation-group-id

    • hasInsufficientDataActions

      public final boolean hasInsufficientDataActions()
      For responses, this returns true if the service returned a value for the InsufficientDataActions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • insufficientDataActions

      public final List<String> 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). Valid values:

      EC2 actions:

      • arn:aws:automate:region:ec2:stop

      • arn:aws:automate:region:ec2:terminate

      • arn:aws:automate:region:ec2:reboot

      • arn:aws:automate:region:ec2:recover

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

      Autoscaling action:

      • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      SNS notification action:

      • arn:aws:sns:region:account-id:sns-topic-name

      SSM integration actions:

      • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

      • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInsufficientDataActions() method.

      Returns:
      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). Valid values:

      EC2 actions:

      • arn:aws:automate:region:ec2:stop

      • arn:aws:automate:region:ec2:terminate

      • arn:aws:automate:region:ec2:reboot

      • arn:aws:automate:region:ec2:recover

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0

      • arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0

      Autoscaling action:

      • arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name

      Lambda actions:

      • Invoke the latest version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name

      • Invoke a specific version of a Lambda function: arn:aws:lambda:region:account-id:function:function-name:version-number

      • Invoke a function by using an alias Lambda function: arn:aws:lambda:region:account-id:function:function-name:alias-name

      SNS notification action:

      • arn:aws:sns:region:account-id:sns-topic-name

      SSM integration actions:

      • arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name

      • arn:aws:ssm-incidents::account-id:responseplan/response-plan-name

    • metricName

      public final String metricName()

      The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

      If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

      Returns:
      The name for the metric associated with the alarm. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

      If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the Namespace, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters. Instead, you specify all this information in the Metrics array.

    • namespace

      public final String namespace()

      The namespace for the metric associated specified in MetricName.

      Returns:
      The namespace for the metric associated specified in MetricName.

    • statistic

      public final Statistic statistic()

      The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

      If the service returns an enum value that is not available in the current SDK version, statistic will return Statistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

      Returns:
      The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.
      See Also:

    • statisticAsString

      public final String statisticAsString()

      The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.

      If the service returns an enum value that is not available in the current SDK version, statistic will return Statistic.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statisticAsString().

      Returns:
      The statistic for the metric specified in MetricName, other than percentile. For percentile statistics, use ExtendedStatistic. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic, but not both.
      See Also:

    • extendedStatistic

      public final String extendedStatistic()

      The extended statistic for the metric specified in MetricName. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic but not both.

      If you specify ExtendedStatistic, the following are valid values:

      • p90

      • tm90

      • tc90

      • ts90

      • wm90

      • IQM

      • PR(n:m) where n and m are values of the metric

      • TC(X%:X%) where X is between 10 and 90 inclusive.

      • TM(X%:X%) where X is between 10 and 90 inclusive.

      • TS(X%:X%) where X is between 10 and 90 inclusive.

      • WM(X%:X%) where X is between 10 and 90 inclusive.

      For more information about these extended statistics, see CloudWatch statistics definitions.

      Returns:
      The extended statistic for the metric specified in MetricName. When you call PutMetricAlarm and specify a MetricName, you must specify either Statistic or ExtendedStatistic but not both.

      If you specify ExtendedStatistic, the following are valid values:

      • p90

      • tm90

      • tc90

      • ts90

      • wm90

      • IQM

      • PR(n:m) where n and m are values of the metric

      • TC(X%:X%) where X is between 10 and 90 inclusive.

      • TM(X%:X%) where X is between 10 and 90 inclusive.

      • TS(X%:X%) where X is between 10 and 90 inclusive.

      • WM(X%:X%) where X is between 10 and 90 inclusive.

      For more information about these extended statistics, see CloudWatch statistics definitions.

    • hasDimensions

      public final boolean hasDimensions()
      For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • dimensions

      public final List<Dimension> dimensions()

      The dimensions for the metric specified in MetricName.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDimensions() method.

      Returns:
      The dimensions for the metric specified in MetricName.

    • period

      public final Integer period()

      The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 20, 30, and any multiple of 60.

      Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.

      Be sure to specify 10, 20, or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

      An alarm's total current evaluation period can be no longer than seven days, so Period multiplied by EvaluationPeriods can't be more than 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).

      Returns:
      The length, in seconds, used each time the metric specified in MetricName is evaluated. Valid values are 10, 20, 30, and any multiple of 60.

      Period is required for alarms based on static thresholds. If you are creating an alarm based on a metric math expression, you specify the period for each metric within the objects in the Metrics array.

      Be sure to specify 10, 20, or 30 only for metrics that are stored by a PutMetricData call with a StorageResolution of 1. If you specify a period of 10, 20, or 30 for a metric that does not have sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10, 20, or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see Amazon CloudWatch Pricing.

      An alarm's total current evaluation period can be no longer than seven days, so Period multiplied by EvaluationPeriods can't be more than 604,800 seconds. For alarms with a period of less than one hour (3,600 seconds), the total evaluation period can't be longer than one day (86,400 seconds).

    • unit

      public final StandardUnit unit()

      The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.

      If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.

      However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.

      We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

      If the service returns an enum value that is not available in the current SDK version, unit will return StandardUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      Returns:
      The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.

      If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.

      However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.

      We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

      See Also:

    • unitAsString

      public final String unitAsString()

      The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.

      If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.

      However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.

      We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

      If the service returns an enum value that is not available in the current SDK version, unit will return StandardUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from unitAsString().

      Returns:
      The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the Metrics array.

      If you don't specify Unit, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.

      However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.

      We recommend omitting Unit so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA state.

      See Also:

    • evaluationPeriods

      public final Integer evaluationPeriods()

      The number of periods over which data is compared to the specified threshold. 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.

      Returns:
      The number of periods over which data is compared to the specified threshold. 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.

    • datapointsToAlarm

      public final Integer datapointsToAlarm()

      The number of data points 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. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

      Returns:
      The number of data points 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. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.

    • threshold

      public final Double threshold()

      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.

      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.

    • comparisonOperator

      public final ComparisonOperator comparisonOperator()

      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

      See Also:

    • comparisonOperatorAsString

      public final String comparisonOperatorAsString()

      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

      If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

      Returns:
      The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

      The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold, and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.

      See Also:

    • treatMissingData

      public final String treatMissingData()

      Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

      Valid Values: breaching | notBreaching | ignore | missing

      Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore missing data even if you choose a different option for TreatMissingData. When an AWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

      Returns:
      Sets how this alarm is to handle missing data points. If TreatMissingData is omitted, the default behavior of missing is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.

      Valid Values: breaching | notBreaching | ignore | missing

      Alarms that evaluate metrics in the AWS/DynamoDB namespace always ignore missing data even if you choose a different option for TreatMissingData. When an AWS/DynamoDB metric has missing data, alarms that evaluate that metric remain in their current state.

    • evaluateLowSampleCountPercentile

      public final String evaluateLowSampleCountPercentile()

      Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

      Valid Values: evaluate | ignore

      Returns:
      Used only for alarms based on percentiles. If you specify ignore, the alarm state does not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm is always evaluated and possibly changes state no matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.

      Valid Values: evaluate | ignore

    • hasMetrics

      public final boolean hasMetrics()
      For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • metrics

      public final List<MetricDataQuery> metrics()

      An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

      Each item in the Metrics array either retrieves a metric or performs a math expression.

      One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

      If you use the Metrics parameter, you cannot include the Namespace, MetricName, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetrics() method.

      Returns:
      An array of MetricDataQuery structures that enable you to create an alarm based on the result of a metric math expression. For each PutMetricAlarm operation, you must specify either MetricName or a Metrics array.

      Each item in the Metrics array either retrieves a metric or performs a math expression.

      One item in the Metrics array is the expression that the alarm watches. You designate this expression by setting ReturnData to true for this object in the array. For more information, see MetricDataQuery.

      If you use the Metrics parameter, you cannot include the Namespace, MetricName, Dimensions, Period, Unit, Statistic, or ExtendedStatistic parameters of PutMetricAlarm in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of the Metrics array.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.

      To use this field to set tags for an alarm when you create it, you must be signed on with both the cloudwatch:PutMetricAlarm and cloudwatch:TagResource permissions.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.

      Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.

      If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.

      To use this field to set tags for an alarm when you create it, you must be signed on with both the cloudwatch:PutMetricAlarm and cloudwatch:TagResource permissions.

    • thresholdMetricId

      public final String thresholdMetricId()

      If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.

      For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.

      If your alarm uses this parameter, it cannot have Auto Scaling actions.

      Returns:
      If this is an alarm based on an anomaly detection model, make this value match the ID of the ANOMALY_DETECTION_BAND function.

      For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.

      If your alarm uses this parameter, it cannot have Auto Scaling actions.

    • toBuilder

      public PutMetricAlarmRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>
      Specified by:
      toBuilder in class CloudWatchRequest
      Returns:
      a builder for type T

    • builder

      public static PutMetricAlarmRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutMetricAlarmRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.