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

Interface PutMetricAlarmRequest.Builder

All Superinterfaces:

CopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>, SdkBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

Enclosing class:

PutMetricAlarmRequest

public static interface PutMetricAlarmRequest.Builder
extends CopyableBuilder<PutMetricAlarmRequest.Builder,PutMetricAlarmRequest>

Method Summary

Modifier and Type	Method	Description
PutMetricAlarmRequest.Builder	actionsEnabled(Boolean actionsEnabled)	Indicates whether actions should be executed during any changes to the alarm state.
PutMetricAlarmRequest.Builder	alarmActions(String... alarmActions)	The actions to execute when this alarm transitions to the ALARM state from any other 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	alarmDescription(String alarmDescription)	The description for the alarm.
PutMetricAlarmRequest.Builder	alarmName(String alarmName)	The name for the alarm.
PutMetricAlarmRequest.Builder	comparisonOperator(String comparisonOperator)	The arithmetic operation to use when comparing the specified statistic and threshold.
PutMetricAlarmRequest.Builder	comparisonOperator(ComparisonOperator comparisonOperator)	The arithmetic operation to use when comparing the specified statistic and threshold.
PutMetricAlarmRequest.Builder	dimensions(Collection<Dimension> dimensions)	The dimensions for the metric associated with the alarm.
PutMetricAlarmRequest.Builder	dimensions(Dimension... dimensions)	The dimensions for the metric associated with the alarm.
PutMetricAlarmRequest.Builder	evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)	Used only for alarms based on percentiles.
PutMetricAlarmRequest.Builder	evaluationPeriods(Integer evaluationPeriods)	The number of periods over which data is compared to the specified threshold.
PutMetricAlarmRequest.Builder	extendedStatistic(String extendedStatistic)	The percentile statistic for the metric associated with the alarm.
PutMetricAlarmRequest.Builder	insufficientDataActions(String... insufficientDataActions)	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
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	metricName(String metricName)	The name for the metric associated with the alarm.
PutMetricAlarmRequest.Builder	namespace(String namespace)	The namespace for the metric associated with the alarm.
PutMetricAlarmRequest.Builder	okActions(String... okActions)	The actions to execute when this alarm transitions to an OK state from any other state.
PutMetricAlarmRequest.Builder	okActions(Collection<String> okActions)	The actions to execute when this alarm transitions to an OK state from any other state.
PutMetricAlarmRequest.Builder	period(Integer period)	The period, in seconds, over which the specified statistic is applied.
PutMetricAlarmRequest.Builder	statistic(String statistic)	The statistic for the metric associated with the alarm, other than percentile.
PutMetricAlarmRequest.Builder	statistic(Statistic statistic)	The statistic for the metric associated with the alarm, other than percentile.
PutMetricAlarmRequest.Builder	threshold(Double threshold)	The value against which the specified statistic is compared.
PutMetricAlarmRequest.Builder	treatMissingData(String treatMissingData)	Sets how this alarm is to handle missing data points.
PutMetricAlarmRequest.Builder	unit(String unit)	The unit of measure for the statistic.
PutMetricAlarmRequest.Builder	unit(StandardUnit unit)	The unit of measure for the statistic.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

apply, build

Method Detail

alarmName

PutMetricAlarmRequest.Builder alarmName(String alarmName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

alarmDescription

PutMetricAlarmRequest.Builder alarmDescription(String alarmDescription)

The description for the alarm.

Parameters:

alarmDescription - The description for the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

actionsEnabled

PutMetricAlarmRequest.Builder actionsEnabled(Boolean actionsEnabled)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

okActions

PutMetricAlarmRequest.Builder okActions(Collection<String> okActions)

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

okActions

PutMetricAlarmRequest.Builder okActions(String... okActions)

The actions to execute when this alarm transitions to an OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

NOTE: This method appends the values to the existing list (if any). Use #setOKActions(java.util.Collection) or #withOKActions(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

alarmActions

PutMetricAlarmRequest.Builder alarmActions(Collection<String> alarmActions)

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

alarmActions

PutMetricAlarmRequest.Builder alarmActions(String... alarmActions)

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

NOTE: This method appends the values to the existing list (if any). Use #setAlarmActions(java.util.Collection) or #withAlarmActions(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

insufficientDataActions

PutMetricAlarmRequest.Builder insufficientDataActions(Collection<String> insufficientDataActions)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

insufficientDataActions

PutMetricAlarmRequest.Builder insufficientDataActions(String... insufficientDataActions)

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Valid Values: arn:aws:automate:region:ec2:stop | arn:aws:automate:region:ec2:terminate | arn:aws:automate:region:ec2:recover

Valid Values (for use with IAM roles): arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Stop/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Terminate/1.0 | arn:aws:swf:us-east-1:{customer-account}:action/actions/AWS_EC2.InstanceId.Reboot/1.0

NOTE: This method appends the values to the existing list (if any). Use #setInsufficientDataActions(java.util.Collection) or #withInsufficientDataActions(java.util.Collection) if you want to override the existing values.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

metricName

PutMetricAlarmRequest.Builder metricName(String metricName)

The name for the metric associated with the alarm.

Parameters:

metricName - The name for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

namespace

PutMetricAlarmRequest.Builder namespace(String namespace)

The namespace for the metric associated with the alarm.

Parameters:

namespace - The namespace for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistic

PutMetricAlarmRequest.Builder statistic(String statistic)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Statistic

statistic

PutMetricAlarmRequest.Builder statistic(Statistic statistic)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Statistic

extendedStatistic

PutMetricAlarmRequest.Builder extendedStatistic(String extendedStatistic)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

PutMetricAlarmRequest.Builder dimensions(Collection<Dimension> dimensions)

The dimensions for the metric associated with the alarm.

Parameters:

dimensions - The dimensions for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

dimensions

PutMetricAlarmRequest.Builder dimensions(Dimension... dimensions)

The dimensions for the metric associated with the alarm.

NOTE: This method appends the values to the existing list (if any). Use #setDimensions(java.util.Collection) or #withDimensions(java.util.Collection) if you want to override the existing values.

Parameters:

dimensions - The dimensions for the metric associated with the alarm.

Returns:

Returns a reference to this object so that method calls can be chained together.

period

PutMetricAlarmRequest.Builder period(Integer period)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

unit

PutMetricAlarmRequest.Builder unit(String unit)

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

StandardUnit

unit

PutMetricAlarmRequest.Builder unit(StandardUnit unit)

The unit of measure for the statistic. For example, the units for the Amazon EC2 NetworkIn metric are Bytes because NetworkIn tracks the number of bytes that an instance receives on all network interfaces. You can also specify a unit when you create a custom metric. Units help provide conceptual meaning to your data. Metric data points that specify a unit of measure, such as Percent, are aggregated separately.

If you specify a unit, you must use a unit that is appropriate for the metric. Otherwise, the Amazon CloudWatch alarm can get stuck in the INSUFFICIENT DATA state.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

StandardUnit

evaluationPeriods

PutMetricAlarmRequest.Builder evaluationPeriods(Integer evaluationPeriods)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

threshold

PutMetricAlarmRequest.Builder threshold(Double threshold)

The value against which the specified statistic is compared.

Parameters:

threshold - The value against which the specified statistic is compared.

Returns:

Returns a reference to this object so that method calls can be chained together.

comparisonOperator

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

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.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ComparisonOperator

treatMissingData

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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

evaluateLowSampleCountPercentile

PutMetricAlarmRequest.Builder evaluateLowSampleCountPercentile(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

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.