Interface PutMetricAlarmRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchRequest.Builder
,CopyableBuilder<PutMetricAlarmRequest.Builder,
,PutMetricAlarmRequest> SdkBuilder<PutMetricAlarmRequest.Builder,
,PutMetricAlarmRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
PutMetricAlarmRequest
-
Method Summary
Modifier and TypeMethodDescriptionactionsEnabled
(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm state.alarmActions
(String... alarmActions) The actions to execute when this alarm transitions to theALARM
state from any other state.alarmActions
(Collection<String> alarmActions) The actions to execute when this alarm transitions to theALARM
state from any other state.alarmDescription
(String alarmDescription) The description for the alarm.The name for the alarm.comparisonOperator
(String comparisonOperator) The arithmetic operation to use when comparing the specified statistic and threshold.comparisonOperator
(ComparisonOperator comparisonOperator) The arithmetic operation to use when comparing the specified statistic and threshold.datapointsToAlarm
(Integer datapointsToAlarm) The number of data points that must be breaching to trigger the alarm.dimensions
(Collection<Dimension> dimensions) The dimensions for the metric specified inMetricName
.dimensions
(Consumer<Dimension.Builder>... dimensions) The dimensions for the metric specified inMetricName
.dimensions
(Dimension... dimensions) The dimensions for the metric specified inMetricName
.evaluateLowSampleCountPercentile
(String evaluateLowSampleCountPercentile) Used only for alarms based on percentiles.evaluationPeriods
(Integer evaluationPeriods) The number of periods over which data is compared to the specified threshold.extendedStatistic
(String extendedStatistic) The extended statistic for the metric specified inMetricName
.insufficientDataActions
(String... insufficientDataActions) The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state.insufficientDataActions
(Collection<String> insufficientDataActions) The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state.metricName
(String metricName) The name for the metric associated with the alarm.metrics
(Collection<MetricDataQuery> metrics) An array ofMetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression.metrics
(Consumer<MetricDataQuery.Builder>... metrics) An array ofMetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression.metrics
(MetricDataQuery... metrics) An array ofMetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression.The namespace for the metric associated specified inMetricName
.The actions to execute when this alarm transitions to anOK
state from any other state.okActions
(Collection<String> okActions) The actions to execute when this alarm transitions to anOK
state from any other state.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.The length, in seconds, used each time the metric specified inMetricName
is evaluated.The statistic for the metric specified inMetricName
, other than percentile.The statistic for the metric specified inMetricName
, other than percentile.tags
(Collection<Tag> tags) A list of key-value pairs to associate with the alarm.tags
(Consumer<Tag.Builder>... tags) A list of key-value pairs to associate with the alarm.A list of key-value pairs to associate with the alarm.The value against which the specified statistic is compared.thresholdMetricId
(String thresholdMetricId) If this is an alarm based on an anomaly detection model, make this value match the ID of theANOMALY_DETECTION_BAND
function.treatMissingData
(String treatMissingData) Sets how this alarm is to handle missing data points.The unit of measure for the statistic.unit
(StandardUnit unit) The unit of measure for the statistic.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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 isTRUE
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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 anOK
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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 anOK
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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:
alarmActions
- The actions to execute when this alarm transitions to theALARM
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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:
alarmActions
- The actions to execute when this alarm transitions to theALARM
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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 theINSUFFICIENT_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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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
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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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 theINSUFFICIENT_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
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-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
The name for the metric associated with the alarm. For each
PutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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
, orExtendedStatistic
parameters. Instead, you specify all this information in theMetrics
array.- Parameters:
metricName
- The name for the metric associated with the alarm. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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
, orExtendedStatistic
parameters. Instead, you specify all this information in theMetrics
array.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
namespace
The namespace for the metric associated specified in
MetricName
.- Parameters:
namespace
- The namespace for the metric associated specified inMetricName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statistic
The statistic for the metric specified in
MetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both.- Parameters:
statistic
- The statistic for the metric specified inMetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statistic
The statistic for the metric specified in
MetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both.- Parameters:
statistic
- The statistic for the metric specified inMetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
extendedStatistic
The extended statistic for the metric specified in
MetricName
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic
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 inMetricName
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic
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
The dimensions for the metric specified in
MetricName
.- Parameters:
dimensions
- The dimensions for the metric specified inMetricName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dimensions
The dimensions for the metric specified in
MetricName
.- Parameters:
dimensions
- The dimensions for the metric specified inMetricName
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dimensions
The dimensions for the metric specified in
This is a convenience method that creates an instance of theMetricName
.Dimension.Builder
avoiding the need to create one manually viaDimension.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todimensions(List<Dimension>)
.- Parameters:
dimensions
- a consumer that will call methods onDimension.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
period
The length, in seconds, used each time the metric specified in
MetricName
is evaluated. Valid values are 10, 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 theMetrics
array.Be sure to specify 10 or 30 only for metrics that are stored by a
PutMetricData
call with aStorageResolution
of 1. If you specify a period of 10 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 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 one day, so
Period
multiplied byEvaluationPeriods
cannot be more than 86,400 seconds.- Parameters:
period
- The length, in seconds, used each time the metric specified inMetricName
is evaluated. Valid values are 10, 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 theMetrics
array.Be sure to specify 10 or 30 only for metrics that are stored by a
PutMetricData
call with aStorageResolution
of 1. If you specify a period of 10 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 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 one day, so
Period
multiplied byEvaluationPeriods
cannot be more than 86,400 seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 theINSUFFICIENT 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 theMetrics
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 theINSUFFICIENT DATA
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theINSUFFICIENT 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 theMetrics
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 theINSUFFICIENT DATA
state.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by
Period
cannot be more than 86,400 seconds.- 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.An alarm's total current evaluation period can be no longer than one day, so this number multiplied by
Period
cannot be more than 86,400 seconds.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
, andGreaterThanUpperThreshold
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
, andGreaterThanUpperThreshold
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
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
, andGreaterThanUpperThreshold
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
, andGreaterThanUpperThreshold
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
Sets how this alarm is to handle missing data points. If
TreatMissingData
is omitted, the default behavior ofmissing
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 alwaysignore
missing data even if you choose a different option forTreatMissingData
. When anAWS/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. IfTreatMissingData
is omitted, the default behavior ofmissing
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 alwaysignore
missing data even if you choose a different option forTreatMissingData
. When anAWS/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 specifyevaluate
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 specifyignore
, the alarm state does not change during periods with too few data points to be statistically significant. If you specifyevaluate
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
An array of
MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
Metrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.- Parameters:
metrics
- An array ofMetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
Metrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
An array of
MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
Metrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.- Parameters:
metrics
- An array ofMetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
Metrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
metrics
An array of
MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
This is a convenience method that creates an instance of theMetrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.MetricDataQuery.Builder
avoiding the need to create one manually viaMetricDataQuery.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tometrics(List<MetricDataQuery>)
.- Parameters:
metrics
- a consumer that will call methods onMetricDataQuery.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- 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 thecloudwatch: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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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 thecloudwatch: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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 theANOMALY_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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-