Package software.amazon.awssdk.services.cloudwatch.model

Class PutMetricAlarmRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudwatch.model.PutMetricAlarmRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

@Generated("software.amazon.awssdk:codegen")
public class PutMetricAlarmRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutMetricAlarmRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

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 the ALARM state from any other state.
String	alarmDescription()	The description for the alarm.
String	alarmName()	The name for the alarm.
static PutMetricAlarmRequest.Builder	builder()
String	comparisonOperator()	The arithmetic operation to use when comparing the specified statistic and threshold.
List<Dimension>	dimensions()	The dimensions for the metric associated with the alarm.
boolean	equals(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 percentile statistic for the metric associated with the alarm.
int	hashCode()
List<String>	insufficientDataActions()	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
String	metricName()	The name for the metric associated with the alarm.
String	namespace()	The namespace for the metric associated with the alarm.
List<String>	okActions()	The actions to execute when this alarm transitions to an OK state from any other state.
Integer	period()	The period, in seconds, over which the specified statistic is applied.
static Class<? extends PutMetricAlarmRequest.Builder>	serializableBuilderClass()
String	statistic()	The statistic for the metric associated with the alarm, other than percentile.
Double	threshold()	The value against which the specified statistic is compared.
PutMetricAlarmRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	treatMissingData()	Sets how this alarm is to handle missing data points.
String	unit()	The unit of measure for the statistic.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

alarmName

public String alarmName()

The name for the alarm. This name must be unique within the AWS account.

Returns:

The name for the alarm. This name must be unique within the AWS account.

alarmDescription

public String alarmDescription()

The description for the alarm.

Returns:

The description for the alarm.

actionsEnabled

public Boolean actionsEnabled()

Indicates whether actions should be executed during any changes to the alarm state.

Returns:

Indicates whether actions should be executed during any changes to the alarm state.

okActions

public 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: 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

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: 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

public 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: 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

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: 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

public 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: 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

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: 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

metricName

public String metricName()

The name for the metric associated with the alarm.

Returns:

The name for the metric associated with the alarm.

namespace

public String namespace()

The namespace for the metric associated with the alarm.

Returns:

The namespace for the metric associated with the alarm.

statistic

public String statistic()

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

Returns:

The statistic for the metric associated with the alarm, other than percentile. For percentile statistics, use ExtendedStatistic.

See Also:

Statistic

extendedStatistic

public String extendedStatistic()

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

Returns:

The percentile statistic for the metric associated with the alarm. Specify a value between p0.0 and p100.

dimensions

public List<Dimension> dimensions()

The dimensions for the metric associated with the alarm.

Returns:

The dimensions for the metric associated with the alarm.

period

public Integer period()

The period, in seconds, over which the specified statistic is applied.

Returns:

The period, in seconds, over which the specified statistic is applied.

unit

public 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 Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

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 specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

See Also:

StandardUnit

evaluationPeriods

public Integer evaluationPeriods()

The number of periods over which data is compared to the specified threshold.

Returns:

The number of periods over which data is compared to the specified threshold.

threshold

public Double threshold()

The value against which the specified statistic is compared.

Returns:

The value against which the specified statistic is compared.

comparisonOperator

public String comparisonOperator()

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

Returns:

The arithmetic operation to use when comparing the specified statistic and threshold. The specified statistic value is used as the first operand.

See Also:

ComparisonOperator

treatMissingData

public 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

Returns:

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

evaluateLowSampleCountPercentile

public String evaluateLowSampleCountPercentile()

Used only for alarms based on percentiles. If you specify ignore, the alarm state will not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm will always be evaluated and possibly change 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 will not change during periods with too few data points to be statistically significant. If you specify evaluate or omit this parameter, the alarm will always be evaluated and possibly change 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

toBuilder

public PutMetricAlarmRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

Returns:

a builder for type T

builder

public static PutMetricAlarmRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutMetricAlarmRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object