public class PutMetricAlarmRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Describes the inputs for PutMetricAlarm.
NOOP
Constructor and Description |
---|
PutMetricAlarmRequest() |
Modifier and Type | Method and Description |
---|---|
PutMetricAlarmRequest |
clone() |
boolean |
equals(Object obj) |
Boolean |
getActionsEnabled()
Indicates whether or not actions should be executed during any changes to the alarm's state.
|
List<String> |
getAlarmActions()
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. |
String |
getAlarmDescription()
The description for the alarm.
|
String |
getAlarmName()
The descriptive 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 alarm's associated metric.
|
Integer |
getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
|
List<String> |
getInsufficientDataActions()
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
String |
getMetricName()
The name for the alarm's associated metric.
|
String |
getNamespace()
The namespace for the alarm's associated metric.
|
List<String> |
getOKActions()
The list of actions to execute when this alarm transitions into an
OK state from any other state. |
Integer |
getPeriod()
The period in seconds over which the specified statistic is applied.
|
String |
getStatistic()
The statistic to apply to the alarm's associated metric.
|
Double |
getThreshold()
The value against which the specified statistic is compared.
|
String |
getUnit()
The statistic's unit of measure.
|
int |
hashCode() |
Boolean |
isActionsEnabled()
Indicates whether or not actions should be executed during any changes to the alarm's state.
|
void |
setActionsEnabled(Boolean actionsEnabled)
Indicates whether or not actions should be executed during any changes to the alarm's state.
|
void |
setAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. |
void |
setAlarmDescription(String alarmDescription)
The description for the alarm.
|
void |
setAlarmName(String alarmName)
The descriptive 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 alarm's associated metric.
|
void |
setEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
void |
setInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
void |
setMetricName(String metricName)
The name for the alarm's associated metric.
|
void |
setNamespace(String namespace)
The namespace for the alarm's associated metric.
|
void |
setOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into 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 to apply to the alarm's associated metric.
|
void |
setStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
|
void |
setThreshold(Double threshold)
The value against which the specified statistic is compared.
|
void |
setUnit(StandardUnit unit)
The statistic's unit of measure.
|
void |
setUnit(String unit)
The statistic's unit of measure.
|
String |
toString()
Returns a string representation of this object; useful for testing and debugging.
|
PutMetricAlarmRequest |
withActionsEnabled(Boolean actionsEnabled)
Indicates whether or not actions should be executed during any changes to the alarm's state.
|
PutMetricAlarmRequest |
withAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. |
PutMetricAlarmRequest |
withAlarmActions(String... alarmActions)
The list of actions to execute when this alarm transitions into an
ALARM state from any other state. |
PutMetricAlarmRequest |
withAlarmDescription(String alarmDescription)
The description for the alarm.
|
PutMetricAlarmRequest |
withAlarmName(String alarmName)
The descriptive 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 alarm's associated metric.
|
PutMetricAlarmRequest |
withDimensions(Dimension... dimensions)
The dimensions for the alarm's associated metric.
|
PutMetricAlarmRequest |
withEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
PutMetricAlarmRequest |
withInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
PutMetricAlarmRequest |
withInsufficientDataActions(String... insufficientDataActions)
The list of actions to execute when this alarm transitions into an
INSUFFICIENT_DATA state from any
other state. |
PutMetricAlarmRequest |
withMetricName(String metricName)
The name for the alarm's associated metric.
|
PutMetricAlarmRequest |
withNamespace(String namespace)
The namespace for the alarm's associated metric.
|
PutMetricAlarmRequest |
withOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an
OK state from any other state. |
PutMetricAlarmRequest |
withOKActions(String... oKActions)
The list of actions to execute when this alarm transitions into 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 to apply to the alarm's associated metric.
|
PutMetricAlarmRequest |
withStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
|
PutMetricAlarmRequest |
withThreshold(Double threshold)
The value against which the specified statistic is compared.
|
PutMetricAlarmRequest |
withUnit(StandardUnit unit)
The statistic's unit of measure.
|
PutMetricAlarmRequest |
withUnit(String unit)
The statistic's unit of measure.
|
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setAlarmName(String alarmName)
The descriptive name for the alarm. This name must be unique within the user's AWS account
alarmName
- The descriptive name for the alarm. This name must be unique within the user's AWS accountpublic String getAlarmName()
The descriptive name for the alarm. This name must be unique within the user's AWS account
public PutMetricAlarmRequest withAlarmName(String alarmName)
The descriptive name for the alarm. This name must be unique within the user's AWS account
alarmName
- The descriptive name for the alarm. This name must be unique within the user's AWS accountpublic 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 or not actions should be executed during any changes to the alarm's state.
actionsEnabled
- Indicates whether or not actions should be executed during any changes to the alarm's state.public Boolean getActionsEnabled()
Indicates whether or not actions should be executed during any changes to the alarm's state.
public PutMetricAlarmRequest withActionsEnabled(Boolean actionsEnabled)
Indicates whether or not actions should be executed during any changes to the alarm's state.
actionsEnabled
- Indicates whether or not actions should be executed during any changes to the alarm's state.public Boolean isActionsEnabled()
Indicates whether or not actions should be executed during any changes to the alarm's state.
public List<String> getOKActions()
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public void setOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
oKActions
- The list of actions to execute when this alarm transitions into an OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public PutMetricAlarmRequest withOKActions(String... oKActions)
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
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 list of actions to execute when this alarm transitions into an OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public PutMetricAlarmRequest withOKActions(Collection<String> oKActions)
The list of actions to execute when this alarm transitions into an OK
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
oKActions
- The list of actions to execute when this alarm transitions into an OK
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public List<String> getAlarmActions()
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
ALARM
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public void setAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
alarmActions
- The list of actions to execute when this alarm transitions into an ALARM
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public PutMetricAlarmRequest withAlarmActions(String... alarmActions)
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
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 list of actions to execute when this alarm transitions into an ALARM
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public PutMetricAlarmRequest withAlarmActions(Collection<String> alarmActions)
The list of actions to execute when this alarm transitions into an ALARM
state from any other state.
Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
alarmActions
- The list of actions to execute when this alarm transitions into an ALARM
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public List<String> getInsufficientDataActions()
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public void setInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
insufficientDataActions
- The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public PutMetricAlarmRequest withInsufficientDataActions(String... insufficientDataActions)
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
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 list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public PutMetricAlarmRequest withInsufficientDataActions(Collection<String> insufficientDataActions)
The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state from any
other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
insufficientDataActions
- The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA
state
from any other state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: arn:aws:automate:region (e.g., us-east-1):ec2:stop | arn:aws:automate:region (e.g., us-east-1):ec2:terminate | arn:aws:automate:region (e.g., us-east-1):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: You must create at least one stop, terminate, or reboot alarm using the Amazon EC2 or CloudWatch console to create the EC2ActionsAccess IAM role for the first time. After this IAM role is created, you can create stop, terminate, or reboot alarms using the CLI.
public void setMetricName(String metricName)
The name for the alarm's associated metric.
metricName
- The name for the alarm's associated metric.public String getMetricName()
The name for the alarm's associated metric.
public PutMetricAlarmRequest withMetricName(String metricName)
The name for the alarm's associated metric.
metricName
- The name for the alarm's associated metric.public void setNamespace(String namespace)
The namespace for the alarm's associated metric.
namespace
- The namespace for the alarm's associated metric.public String getNamespace()
The namespace for the alarm's associated metric.
public PutMetricAlarmRequest withNamespace(String namespace)
The namespace for the alarm's associated metric.
namespace
- The namespace for the alarm's associated metric.public void setStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public String getStatistic()
The statistic to apply to the alarm's associated metric.
Statistic
public PutMetricAlarmRequest withStatistic(String statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public void setStatistic(Statistic statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public PutMetricAlarmRequest withStatistic(Statistic statistic)
The statistic to apply to the alarm's associated metric.
statistic
- The statistic to apply to the alarm's associated metric.Statistic
public List<Dimension> getDimensions()
The dimensions for the alarm's associated metric.
public void setDimensions(Collection<Dimension> dimensions)
The dimensions for the alarm's associated metric.
dimensions
- The dimensions for the alarm's associated metric.public PutMetricAlarmRequest withDimensions(Dimension... dimensions)
The dimensions for the alarm's associated metric.
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 alarm's associated metric.public PutMetricAlarmRequest withDimensions(Collection<Dimension> dimensions)
The dimensions for the alarm's associated metric.
dimensions
- The dimensions for the alarm's associated metric.public void setPeriod(Integer period)
The period in seconds over which the specified statistic is applied.
period
- The period in seconds over which the specified statistic is applied.public Integer getPeriod()
The period in seconds over which the specified statistic is applied.
public PutMetricAlarmRequest withPeriod(Integer period)
The period in seconds over which the specified statistic is applied.
period
- The period in seconds over which the specified statistic is applied.public void setUnit(String unit)
The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
unit
- The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
StandardUnit
public String getUnit()
The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
StandardUnit
public PutMetricAlarmRequest withUnit(String unit)
The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
unit
- The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
StandardUnit
public void setUnit(StandardUnit unit)
The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
unit
- The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
StandardUnit
public PutMetricAlarmRequest withUnit(StandardUnit unit)
The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to get stuck in the INSUFFICIENT DATA state.
unit
- The statistic's unit of measure. 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.
Note: If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, this can cause an Amazon CloudWatch alarm to 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.
evaluationPeriods
- The number of periods over which data is compared to the specified threshold.public Integer getEvaluationPeriods()
The number of periods over which data is compared to the specified threshold.
public PutMetricAlarmRequest withEvaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
evaluationPeriods
- The number of periods over which data is compared to the specified threshold.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.
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 String toString()
toString
in class Object
Object.toString()
public PutMetricAlarmRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2016. All rights reserved.