@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.
|
List<Dimension> |
getDimensions()
The dimensions for the metric associated with the alarm.
|
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 percentile statistic for the metric associated with the alarm.
|
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.
|
String |
getNamespace()
The namespace for the metric associated with the alarm.
|
List<String> |
getOKActions()
The actions to execute when this alarm transitions to an
OK state from any other state. |
Integer |
getPeriod()
The period, in seconds, over which the specified statistic is applied.
|
String |
getStatistic()
The statistic for the metric associated with the alarm, other than percentile.
|
Double |
getThreshold()
The value against which the specified statistic is compared.
|
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 |
setDimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
|
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 percentile statistic for the metric associated with the alarm.
|
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 |
setNamespace(String namespace)
The namespace for the metric associated with the alarm.
|
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 period, in seconds, over which the specified statistic is applied.
|
void |
setStatistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
void |
setStatistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
void |
setThreshold(Double threshold)
The value against which the specified statistic is compared.
|
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; useful for testing and debugging.
|
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 |
withDimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
|
PutMetricAlarmRequest |
withDimensions(Dimension... dimensions)
The dimensions for the metric associated with the alarm.
|
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 percentile statistic for the metric associated with the alarm.
|
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 |
withNamespace(String namespace)
The namespace for the metric associated with the alarm.
|
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 period, in seconds, over which the specified statistic is applied.
|
PutMetricAlarmRequest |
withStatistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
PutMetricAlarmRequest |
withStatistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
PutMetricAlarmRequest |
withThreshold(Double threshold)
The value against which the specified statistic is compared.
|
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, withSdkRequestTimeout
public void setAlarmName(String alarmName)
The name for the alarm. This name must be unique within the AWS account.
alarmName
- The name for the alarm. This name must be unique within the AWS account.public String getAlarmName()
The name for the alarm. This name must be unique within the AWS account.
public PutMetricAlarmRequest withAlarmName(String alarmName)
The name for the alarm. This name must be unique within the AWS account.
alarmName
- The name for the alarm. This name must be unique within the AWS account.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.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state.public Boolean getActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
public PutMetricAlarmRequest withActionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state.public Boolean isActionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
OK
state from any other state. Each
action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover
Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0
public void setMetricName(String metricName)
The name for the metric associated with the alarm.
metricName
- The name for the metric associated with the alarm.public String getMetricName()
The name for the metric associated with the alarm.
public PutMetricAlarmRequest withMetricName(String metricName)
The name for the metric associated with the alarm.
metricName
- The name for the metric associated with the alarm.public void setNamespace(String namespace)
The namespace for the metric associated with the alarm.
namespace
- The namespace for the metric associated with the alarm.public String getNamespace()
The namespace for the metric associated with the alarm.
public PutMetricAlarmRequest withNamespace(String namespace)
The namespace for the metric associated with the alarm.
namespace
- The namespace for the metric associated with the alarm.public void setStatistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
statistic
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics,
use ExtendedStatistic
.Statistic
public String getStatistic()
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
ExtendedStatistic
.Statistic
public PutMetricAlarmRequest withStatistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
statistic
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics,
use ExtendedStatistic
.Statistic
public void setStatistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
statistic
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics,
use ExtendedStatistic
.Statistic
public PutMetricAlarmRequest withStatistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
statistic
- The statistic for the metric associated with the alarm, other than percentile. For percentile statistics,
use ExtendedStatistic
.Statistic
public void setExtendedStatistic(String extendedStatistic)
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
extendedStatistic
- The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.public String getExtendedStatistic()
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
public PutMetricAlarmRequest withExtendedStatistic(String extendedStatistic)
The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.
extendedStatistic
- The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.public List<Dimension> getDimensions()
The dimensions for the metric associated with the alarm.
public void setDimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
dimensions
- The dimensions for the metric associated with the alarm.public PutMetricAlarmRequest withDimensions(Dimension... dimensions)
The dimensions for the metric associated with the alarm.
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 associated with the alarm.public PutMetricAlarmRequest withDimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
dimensions
- The dimensions for the metric associated with the alarm.public void setPeriod(Integer period)
The period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.
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
may 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 period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any
multiple of 60.
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 may 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 period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.
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
may 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.
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 may 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 period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any multiple of 60.
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
may 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 period, in seconds, over which the specified statistic is applied. Valid values are 10, 30, and any
multiple of 60.
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 may 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm
can get 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch
alarm can get stuck in the INSUFFICIENT DATA
state.
StandardUnit
public 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm
can get stuck in the INSUFFICIENT DATA
state.
If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch
alarm can get stuck in the INSUFFICIENT DATA
state.
StandardUnit
public 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm
can get 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch
alarm can get stuck in the INSUFFICIENT DATA
state.
StandardUnit
public 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm
can get 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch
alarm can get stuck in the INSUFFICIENT DATA
state.
StandardUnit
public 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch alarm
can get 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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the CloudWatch
alarm can get stuck in the INSUFFICIENT DATA
state.
StandardUnit
public void setEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold. 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. 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. 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.
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. 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. 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 setThreshold(Double threshold)
The value against which the specified statistic is compared.
threshold
- The value against which the specified statistic is compared.public Double getThreshold()
The value against which the specified statistic is compared.
public PutMetricAlarmRequest withThreshold(Double threshold)
The value against which the specified statistic is compared.
threshold
- The value against which the specified statistic is compared.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.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
public String getComparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
ComparisonOperator
public 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.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
public 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.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
public 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.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
public 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
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
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
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
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
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
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 String toString()
toString
in class Object
Object.toString()
public PutMetricAlarmRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.