public static interface PutMetricAlarmRequest.Builder extends CloudWatchRequest.Builder, SdkPojo, 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 |
datapointsToAlarm(Integer datapointsToAlarm)
The number of data points that must be breaching to trigger the alarm.
|
PutMetricAlarmRequest.Builder |
dimensions(Collection<Dimension> dimensions)
The dimensions for the metric specified in
MetricName . |
PutMetricAlarmRequest.Builder |
dimensions(Consumer<Dimension.Builder>... dimensions)
The dimensions for the metric specified in
MetricName . |
PutMetricAlarmRequest.Builder |
dimensions(Dimension... dimensions)
The dimensions for the metric specified in
MetricName . |
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 specified in
MetricName . |
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 |
metrics(Collection<MetricDataQuery> metrics)
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of
a metric math expression. |
PutMetricAlarmRequest.Builder |
metrics(Consumer<MetricDataQuery.Builder>... metrics)
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of
a metric math expression. |
PutMetricAlarmRequest.Builder |
metrics(MetricDataQuery... metrics)
An array of
MetricDataQuery structures that enable you to create an alarm based on the result of
a metric math expression. |
PutMetricAlarmRequest.Builder |
namespace(String namespace)
The namespace for the metric associated specified in
MetricName . |
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 |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
PutMetricAlarmRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
PutMetricAlarmRequest.Builder |
period(Integer period)
The length, in seconds, used each time the metric specified in
MetricName is evaluated. |
PutMetricAlarmRequest.Builder |
statistic(Statistic statistic)
The statistic for the metric specified in
MetricName , other than percentile. |
PutMetricAlarmRequest.Builder |
statistic(String statistic)
The statistic for the metric specified in
MetricName , other than percentile. |
PutMetricAlarmRequest.Builder |
tags(Collection<Tag> tags)
A list of key-value pairs to associate with the alarm.
|
PutMetricAlarmRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to associate with the alarm.
|
PutMetricAlarmRequest.Builder |
tags(Tag... tags)
A list of key-value pairs to associate with the alarm.
|
PutMetricAlarmRequest.Builder |
threshold(Double threshold)
The value against which the specified statistic is compared.
|
PutMetricAlarmRequest.Builder |
thresholdMetricId(String thresholdMetricId)
If this is an alarm based on an anomaly detection model, make this value match the ID of the
ANOMALY_DETECTION_BAND function. |
PutMetricAlarmRequest.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
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
PutMetricAlarmRequest.Builder alarmName(String alarmName)
The name for the alarm. This name must be unique within the Region.
alarmName
- The name for the alarm. This name must be unique within the Region.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. The default is
TRUE
.
actionsEnabled
- Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE
.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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
| arn:aws:ssm:region:account-id:opsitem:severity
|
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
| arn:aws:ssm:region:account-id:opsitem:severity
|
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
| arn:aws:ssm:region:account-id:opsitem:severity
|
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
| arn:aws:ssm:region:account-id:opsitem:severity
|
arn:aws:ssm-incidents::account-id:response-plan:response-plan-name
Valid Values (for use with IAM roles):
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
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
|
arn:aws:automate:region:ec2:reboot
|
arn:aws:sns:region:account-id:sns-topic-name
|
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
Valid Values (for use with IAM roles):
>arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
|
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
PutMetricAlarmRequest.Builder metricName(String metricName)
The name for the metric associated with the alarm. For each PutMetricAlarm
operation, you must
specify either MetricName
or a Metrics
array.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters. Instead, you specify all this information in the
Metrics
array.
metricName
- The name for the metric associated with the alarm. For each PutMetricAlarm
operation, you
must specify either MetricName
or a Metrics
array.
If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of
the Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters. Instead, you specify all this information in the
Metrics
array.
PutMetricAlarmRequest.Builder namespace(String namespace)
The namespace for the metric associated specified in MetricName
.
namespace
- The namespace for the metric associated specified in MetricName
.PutMetricAlarmRequest.Builder statistic(String statistic)
The statistic for the metric specified in MetricName
, other than percentile. For percentile
statistics, use ExtendedStatistic
. When you call PutMetricAlarm
and specify a
MetricName
, you must specify either Statistic
or ExtendedStatistic,
but not both.
statistic
- The statistic for the metric specified in MetricName
, other than percentile. For
percentile statistics, use ExtendedStatistic
. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or
ExtendedStatistic,
but not both.Statistic
,
Statistic
PutMetricAlarmRequest.Builder statistic(Statistic statistic)
The statistic for the metric specified in MetricName
, other than percentile. For percentile
statistics, use ExtendedStatistic
. When you call PutMetricAlarm
and specify a
MetricName
, you must specify either Statistic
or ExtendedStatistic,
but not both.
statistic
- The statistic for the metric specified in MetricName
, other than percentile. For
percentile statistics, use ExtendedStatistic
. When you call PutMetricAlarm
and specify a MetricName
, you must specify either Statistic
or
ExtendedStatistic,
but not both.Statistic
,
Statistic
PutMetricAlarmRequest.Builder extendedStatistic(String extendedStatistic)
The percentile statistic for the metric specified in MetricName
. Specify a value between p0.0
and p100. When you call PutMetricAlarm
and specify a MetricName
, you must specify
either Statistic
or ExtendedStatistic,
but not both.
extendedStatistic
- The percentile statistic for the metric specified in MetricName
. Specify a value between
p0.0 and p100. When you call PutMetricAlarm
and specify a MetricName
, you
must specify either Statistic
or ExtendedStatistic,
but not both.PutMetricAlarmRequest.Builder dimensions(Collection<Dimension> dimensions)
The dimensions for the metric specified in MetricName
.
dimensions
- The dimensions for the metric specified in MetricName
.PutMetricAlarmRequest.Builder dimensions(Dimension... dimensions)
The dimensions for the metric specified in MetricName
.
dimensions
- The dimensions for the metric specified in MetricName
.PutMetricAlarmRequest.Builder dimensions(Consumer<Dimension.Builder>... dimensions)
The dimensions for the metric specified in MetricName
.
List.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #dimensions(List)
.dimensions
- a consumer that will call methods on List.Builder
#dimensions(List)
PutMetricAlarmRequest.Builder period(Integer period)
The length, in seconds, used each time the metric specified in MetricName
is evaluated. Valid
values are 10, 30, and any multiple of 60.
Period
is required for alarms based on static thresholds. If you are creating an alarm based on
a metric math expression, you specify the period for each metric within the objects in the
Metrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData
call with a
StorageResolution
of 1. If you specify a period of 10 or 30 for a metric that does not have
sub-minute resolution, the alarm still attempts to gather data at the period rate that you specify. In this
case, it does not receive data for the attempts that do not correspond to a one-minute data resolution, and
the alarm might often lapse into INSUFFICENT_DATA status. Specifying 10 or 30 also sets this alarm as a
high-resolution alarm, which has a higher charge than other alarms. For more information about pricing, see
Amazon CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than one day, so Period
multiplied
by EvaluationPeriods
cannot be more than 86,400 seconds.
period
- The length, in seconds, used each time the metric specified in MetricName
is evaluated.
Valid values are 10, 30, and any multiple of 60.
Period
is required for alarms based on static thresholds. If you are creating an alarm
based on a metric math expression, you specify the period for each metric within the objects in the
Metrics
array.
Be sure to specify 10 or 30 only for metrics that are stored by a PutMetricData
call with
a StorageResolution
of 1. If you specify a period of 10 or 30 for a metric that does not
have sub-minute resolution, the alarm still attempts to gather data at the period rate that you
specify. In this case, it does not receive data for the attempts that do not correspond to a
one-minute data resolution, and the alarm might often lapse into INSUFFICENT_DATA status. Specifying
10 or 30 also sets this alarm as a high-resolution alarm, which has a higher charge than other alarms.
For more information about pricing, see Amazon
CloudWatch Pricing.
An alarm's total current evaluation period can be no longer than one day, so Period
multiplied by EvaluationPeriods
cannot be more than 86,400 seconds.
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 don't specify Unit
, CloudWatch retrieves all unit types that have been published for the
metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm
works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit
so that you don't inadvertently specify an incorrect unit that is not
published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA
state.
unit
- The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are
Bytes because NetworkIn tracks the number of bytes that an instance receives on all network
interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual
meaning to your data. Metric data points that specify a unit of measure, such as Percent, are
aggregated separately.
If you don't specify Unit
, CloudWatch retrieves all unit types that have been published
for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit,
so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit
so that you don't inadvertently specify an incorrect unit that
is not published for this metric. Doing so causes the alarm to be stuck in the
INSUFFICIENT DATA
state.
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 don't specify Unit
, CloudWatch retrieves all unit types that have been published for the
metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm
works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit
so that you don't inadvertently specify an incorrect unit that is not
published for this metric. Doing so causes the alarm to be stuck in the INSUFFICIENT DATA
state.
unit
- The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are
Bytes because NetworkIn tracks the number of bytes that an instance receives on all network
interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual
meaning to your data. Metric data points that specify a unit of measure, such as Percent, are
aggregated separately.
If you don't specify Unit
, CloudWatch retrieves all unit types that have been published
for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit,
so the alarm works as intended.
However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves predictably.
We recommend omitting Unit
so that you don't inadvertently specify an incorrect unit that
is not published for this metric. Doing so causes the alarm to be stuck in the
INSUFFICIENT DATA
state.
StandardUnit
,
StandardUnit
PutMetricAlarmRequest.Builder evaluationPeriods(Integer evaluationPeriods)
The number of periods over which data is compared to the specified threshold. If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies that number. If you are setting an "M out of N" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by
Period
cannot be more than 86,400 seconds.
evaluationPeriods
- The number of periods over which data is compared to the specified threshold. If you are setting an
alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this
value specifies that number. If you are setting an "M out of N" alarm, this value is the N.
An alarm's total current evaluation period can be no longer than one day, so this number multiplied by
Period
cannot be more than 86,400 seconds.
PutMetricAlarmRequest.Builder datapointsToAlarm(Integer datapointsToAlarm)
The number of data points that must be breaching to trigger the alarm. This is used only if you are setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.
datapointsToAlarm
- The number of data points that must be breaching to trigger the alarm. This is used only if you are
setting an "M out of N" alarm. In that case, this value is the M. For more information, see Evaluating an Alarm in the Amazon CloudWatch User Guide.PutMetricAlarmRequest.Builder threshold(Double threshold)
The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
threshold
- The value against which the specified statistic is compared.
This parameter is required for alarms based on static thresholds, but should not be used for alarms based on anomaly detection models.
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.
The values LessThanLowerOrGreaterThanUpperThreshold
, LessThanLowerThreshold
, and
GreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.
The values LessThanLowerOrGreaterThanUpperThreshold
, LessThanLowerThreshold
,
and GreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.
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.
The values LessThanLowerOrGreaterThanUpperThreshold
, LessThanLowerThreshold
, and
GreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.
comparisonOperator
- The arithmetic operation to use when comparing the specified statistic and threshold. The specified
statistic value is used as the first operand.
The values LessThanLowerOrGreaterThanUpperThreshold
, LessThanLowerThreshold
,
and GreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.
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 metrics(Collection<MetricDataQuery> metrics)
An array of MetricDataQuery
structures that enable you to create an alarm based on the result of
a metric math expression. For each PutMetricAlarm
operation, you must specify either
MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate this
expression by setting ReturnData
to true for this object in the array. For more information, see
MetricDataQuery.
If you use the Metrics
parameter, you cannot include the MetricName
,
Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters of PutMetricAlarm
in the same operation. Instead, you
retrieve the metrics you are using in your math expression as part of the Metrics
array.
metrics
- An array of MetricDataQuery
structures that enable you to create an alarm based on the
result of a metric math expression. For each PutMetricAlarm
operation, you must specify
either MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate
this expression by setting ReturnData
to true for this object in the array. For more
information, see MetricDataQuery.
If you use the Metrics
parameter, you cannot include the MetricName
,
Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters of PutMetricAlarm
in the same operation.
Instead, you retrieve the metrics you are using in your math expression as part of the
Metrics
array.
PutMetricAlarmRequest.Builder metrics(MetricDataQuery... metrics)
An array of MetricDataQuery
structures that enable you to create an alarm based on the result of
a metric math expression. For each PutMetricAlarm
operation, you must specify either
MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate this
expression by setting ReturnData
to true for this object in the array. For more information, see
MetricDataQuery.
If you use the Metrics
parameter, you cannot include the MetricName
,
Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters of PutMetricAlarm
in the same operation. Instead, you
retrieve the metrics you are using in your math expression as part of the Metrics
array.
metrics
- An array of MetricDataQuery
structures that enable you to create an alarm based on the
result of a metric math expression. For each PutMetricAlarm
operation, you must specify
either MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate
this expression by setting ReturnData
to true for this object in the array. For more
information, see MetricDataQuery.
If you use the Metrics
parameter, you cannot include the MetricName
,
Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters of PutMetricAlarm
in the same operation.
Instead, you retrieve the metrics you are using in your math expression as part of the
Metrics
array.
PutMetricAlarmRequest.Builder metrics(Consumer<MetricDataQuery.Builder>... metrics)
An array of MetricDataQuery
structures that enable you to create an alarm based on the result of
a metric math expression. For each PutMetricAlarm
operation, you must specify either
MetricName
or a Metrics
array.
Each item in the Metrics
array either retrieves a metric or performs a math expression.
One item in the Metrics
array is the expression that the alarm watches. You designate this
expression by setting ReturnData
to true for this object in the array. For more information, see
MetricDataQuery.
If you use the Metrics
parameter, you cannot include the MetricName
,
Dimensions
, Period
, Namespace
, Statistic
, or
ExtendedStatistic
parameters of PutMetricAlarm
in the same operation. Instead, you
retrieve the metrics you are using in your math expression as part of the Metrics
array.
List.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #metrics(List)
.metrics
- a consumer that will call methods on List.Builder
#metrics(List)
PutMetricAlarmRequest.Builder tags(Collection<Tag> tags)
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
tags
- A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an
alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
PutMetricAlarmRequest.Builder tags(Tag... tags)
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
tags
- A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an
alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
PutMetricAlarmRequest.Builder tags(Consumer<Tag.Builder>... tags)
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
This is a convenience that creates an instance of theList.Builder
avoiding the need to create
one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its result
is passed to #tags(List)
.tags
- a consumer that will call methods on List.Builder
#tags(List)
PutMetricAlarmRequest.Builder thresholdMetricId(String thresholdMetricId)
If this is an alarm based on an anomaly detection model, make this value match the ID of the
ANOMALY_DETECTION_BAND
function.
For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
thresholdMetricId
- If this is an alarm based on an anomaly detection model, make this value match the ID of the
ANOMALY_DETECTION_BAND
function.
For an example of how to use this parameter, see the Anomaly Detection Model Alarm example on this page.
If your alarm uses this parameter, it cannot have Auto Scaling actions.
PutMetricAlarmRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
PutMetricAlarmRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2021. All rights reserved.