Interface PutMetricAlarmRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CloudWatchRequest.Builder, CopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>, SdkBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
PutMetricAlarmRequest
@Mutable @NotThreadSafe public static interface PutMetricAlarmRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, CopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

  • Method Details

    • alarmName

      PutMetricAlarmRequest.Builder alarmName(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • alarmDescription

      PutMetricAlarmRequest.Builder alarmDescription(String alarmDescription)

      The description for the alarm.

      Parameters:
      alarmDescription - The description for the alarm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionsEnabled

      PutMetricAlarmRequest.Builder actionsEnabled(Boolean actionsEnabled)

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

      Parameters:
      actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is TRUE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • okActions

      PutMetricAlarmRequest.Builder okActions(Collection<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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • okActions

      PutMetricAlarmRequest.Builder okActions(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmActions

      PutMetricAlarmRequest.Builder alarmActions(Collection<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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alarmActions

      PutMetricAlarmRequest.Builder alarmActions(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

      Parameters:
      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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • insufficientDataActions

      PutMetricAlarmRequest.Builder insufficientDataActions(Collection<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

      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). 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • insufficientDataActions

      PutMetricAlarmRequest.Builder insufficientDataActions(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

      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). 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

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricName

      PutMetricAlarmRequest.Builder metricName(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • namespace

      PutMetricAlarmRequest.Builder namespace(String namespace)

      The namespace for the metric associated specified in MetricName.

      Parameters:
      namespace - The namespace for the metric associated specified in MetricName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistic

      PutMetricAlarmRequest.Builder statistic(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statistic

      PutMetricAlarmRequest.Builder statistic(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • extendedStatistic

      PutMetricAlarmRequest.Builder extendedStatistic(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      PutMetricAlarmRequest.Builder dimensions(Collection<Dimension> dimensions)

      The dimensions for the metric specified in MetricName.

      Parameters:
      dimensions - The dimensions for the metric specified in MetricName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      PutMetricAlarmRequest.Builder dimensions(Dimension... dimensions)

      The dimensions for the metric specified in MetricName.

      Parameters:
      dimensions - The dimensions for the metric specified in MetricName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dimensions

      PutMetricAlarmRequest.Builder dimensions(Consumer<Dimension.Builder>... dimensions)

      The dimensions for the metric specified in MetricName.

      This is a convenience method that creates an instance of the Dimension.Builder avoiding the need to create one manually via Dimension.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dimensions(List<Dimension>).

      Parameters:
      dimensions - a consumer that will call methods on Dimension.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • period

      PutMetricAlarmRequest.Builder period(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).

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • unit

      PutMetricAlarmRequest.Builder unit(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unit

      PutMetricAlarmRequest.Builder unit(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • evaluationPeriods

      PutMetricAlarmRequest.Builder evaluationPeriods(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • datapointsToAlarm

      PutMetricAlarmRequest.Builder datapointsToAlarm(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • threshold

      PutMetricAlarmRequest.Builder threshold(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • comparisonOperator

      PutMetricAlarmRequest.Builder comparisonOperator(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • comparisonOperator

      PutMetricAlarmRequest.Builder comparisonOperator(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • treatMissingData

      PutMetricAlarmRequest.Builder treatMissingData(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • evaluateLowSampleCountPercentile

      PutMetricAlarmRequest.Builder evaluateLowSampleCountPercentile(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      PutMetricAlarmRequest.Builder metrics(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      PutMetricAlarmRequest.Builder metrics(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      PutMetricAlarmRequest.Builder metrics(Consumer<MetricDataQuery.Builder>... 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.

      This is a convenience method that creates an instance of the MetricDataQuery.Builder avoiding the need to create one manually via MetricDataQuery.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metrics(List<MetricDataQuery>).

      Parameters:
      metrics - a consumer that will call methods on MetricDataQuery.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      PutMetricAlarmRequest.Builder tags(Collection<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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutMetricAlarmRequest.Builder tags(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      PutMetricAlarmRequest.Builder tags(Consumer<Tag.Builder>... 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.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • thresholdMetricId

      PutMetricAlarmRequest.Builder thresholdMetricId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      PutMetricAlarmRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutMetricAlarmRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.