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

Interface MetricAlarm.Builder

All Superinterfaces:

CopyableBuilder<MetricAlarm.Builder,MetricAlarm>, SdkBuilder<MetricAlarm.Builder,MetricAlarm>

Enclosing class:

MetricAlarm

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

Method Summary

Modifier and Type	Method	Description
MetricAlarm.Builder	actionsEnabled(Boolean actionsEnabled)	Indicates whether actions should be executed during any changes to the alarm state.
MetricAlarm.Builder	alarmActions(String... alarmActions)	The actions to execute when this alarm transitions to the ALARM state from any other state.
MetricAlarm.Builder	alarmActions(Collection<String> alarmActions)	The actions to execute when this alarm transitions to the ALARM state from any other state.
MetricAlarm.Builder	alarmArn(String alarmArn)	The Amazon Resource Name (ARN) of the alarm.
MetricAlarm.Builder	alarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)	The time stamp of the last update to the alarm configuration.
MetricAlarm.Builder	alarmDescription(String alarmDescription)	The description of the alarm.
MetricAlarm.Builder	alarmName(String alarmName)	The name of the alarm.
MetricAlarm.Builder	comparisonOperator(String comparisonOperator)	The arithmetic operation to use when comparing the specified statistic and threshold.
MetricAlarm.Builder	comparisonOperator(ComparisonOperator comparisonOperator)	The arithmetic operation to use when comparing the specified statistic and threshold.
MetricAlarm.Builder	dimensions(Collection<Dimension> dimensions)	The dimensions for the metric associated with the alarm.
MetricAlarm.Builder	dimensions(Dimension... dimensions)	The dimensions for the metric associated with the alarm.
MetricAlarm.Builder	evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)
MetricAlarm.Builder	evaluationPeriods(Integer evaluationPeriods)	The number of periods over which data is compared to the specified threshold.
MetricAlarm.Builder	extendedStatistic(String extendedStatistic)	The percentile statistic for the metric associated with the alarm.
MetricAlarm.Builder	insufficientDataActions(String... insufficientDataActions)	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
MetricAlarm.Builder	insufficientDataActions(Collection<String> insufficientDataActions)	The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
MetricAlarm.Builder	metricName(String metricName)	The name of the metric associated with the alarm.
MetricAlarm.Builder	namespace(String namespace)	The namespace of the metric associated with the alarm.
MetricAlarm.Builder	okActions(String... okActions)	The actions to execute when this alarm transitions to the OK state from any other state.
MetricAlarm.Builder	okActions(Collection<String> okActions)	The actions to execute when this alarm transitions to the OK state from any other state.
MetricAlarm.Builder	period(Integer period)	The period, in seconds, over which the statistic is applied.
MetricAlarm.Builder	stateReason(String stateReason)	An explanation for the alarm state, in text format.
MetricAlarm.Builder	stateReasonData(String stateReasonData)	An explanation for the alarm state, in JSON format.
MetricAlarm.Builder	stateUpdatedTimestamp(Date stateUpdatedTimestamp)	The time stamp of the last update to the alarm state.
MetricAlarm.Builder	stateValue(String stateValue)	The state value for the alarm.
MetricAlarm.Builder	stateValue(StateValue stateValue)	The state value for the alarm.
MetricAlarm.Builder	statistic(String statistic)	The statistic for the metric associated with the alarm, other than percentile.
MetricAlarm.Builder	statistic(Statistic statistic)	The statistic for the metric associated with the alarm, other than percentile.
MetricAlarm.Builder	threshold(Double threshold)	The value to compare with the specified statistic.
MetricAlarm.Builder	treatMissingData(String treatMissingData)
MetricAlarm.Builder	unit(String unit)	The unit of the metric associated with the alarm.
MetricAlarm.Builder	unit(StandardUnit unit)	The unit of the metric associated with the alarm.

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

MetricAlarm.Builder alarmName(String alarmName)

The name of the alarm.

Parameters:

alarmName - The name of the alarm.

Returns:

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

alarmArn

MetricAlarm.Builder alarmArn(String alarmArn)

The Amazon Resource Name (ARN) of the alarm.

Parameters:

alarmArn - The Amazon Resource Name (ARN) of the alarm.

Returns:

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

alarmDescription

MetricAlarm.Builder alarmDescription(String alarmDescription)

The description of the alarm.

Parameters:

alarmDescription - The description of the alarm.

Returns:

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

alarmConfigurationUpdatedTimestamp

MetricAlarm.Builder alarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)

The time stamp of the last update to the alarm configuration.

Parameters:

alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.

Returns:

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

actionsEnabled

MetricAlarm.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

MetricAlarm.Builder okActions(Collection<String> okActions)

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

Parameters:

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

Returns:

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

okActions

MetricAlarm.Builder okActions(String... okActions)

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

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 the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Returns:

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

alarmActions

MetricAlarm.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).

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).

Returns:

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

alarmActions

MetricAlarm.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).

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).

Returns:

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

insufficientDataActions

MetricAlarm.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).

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).

Returns:

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

insufficientDataActions

MetricAlarm.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).

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).

Returns:

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

stateValue

MetricAlarm.Builder stateValue(String stateValue)

The state value for the alarm.

Parameters:

stateValue - The state value for the alarm.

Returns:

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

See Also:

StateValue

stateValue

MetricAlarm.Builder stateValue(StateValue stateValue)

The state value for the alarm.

Parameters:

stateValue - The state value for the alarm.

Returns:

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

See Also:

StateValue

stateReason

MetricAlarm.Builder stateReason(String stateReason)

An explanation for the alarm state, in text format.

Parameters:

stateReason - An explanation for the alarm state, in text format.

Returns:

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

stateReasonData

MetricAlarm.Builder stateReasonData(String stateReasonData)

An explanation for the alarm state, in JSON format.

Parameters:

stateReasonData - An explanation for the alarm state, in JSON format.

Returns:

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

stateUpdatedTimestamp

MetricAlarm.Builder stateUpdatedTimestamp(Date stateUpdatedTimestamp)

The time stamp of the last update to the alarm state.

Parameters:

stateUpdatedTimestamp - The time stamp of the last update to the alarm state.

Returns:

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

metricName

MetricAlarm.Builder metricName(String metricName)

The name of the metric associated with the alarm.

Parameters:

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

Returns:

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

namespace

MetricAlarm.Builder namespace(String namespace)

The namespace of the metric associated with the alarm.

Parameters:

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

Returns:

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

statistic

MetricAlarm.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

MetricAlarm.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

MetricAlarm.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

MetricAlarm.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

MetricAlarm.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

MetricAlarm.Builder period(Integer period)

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

Parameters:

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

Returns:

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

unit

MetricAlarm.Builder unit(String unit)

The unit of the metric associated with the alarm.

Parameters:

unit - The unit of the metric associated with the alarm.

Returns:

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

See Also:

StandardUnit

unit

MetricAlarm.Builder unit(StandardUnit unit)

The unit of the metric associated with the alarm.

Parameters:

unit - The unit of the metric associated with the alarm.

Returns:

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

See Also:

StandardUnit

evaluationPeriods

MetricAlarm.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

MetricAlarm.Builder threshold(Double threshold)

The value to compare with the specified statistic.

Parameters:

threshold - The value to compare with the specified statistic.

Returns:

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

comparisonOperator

MetricAlarm.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

MetricAlarm.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

MetricAlarm.Builder treatMissingData(String treatMissingData)

Parameters:

treatMissingData -

Returns:

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

evaluateLowSampleCountPercentile

MetricAlarm.Builder evaluateLowSampleCountPercentile(String evaluateLowSampleCountPercentile)

Parameters:

evaluateLowSampleCountPercentile -

Returns:

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