public static interface PutMetricAlarmRequest.Builder extends CloudWatchRequest.Builder, CopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>
Modifier and Type | Method and Description |
---|---|
PutMetricAlarmRequest.Builder |
actionsEnabled(Boolean actionsEnabled)
Indicates whether actions should be executed during any changes to the alarm state.
|
PutMetricAlarmRequest.Builder |
alarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
PutMetricAlarmRequest.Builder |
alarmActions(String... alarmActions)
The actions to execute when this alarm transitions to the
ALARM state from any other state. |
PutMetricAlarmRequest.Builder |
alarmDescription(String alarmDescription)
The description for the alarm.
|
PutMetricAlarmRequest.Builder |
alarmName(String alarmName)
The name for the alarm.
|
PutMetricAlarmRequest.Builder |
comparisonOperator(ComparisonOperator comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
PutMetricAlarmRequest.Builder |
comparisonOperator(String comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold.
|
PutMetricAlarmRequest.Builder |
dimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
|
PutMetricAlarmRequest.Builder |
dimensions(Dimension... dimensions)
The dimensions for the metric associated with the alarm.
|
PutMetricAlarmRequest.Builder |
evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
Used only for alarms based on percentiles.
|
PutMetricAlarmRequest.Builder |
evaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold.
|
PutMetricAlarmRequest.Builder |
extendedStatistic(String extendedStatistic)
The percentile statistic for the metric associated with the alarm.
|
PutMetricAlarmRequest.Builder |
insufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
PutMetricAlarmRequest.Builder |
insufficientDataActions(String... insufficientDataActions)
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA state from any other
state. |
PutMetricAlarmRequest.Builder |
metricName(String metricName)
The name for the metric associated with the alarm.
|
PutMetricAlarmRequest.Builder |
namespace(String namespace)
The namespace for the metric associated with the alarm.
|
PutMetricAlarmRequest.Builder |
okActions(Collection<String> okActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
PutMetricAlarmRequest.Builder |
okActions(String... okActions)
The actions to execute when this alarm transitions to an
OK state from any other state. |
PutMetricAlarmRequest.Builder |
period(Integer period)
The period, in seconds, over which the specified statistic is applied.
|
PutMetricAlarmRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
PutMetricAlarmRequest.Builder |
statistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
PutMetricAlarmRequest.Builder |
statistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile.
|
PutMetricAlarmRequest.Builder |
threshold(Double threshold)
The value against which the specified statistic is compared.
|
PutMetricAlarmRequest.Builder |
treatMissingData(String treatMissingData)
Sets how this alarm is to handle missing data points.
|
PutMetricAlarmRequest.Builder |
unit(StandardUnit unit)
The unit of measure for the statistic.
|
PutMetricAlarmRequest.Builder |
unit(String unit)
The unit of measure for the statistic.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
PutMetricAlarmRequest.Builder alarmName(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.PutMetricAlarmRequest.Builder alarmDescription(String alarmDescription)
The description for the alarm.
alarmDescription
- The description for the alarm.PutMetricAlarmRequest.Builder actionsEnabled(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.PutMetricAlarmRequest.Builder okActions(Collection<String> okActions)
The actions to execute when this alarm transitions to an OK
state from any other state. Each
action is specified as an Amazon Resource Name (ARN).
Valid Values: 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
PutMetricAlarmRequest.Builder okActions(String... okActions)
The actions to execute when this alarm transitions to an OK
state from any other state. Each
action is specified as an Amazon Resource Name (ARN).
Valid Values: 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
PutMetricAlarmRequest.Builder alarmActions(Collection<String> alarmActions)
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each
action is specified as an Amazon Resource Name (ARN).
Valid Values: 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
PutMetricAlarmRequest.Builder alarmActions(String... alarmActions)
The actions to execute when this alarm transitions to the ALARM
state from any other state. Each
action is specified as an Amazon Resource Name (ARN).
Valid Values: 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
PutMetricAlarmRequest.Builder insufficientDataActions(Collection<String> insufficientDataActions)
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: 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
PutMetricAlarmRequest.Builder insufficientDataActions(String... insufficientDataActions)
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA
state from any other
state. Each action is specified as an Amazon Resource Name (ARN).
Valid Values: 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
PutMetricAlarmRequest.Builder metricName(String metricName)
The name for the metric associated with the alarm.
metricName
- The name for the metric associated with the alarm.PutMetricAlarmRequest.Builder namespace(String namespace)
The namespace for the metric associated with the alarm.
namespace
- The namespace for the metric associated with the alarm.PutMetricAlarmRequest.Builder statistic(String statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
PutMetricAlarmRequest.Builder statistic(Statistic statistic)
The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use
ExtendedStatistic
.
PutMetricAlarmRequest.Builder extendedStatistic(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.PutMetricAlarmRequest.Builder dimensions(Collection<Dimension> dimensions)
The dimensions for the metric associated with the alarm.
dimensions
- The dimensions for the metric associated with the alarm.PutMetricAlarmRequest.Builder dimensions(Dimension... dimensions)
The dimensions for the metric associated with the alarm.
dimensions
- The dimensions for the metric associated with the alarm.PutMetricAlarmRequest.Builder period(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.
PutMetricAlarmRequest.Builder unit(String unit)
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you 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
,
StandardUnit
PutMetricAlarmRequest.Builder unit(StandardUnit unit)
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you 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
,
StandardUnit
PutMetricAlarmRequest.Builder evaluationPeriods(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.PutMetricAlarmRequest.Builder threshold(Double threshold)
The value against which the specified statistic is compared.
threshold
- The value against which the specified statistic is compared.PutMetricAlarmRequest.Builder comparisonOperator(String comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
,
ComparisonOperator
PutMetricAlarmRequest.Builder comparisonOperator(ComparisonOperator comparisonOperator)
The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.ComparisonOperator
,
ComparisonOperator
PutMetricAlarmRequest.Builder treatMissingData(String treatMissingData)
Sets how this alarm is to handle missing data points. If TreatMissingData
is omitted, the
default behavior of missing
is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.
Valid Values: breaching | notBreaching | ignore | missing
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
PutMetricAlarmRequest.Builder evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
Used only for alarms based on percentiles. If you specify ignore
, the alarm state does not
change during periods with too few data points to be statistically significant. If you specify
evaluate
or omit this parameter, the alarm is always evaluated and possibly changes state no
matter how many data points are available. For more information, see Percentile-Based CloudWatch Alarms and Low Data Samples.
Valid Values: evaluate | ignore
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
PutMetricAlarmRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.