Class PutMetricAlarmRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.cloudwatch.model.CloudWatchRequest
-
- software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutMetricAlarmRequest extends CloudWatchRequest implements ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
PutMetricAlarmRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state.List<String>
alarmActions()
The actions to execute when this alarm transitions to theALARM
state from any other state.String
alarmDescription()
The description for the alarm.String
alarmName()
The name for the alarm.static PutMetricAlarmRequest.Builder
builder()
ComparisonOperator
comparisonOperator()
The arithmetic operation to use when comparing the specified statistic and threshold.String
comparisonOperatorAsString()
The arithmetic operation to use when comparing the specified statistic and threshold.Integer
datapointsToAlarm()
The number of data points that must be breaching to trigger the alarm.List<Dimension>
dimensions()
The dimensions for the metric specified inMetricName
.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
evaluateLowSampleCountPercentile()
Used only for alarms based on percentiles.Integer
evaluationPeriods()
The number of periods over which data is compared to the specified threshold.String
extendedStatistic()
The extended statistic for the metric specified inMetricName
.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAlarmActions()
For responses, this returns true if the service returned a value for the AlarmActions property.boolean
hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property.int
hashCode()
boolean
hasInsufficientDataActions()
For responses, this returns true if the service returned a value for the InsufficientDataActions property.boolean
hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property.boolean
hasOkActions()
For responses, this returns true if the service returned a value for the OKActions property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.List<String>
insufficientDataActions()
The actions to execute when this alarm transitions to theINSUFFICIENT_DATA
state from any other state.String
metricName()
The name for the metric associated with the alarm.List<MetricDataQuery>
metrics()
An array ofMetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression.String
namespace()
The namespace for the metric associated specified inMetricName
.List<String>
okActions()
The actions to execute when this alarm transitions to anOK
state from any other state.Integer
period()
The length, in seconds, used each time the metric specified inMetricName
is evaluated.List<SdkField<?>>
sdkFields()
static Class<? extends PutMetricAlarmRequest.Builder>
serializableBuilderClass()
Statistic
statistic()
The statistic for the metric specified inMetricName
, other than percentile.String
statisticAsString()
The statistic for the metric specified inMetricName
, other than percentile.List<Tag>
tags()
A list of key-value pairs to associate with the alarm.Double
threshold()
The value against which the specified statistic is compared.String
thresholdMetricId()
If this is an alarm based on an anomaly detection model, make this value match the ID of theANOMALY_DETECTION_BAND
function.PutMetricAlarmRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
treatMissingData()
Sets how this alarm is to handle missing data points.StandardUnit
unit()
The unit of measure for the statistic.String
unitAsString()
The unit of measure for the statistic.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
alarmName
public final String alarmName()
The name for the alarm. This name must be unique within the Region.
The name must contain only UTF-8 characters, and can't contain ASCII control characters
- Returns:
- The name for the alarm. This name must be unique within the Region.
The name must contain only UTF-8 characters, and can't contain ASCII control characters
-
alarmDescription
public final String alarmDescription()
The description for the alarm.
- Returns:
- The description for the alarm.
-
actionsEnabled
public final Boolean actionsEnabled()
Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE
.- Returns:
- Indicates whether actions should be executed during any changes to the alarm state. The default is
TRUE
.
-
hasOkActions
public final boolean hasOkActions()
For responses, this returns true if the service returned a value for the OKActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
okActions
public final List<String> okActions()
The actions to execute when this alarm transitions to an
OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:EC2 actions:
-
arn:aws:automate:region:ec2:stop
-
arn:aws:automate:region:ec2:terminate
-
arn:aws:automate:region:ec2:reboot
-
arn:aws:automate:region:ec2:recover
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
-
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SSM integration actions:
-
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
-
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasOkActions()
method.- Returns:
- The actions to execute when this alarm transitions to an
OK
state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:EC2 actions:
-
arn:aws:automate:region:ec2:stop
-
arn:aws:automate:region:ec2:terminate
-
arn:aws:automate:region:ec2:reboot
-
arn:aws:automate:region:ec2:recover
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
-
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SSM integration actions:
-
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
-
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
-
-
-
hasAlarmActions
public final boolean hasAlarmActions()
For responses, this returns true if the service returned a value for the AlarmActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
alarmActions
public final List<String> alarmActions()
The actions to execute when this alarm transitions to the
ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:EC2 actions:
-
arn:aws:automate:region:ec2:stop
-
arn:aws:automate:region:ec2:terminate
-
arn:aws:automate:region:ec2:reboot
-
arn:aws:automate:region:ec2:recover
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
-
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SSM integration actions:
-
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
-
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasAlarmActions()
method.- Returns:
- The actions to execute when this alarm transitions to the
ALARM
state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:EC2 actions:
-
arn:aws:automate:region:ec2:stop
-
arn:aws:automate:region:ec2:terminate
-
arn:aws:automate:region:ec2:reboot
-
arn:aws:automate:region:ec2:recover
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
-
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SSM integration actions:
-
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
-
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
-
-
-
hasInsufficientDataActions
public final boolean hasInsufficientDataActions()
For responses, this returns true if the service returned a value for the InsufficientDataActions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
insufficientDataActions
public final List<String> insufficientDataActions()
The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:EC2 actions:
-
arn:aws:automate:region:ec2:stop
-
arn:aws:automate:region:ec2:terminate
-
arn:aws:automate:region:ec2:reboot
-
arn:aws:automate:region:ec2:recover
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
-
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SSM integration actions:
-
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
-
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInsufficientDataActions()
method.- Returns:
- The actions to execute when this alarm transitions to the
INSUFFICIENT_DATA
state from any other state. Each action is specified as an Amazon Resource Name (ARN). Valid values:EC2 actions:
-
arn:aws:automate:region:ec2:stop
-
arn:aws:automate:region:ec2:terminate
-
arn:aws:automate:region:ec2:reboot
-
arn:aws:automate:region:ec2:recover
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Stop/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Terminate/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Reboot/1.0
-
arn:aws:swf:region:account-id:action/actions/AWS_EC2.InstanceId.Recover/1.0
Autoscaling action:
-
arn:aws:autoscaling:region:account-id:scalingPolicy:policy-id:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SNS notification action:
-
arn:aws:sns:region:account-id:sns-topic-name:autoScalingGroupName/group-friendly-name:policyName/policy-friendly-name
SSM integration actions:
-
arn:aws:ssm:region:account-id:opsitem:severity#CATEGORY=category-name
-
arn:aws:ssm-incidents::account-id:responseplan/response-plan-name
-
-
-
metricName
public final String metricName()
The name for the metric associated with the alarm. For each
PutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
array.If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
Namespace
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters. Instead, you specify all this information in theMetrics
array.- Returns:
- The name for the metric associated with the alarm. For each
PutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
array.If you are creating an alarm based on a math expression, you cannot specify this parameter, or any of the
Namespace
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters. Instead, you specify all this information in theMetrics
array.
-
namespace
public final String namespace()
The namespace for the metric associated specified in
MetricName
.- Returns:
- The namespace for the metric associated specified in
MetricName
.
-
statistic
public final Statistic statistic()
The statistic for the metric specified in
MetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both.If the service returns an enum value that is not available in the current SDK version,
statistic
will returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic for the metric specified in
MetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both. - See Also:
Statistic
-
statisticAsString
public final String statisticAsString()
The statistic for the metric specified in
MetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both.If the service returns an enum value that is not available in the current SDK version,
statistic
will returnStatistic.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatisticAsString()
.- Returns:
- The statistic for the metric specified in
MetricName
, other than percentile. For percentile statistics, useExtendedStatistic
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic,
but not both. - See Also:
Statistic
-
extendedStatistic
public final String extendedStatistic()
The extended statistic for the metric specified in
MetricName
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic
but not both.If you specify
ExtendedStatistic
, the following are valid values:-
p90
-
tm90
-
tc90
-
ts90
-
wm90
-
IQM
-
PR(n:m)
where n and m are values of the metric -
TC(X%:X%)
where X is between 10 and 90 inclusive. -
TM(X%:X%)
where X is between 10 and 90 inclusive. -
TS(X%:X%)
where X is between 10 and 90 inclusive. -
WM(X%:X%)
where X is between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
- Returns:
- The extended statistic for the metric specified in
MetricName
. When you callPutMetricAlarm
and specify aMetricName
, you must specify eitherStatistic
orExtendedStatistic
but not both.If you specify
ExtendedStatistic
, the following are valid values:-
p90
-
tm90
-
tc90
-
ts90
-
wm90
-
IQM
-
PR(n:m)
where n and m are values of the metric -
TC(X%:X%)
where X is between 10 and 90 inclusive. -
TM(X%:X%)
where X is between 10 and 90 inclusive. -
TS(X%:X%)
where X is between 10 and 90 inclusive. -
WM(X%:X%)
where X is between 10 and 90 inclusive.
For more information about these extended statistics, see CloudWatch statistics definitions.
-
-
-
hasDimensions
public final boolean hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
dimensions
public final List<Dimension> dimensions()
The dimensions for the metric specified in
MetricName
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasDimensions()
method.- Returns:
- The dimensions for the metric specified in
MetricName
.
-
period
public final 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 theMetrics
array.Be sure to specify 10 or 30 only for metrics that are stored by a
PutMetricData
call with aStorageResolution
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 byEvaluationPeriods
cannot be more than 86,400 seconds.- Returns:
- 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 theMetrics
array.Be sure to specify 10 or 30 only for metrics that are stored by a
PutMetricData
call with aStorageResolution
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 byEvaluationPeriods
cannot be more than 86,400 seconds.
-
unit
public final StandardUnit unit()
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the
Metrics
array.If you don't specify
Unit
, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting
Unit
so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in theINSUFFICIENT DATA
state.If the service returns an enum value that is not available in the current SDK version,
unit
will returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are
Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces.
You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to
your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you are creating an alarm based on a metric math expression, you can specify the unit for each metric
(if needed) within the objects in the
Metrics
array.If you don't specify
Unit
, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting
Unit
so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in theINSUFFICIENT DATA
state. - See Also:
StandardUnit
-
unitAsString
public final String unitAsString()
The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately. If you are creating an alarm based on a metric math expression, you can specify the unit for each metric (if needed) within the objects in the
Metrics
array.If you don't specify
Unit
, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting
Unit
so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in theINSUFFICIENT DATA
state.If the service returns an enum value that is not available in the current SDK version,
unit
will returnStandardUnit.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromunitAsString()
.- Returns:
- The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are
Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces.
You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to
your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.
If you are creating an alarm based on a metric math expression, you can specify the unit for each metric
(if needed) within the objects in the
Metrics
array.If you don't specify
Unit
, CloudWatch retrieves all unit types that have been published for the metric and attempts to evaluate the alarm. Usually, metrics are published with only one unit, so the alarm works as intended.However, if the metric is published with multiple types of units and you don't specify a unit, the alarm's behavior is not defined and it behaves unpredictably.
We recommend omitting
Unit
so that you don't inadvertently specify an incorrect unit that is not published for this metric. Doing so causes the alarm to be stuck in theINSUFFICIENT DATA
state. - See Also:
StandardUnit
-
evaluationPeriods
public final 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.- Returns:
- 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.
-
datapointsToAlarm
public final 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.
- Returns:
- 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.
-
threshold
public final 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.
- Returns:
- 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.
-
comparisonOperator
public final 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
, andGreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- 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
, andGreaterThanUpperThreshold
are used only for alarms based on anomaly detection models. - See Also:
ComparisonOperator
-
comparisonOperatorAsString
public final String comparisonOperatorAsString()
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
, andGreaterThanUpperThreshold
are used only for alarms based on anomaly detection models.If the service returns an enum value that is not available in the current SDK version,
comparisonOperator
will returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- Returns:
- 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
, andGreaterThanUpperThreshold
are used only for alarms based on anomaly detection models. - See Also:
ComparisonOperator
-
treatMissingData
public final String treatMissingData()
Sets how this alarm is to handle missing data points. If
TreatMissingData
is omitted, the default behavior ofmissing
is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.Valid Values:
breaching | notBreaching | ignore | missing
Alarms that evaluate metrics in the
AWS/DynamoDB
namespace alwaysignore
missing data even if you choose a different option forTreatMissingData
. When anAWS/DynamoDB
metric has missing data, alarms that evaluate that metric remain in their current state.- Returns:
- Sets how this alarm is to handle missing data points. If
TreatMissingData
is omitted, the default behavior ofmissing
is used. For more information, see Configuring How CloudWatch Alarms Treats Missing Data.Valid Values:
breaching | notBreaching | ignore | missing
Alarms that evaluate metrics in the
AWS/DynamoDB
namespace alwaysignore
missing data even if you choose a different option forTreatMissingData
. When anAWS/DynamoDB
metric has missing data, alarms that evaluate that metric remain in their current state.
-
evaluateLowSampleCountPercentile
public final 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 specifyevaluate
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
- Returns:
- 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 specifyevaluate
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
-
hasMetrics
public final boolean hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
metrics
public final List<MetricDataQuery> metrics()
An array of
MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
Metrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMetrics()
method.- Returns:
- An array of
MetricDataQuery
structures that enable you to create an alarm based on the result of a metric math expression. For eachPutMetricAlarm
operation, you must specify eitherMetricName
or aMetrics
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 settingReturnData
to true for this object in the array. For more information, see MetricDataQuery.If you use the
Metrics
parameter, you cannot include theNamespace
,MetricName
,Dimensions
,Period
,Unit
,Statistic
, orExtendedStatistic
parameters ofPutMetricAlarm
in the same operation. Instead, you retrieve the metrics you are using in your math expression as part of theMetrics
array.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tags
public final List<Tag> tags()
A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the
cloudwatch:TagResource
permission.Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTags()
method.- Returns:
- A list of key-value pairs to associate with the alarm. You can associate as many as 50 tags with an
alarm. To be able to associate tags with the alarm when you create the alarm, you must have the
cloudwatch:TagResource
permission.Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.
If you are using this operation to update an existing alarm, any tags you specify in this parameter are ignored. To change the tags of an existing alarm, use TagResource or UntagResource.
-
thresholdMetricId
public final 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.
- Returns:
- 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.
-
toBuilder
public PutMetricAlarmRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>
- Specified by:
toBuilder
in classCloudWatchRequest
-
builder
public static PutMetricAlarmRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends PutMetricAlarmRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-