@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
PutMetricAlarmRequest() |
| Modifier and Type | Method and Description |
|---|---|
PutMetricAlarmRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
|
List<String> |
getAlarmActions()
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
String |
getAlarmDescription()
The description for the alarm.
|
String |
getAlarmName()
The name for the alarm.
|
String |
getComparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold.
|
Integer |
getDatapointsToAlarm()
The number of data points that must be breaching to trigger the alarm.
|
List<Dimension> |
getDimensions()
The dimensions for the metric specified in
MetricName. |
String |
getEvaluateLowSampleCountPercentile()
Used only for alarms based on percentiles.
|
Integer |
getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
|
String |
getExtendedStatistic()
The extended statistic for the metric specified in
MetricName. |
List<String> |
getInsufficientDataActions()
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
String |
getMetricName()
The name for the metric associated with the alarm.
|
List<MetricDataQuery> |
getMetrics()
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of a
metric math expression. |
String |
getNamespace()
The namespace for the metric associated specified in
MetricName. |
List<String> |
getOKActions()
The actions to execute when this alarm transitions to an
OK state from any other state. |
Integer |
getPeriod()
The length, in seconds, used each time the metric specified in
MetricName is evaluated. |
String |
getStatistic()
The statistic for the metric specified in
MetricName, other than percentile. |
List<Tag> |
getTags()
A list of key-value pairs to associate with the alarm.
|
Double |
getThreshold()
The value against which the specified statistic is compared.
|
String |
getThresholdMetricId()
If this is an alarm based on an anomaly detection model, make this value match the ID of the
ANOMALY_DETECTION_BAND function. |
String |
getTreatMissingData()
Sets how this alarm is to handle missing data points.
|
String |
getUnit()
The unit of measure for the statistic.
|
int |
hashCode() |
Boolean |
isActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
|
void |
setActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
|
void |
setAlarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
void |
setAlarmDescription(String alarmDescription)
The description for the alarm.
|
void |
setAlarmName(String alarmName)
The name for the alarm.
|
void |
setComparisonOperator(ComparisonOperator comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
void |
setComparisonOperator(String comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
void |
setDatapointsToAlarm(Integer datapointsToAlarm)
The number of data points that must be breaching to trigger the alarm.
|
void |
setDimensions(Collection<Dimension> dimensions)
The dimensions for the metric specified in
MetricName. |
void |
setEvaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
Used only for alarms based on percentiles.
|
void |
setEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
void |
setExtendedStatistic(String extendedStatistic)
The extended statistic for the metric specified in
MetricName. |
void |
setInsufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
void |
setMetricName(String metricName)
The name for the metric associated with the alarm.
|
void |
setMetrics(Collection<MetricDataQuery> metrics)
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of a
metric math expression. |
void |
setNamespace(String namespace)
The namespace for the metric associated specified in
MetricName. |
void |
setOKActions(Collection<String> oKActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
void |
setPeriod(Integer period)
The length, in seconds, used each time the metric specified in
MetricName is evaluated. |
void |
setStatistic(Statistic statistic)
The statistic for the metric specified in
MetricName, other than percentile. |
void |
setStatistic(String statistic)
The statistic for the metric specified in
MetricName, other than percentile. |
void |
setTags(Collection<Tag> tags)
A list of key-value pairs to associate with the alarm.
|
void |
setThreshold(Double threshold)
The value against which the specified statistic is compared.
|
void |
setThresholdMetricId(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. |
void |
setTreatMissingData(String treatMissingData)
Sets how this alarm is to handle missing data points.
|
void |
setUnit(StandardUnit unit)
The unit of measure for the statistic.
|
void |
setUnit(String unit)
The unit of measure for the statistic.
|
String |
toString()
Returns a string representation of this object.
|
PutMetricAlarmRequest |
withActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
|
PutMetricAlarmRequest |
withAlarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
PutMetricAlarmRequest |
withAlarmActions(String... alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
PutMetricAlarmRequest |
withAlarmDescription(String alarmDescription)
The description for the alarm.
|
PutMetricAlarmRequest |
withAlarmName(String alarmName)
The name for the alarm.
|
PutMetricAlarmRequest |
withComparisonOperator(ComparisonOperator comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
PutMetricAlarmRequest |
withComparisonOperator(String comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
PutMetricAlarmRequest |
withDatapointsToAlarm(Integer datapointsToAlarm)
The number of data points that must be breaching to trigger the alarm.
|
PutMetricAlarmRequest |
withDimensions(Collection<Dimension> dimensions)
The dimensions for the metric specified in
MetricName. |
PutMetricAlarmRequest |
withDimensions(Dimension... dimensions)
The dimensions for the metric specified in
MetricName. |
PutMetricAlarmRequest |
withEvaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
Used only for alarms based on percentiles.
|
PutMetricAlarmRequest |
withEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
PutMetricAlarmRequest |
withExtendedStatistic(String extendedStatistic)
The extended statistic for the metric specified in
MetricName. |
PutMetricAlarmRequest |
withInsufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
PutMetricAlarmRequest |
withInsufficientDataActions(String... insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
PutMetricAlarmRequest |
withMetricName(String metricName)
The name for the metric associated with the alarm.
|
PutMetricAlarmRequest |
withMetrics(Collection<MetricDataQuery> metrics)
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of a
metric math expression. |
PutMetricAlarmRequest |
withMetrics(MetricDataQuery... metrics)
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of a
metric math expression. |
PutMetricAlarmRequest |
withNamespace(String namespace)
The namespace for the metric associated specified in
MetricName. |
PutMetricAlarmRequest |
withOKActions(Collection<String> oKActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
PutMetricAlarmRequest |
withOKActions(String... oKActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
PutMetricAlarmRequest |
withPeriod(Integer period)
The length, in seconds, used each time the metric specified in
MetricName is evaluated. |
PutMetricAlarmRequest |
withStatistic(Statistic statistic)
The statistic for the metric specified in
MetricName, other than percentile. |
PutMetricAlarmRequest |
withStatistic(String statistic)
The statistic for the metric specified in
MetricName, other than percentile. |
PutMetricAlarmRequest |
withTags(Collection<Tag> tags)
A list of key-value pairs to associate with the alarm.
|
PutMetricAlarmRequest |
withTags(Tag... tags)
A list of key-value pairs to associate with the alarm.
|
PutMetricAlarmRequest |
withThreshold(Double threshold)
The value against which the specified statistic is compared.
|
PutMetricAlarmRequest |
withThresholdMetricId(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. |
PutMetricAlarmRequest |
withTreatMissingData(String treatMissingData)
Sets how this alarm is to handle missing data points.
|
PutMetricAlarmRequest |
withUnit(StandardUnit unit)
The unit of measure for the statistic.
|
PutMetricAlarmRequest |
withUnit(String unit)
The unit of measure for the statistic.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setAlarmName(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
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
public String getAlarmName()
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
The name must contain only UTF-8 characters, and can't contain ASCII control characters
public PutMetricAlarmRequest withAlarmName(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
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
public void setAlarmDescription(String alarmDescription)
The description for the alarm.
alarmDescription - The description for the alarm.public String getAlarmDescription()
The description for the alarm.
public PutMetricAlarmRequest withAlarmDescription(String alarmDescription)
The description for the alarm.
alarmDescription - The description for the alarm.public void setActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE.
actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE.public Boolean getActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE.
TRUE.public PutMetricAlarmRequest withActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE.
actionsEnabled - Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE.public Boolean isActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE.
TRUE.public List<String> getOKActions()
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
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
public void setOKActions(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
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
public PutMetricAlarmRequest withOKActions(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
NOTE: This method appends the values to the existing list (if any). Use
setOKActions(java.util.Collection) or withOKActions(java.util.Collection) if you want to
override the existing values.
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
public PutMetricAlarmRequest withOKActions(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
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
public List<String> getAlarmActions()
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
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
public void setAlarmActions(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
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
public PutMetricAlarmRequest withAlarmActions(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
NOTE: This method appends the values to the existing list (if any). Use
setAlarmActions(java.util.Collection) or withAlarmActions(java.util.Collection) if you want to
override the existing values.
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
public PutMetricAlarmRequest withAlarmActions(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
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
public List<String> getInsufficientDataActions()
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
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
public void setInsufficientDataActions(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
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
public PutMetricAlarmRequest withInsufficientDataActions(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
NOTE: This method appends the values to the existing list (if any). Use
setInsufficientDataActions(java.util.Collection) or
withInsufficientDataActions(java.util.Collection) if you want to override the existing values.
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
public PutMetricAlarmRequest withInsufficientDataActions(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
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
public void setMetricName(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.
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.
public String getMetricName()
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.
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.
public PutMetricAlarmRequest withMetricName(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.
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.
public void setNamespace(String namespace)
The namespace for the metric associated specified in MetricName.
namespace - The namespace for the metric associated specified in MetricName.public String getNamespace()
The namespace for the metric associated specified in MetricName.
MetricName.public PutMetricAlarmRequest withNamespace(String namespace)
The namespace for the metric associated specified in MetricName.
namespace - The namespace for the metric associated specified in MetricName.public void setStatistic(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.
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.Statisticpublic String getStatistic()
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.
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.Statisticpublic PutMetricAlarmRequest withStatistic(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.
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.Statisticpublic void setStatistic(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.
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.Statisticpublic PutMetricAlarmRequest withStatistic(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.
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.Statisticpublic void setExtendedStatistic(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.
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.
public String getExtendedStatistic()
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.
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.
public PutMetricAlarmRequest withExtendedStatistic(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.
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.
public List<Dimension> getDimensions()
The dimensions for the metric specified in MetricName.
MetricName.public void setDimensions(Collection<Dimension> dimensions)
The dimensions for the metric specified in MetricName.
dimensions - The dimensions for the metric specified in MetricName.public PutMetricAlarmRequest withDimensions(Dimension... dimensions)
The dimensions for the metric specified in MetricName.
NOTE: This method appends the values to the existing list (if any). Use
setDimensions(java.util.Collection) or withDimensions(java.util.Collection) if you want to
override the existing values.
dimensions - The dimensions for the metric specified in MetricName.public PutMetricAlarmRequest withDimensions(Collection<Dimension> dimensions)
The dimensions for the metric specified in MetricName.
dimensions - The dimensions for the metric specified in MetricName.public void setPeriod(Integer 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 the Metrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
StorageResolution 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 by
EvaluationPeriods cannot be more than 86,400 seconds.
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 the
Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
StorageResolution 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 by EvaluationPeriods cannot be more than 86,400 seconds.
public Integer getPeriod()
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 the Metrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
StorageResolution 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 by
EvaluationPeriods cannot be more than 86,400 seconds.
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 the
Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
StorageResolution 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 by EvaluationPeriods cannot be more than 86,400 seconds.
public PutMetricAlarmRequest withPeriod(Integer 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 the Metrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
StorageResolution 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 by
EvaluationPeriods cannot be more than 86,400 seconds.
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 the
Metrics array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData call with a
StorageResolution 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 by EvaluationPeriods cannot be more than 86,400 seconds.
public void setUnit(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.
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.
StandardUnitpublic String getUnit()
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.
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.
StandardUnitpublic PutMetricAlarmRequest withUnit(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.
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.
StandardUnitpublic void setUnit(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.
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.
StandardUnitpublic PutMetricAlarmRequest withUnit(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.
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.
StandardUnitpublic void setEvaluationPeriods(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.
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.
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.
public Integer getEvaluationPeriods()
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.
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.
public PutMetricAlarmRequest withEvaluationPeriods(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.
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.
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.
public void setDatapointsToAlarm(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.
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.public Integer getDatapointsToAlarm()
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.
public PutMetricAlarmRequest withDatapointsToAlarm(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.
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.public void setThreshold(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.
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.
public Double getThreshold()
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.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
public PutMetricAlarmRequest withThreshold(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.
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.
public void setComparisonOperator(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.
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.
ComparisonOperatorpublic String getComparisonOperator()
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.
The values LessThanLowerOrGreaterThanUpperThreshold, LessThanLowerThreshold,
and GreaterThanUpperThreshold are used only for alarms based on anomaly detection models.
ComparisonOperatorpublic PutMetricAlarmRequest withComparisonOperator(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.
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.
ComparisonOperatorpublic void setComparisonOperator(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.
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.
ComparisonOperatorpublic PutMetricAlarmRequest withComparisonOperator(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.
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.
ComparisonOperatorpublic void setTreatMissingData(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.
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.
public String getTreatMissingData()
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.
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.
public PutMetricAlarmRequest withTreatMissingData(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.
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.
public void setEvaluateLowSampleCountPercentile(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
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
public String getEvaluateLowSampleCountPercentile()
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
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
public PutMetricAlarmRequest withEvaluateLowSampleCountPercentile(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
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
public List<MetricDataQuery> getMetrics()
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.
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.
public void setMetrics(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.
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.
public PutMetricAlarmRequest withMetrics(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.
NOTE: This method appends the values to the existing list (if any). Use
setMetrics(java.util.Collection) or withMetrics(java.util.Collection) if you want to override
the existing values.
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.
public PutMetricAlarmRequest withMetrics(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.
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.
public List<Tag> getTags()
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.
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.
public void setTags(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.
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.
public PutMetricAlarmRequest withTags(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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
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.
public PutMetricAlarmRequest withTags(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.
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.
public void setThresholdMetricId(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.
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.
public String getThresholdMetricId()
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.
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.
public PutMetricAlarmRequest withThresholdMetricId(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.
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.
public String toString()
toString in class ObjectObject.toString()public PutMetricAlarmRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()