com.amazonaws.services.cloudwatch.model
Class MetricAlarm

java.lang.Object
  com.amazonaws.services.cloudwatch.model.MetricAlarm

public class MetricAlarm
extends Object

The MetricAlarm data type represents an alarm. You can use PutMetricAlarm to create or update an alarm.

Constructor Summary

MetricAlarm()

Method Summary

boolean	equals(Object obj)
Boolean	getActionsEnabled() Indicates whether actions should be executed during any changes to the alarm's state.
List<String>	getAlarmActions() The list of actions to execute when this alarm transitions into an ALARM state from any other state.
String	getAlarmArn() The Amazon Resource Name (ARN) of the alarm.
Date	getAlarmConfigurationUpdatedTimestamp() The time stamp of the last update to the alarm configuration.
String	getAlarmDescription() The description for the alarm.
String	getAlarmName() The name of the alarm.
String	getComparisonOperator() The arithmetic operation to use when comparing the specified Statistic and Threshold.
List<Dimension>	getDimensions() The list of dimensions associated with the alarm's associated metric.
Integer	getEvaluationPeriods() The number of periods over which data is compared to the specified threshold.
List<String>	getInsufficientDataActions() The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.
String	getMetricName() The name of the alarm's metric.
String	getNamespace() The namespace of alarm's associated metric.
List<String>	getOKActions() The list of actions to execute when this alarm transitions into an OK state from any other state.
Integer	getPeriod() The period in seconds over which the statistic is applied.
String	getStateReason() A human-readable explanation for the alarm's state.
String	getStateReasonData() An explanation for the alarm's state in machine-readable JSON format
Date	getStateUpdatedTimestamp() The time stamp of the last update to the alarm's state.
String	getStateValue() The state value for the alarm.
String	getStatistic() The statistic to apply to the alarm's associated metric.
Double	getThreshold() The value against which the specified statistic is compared.
String	getUnit() The unit of the alarm's associated metric.
int	hashCode()
Boolean	isActionsEnabled() Indicates whether actions should be executed during any changes to the alarm's state.
void	setActionsEnabled(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm's state.
void	setAlarmActions(Collection<String> alarmActions) The list of actions to execute when this alarm transitions into an ALARM state from any other state.
void	setAlarmArn(String alarmArn) The Amazon Resource Name (ARN) of the alarm.
void	setAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp) The time stamp of the last update to the alarm configuration.
void	setAlarmDescription(String alarmDescription) The description for the alarm.
void	setAlarmName(String alarmName) The name of the alarm.
void	setComparisonOperator(ComparisonOperator comparisonOperator) The arithmetic operation to use when comparing the specified Statistic and Threshold.
void	setComparisonOperator(String comparisonOperator) The arithmetic operation to use when comparing the specified Statistic and Threshold.
void	setDimensions(Collection<Dimension> dimensions) The list of dimensions associated with the alarm's associated metric.
void	setEvaluationPeriods(Integer evaluationPeriods) The number of periods over which data is compared to the specified threshold.
void	setInsufficientDataActions(Collection<String> insufficientDataActions) The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.
void	setMetricName(String metricName) The name of the alarm's metric.
void	setNamespace(String namespace) The namespace of alarm's associated metric.
void	setOKActions(Collection<String> oKActions) The list of actions to execute when this alarm transitions into an OK state from any other state.
void	setPeriod(Integer period) The period in seconds over which the statistic is applied.
void	setStateReason(String stateReason) A human-readable explanation for the alarm's state.
void	setStateReasonData(String stateReasonData) An explanation for the alarm's state in machine-readable JSON format
void	setStateUpdatedTimestamp(Date stateUpdatedTimestamp) The time stamp of the last update to the alarm's state.
void	setStateValue(StateValue stateValue) The state value for the alarm.
void	setStateValue(String stateValue) The state value for the alarm.
void	setStatistic(Statistic statistic) The statistic to apply to the alarm's associated metric.
void	setStatistic(String statistic) The statistic to apply to the alarm's associated metric.
void	setThreshold(Double threshold) The value against which the specified statistic is compared.
void	setUnit(StandardUnit unit) The unit of the alarm's associated metric.
void	setUnit(String unit) The unit of the alarm's associated metric.
String	toString() Returns a string representation of this object; useful for testing and debugging.
MetricAlarm	withActionsEnabled(Boolean actionsEnabled) Indicates whether actions should be executed during any changes to the alarm's state.
MetricAlarm	withAlarmActions(Collection<String> alarmActions) The list of actions to execute when this alarm transitions into an ALARM state from any other state.
MetricAlarm	withAlarmActions(String... alarmActions) The list of actions to execute when this alarm transitions into an ALARM state from any other state.
MetricAlarm	withAlarmArn(String alarmArn) The Amazon Resource Name (ARN) of the alarm.
MetricAlarm	withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp) The time stamp of the last update to the alarm configuration.
MetricAlarm	withAlarmDescription(String alarmDescription) The description for the alarm.
MetricAlarm	withAlarmName(String alarmName) The name of the alarm.
MetricAlarm	withComparisonOperator(ComparisonOperator comparisonOperator) The arithmetic operation to use when comparing the specified Statistic and Threshold.
MetricAlarm	withComparisonOperator(String comparisonOperator) The arithmetic operation to use when comparing the specified Statistic and Threshold.
MetricAlarm	withDimensions(Collection<Dimension> dimensions) The list of dimensions associated with the alarm's associated metric.
MetricAlarm	withDimensions(Dimension... dimensions) The list of dimensions associated with the alarm's associated metric.
MetricAlarm	withEvaluationPeriods(Integer evaluationPeriods) The number of periods over which data is compared to the specified threshold.
MetricAlarm	withInsufficientDataActions(Collection<String> insufficientDataActions) The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.
MetricAlarm	withInsufficientDataActions(String... insufficientDataActions) The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state.
MetricAlarm	withMetricName(String metricName) The name of the alarm's metric.
MetricAlarm	withNamespace(String namespace) The namespace of alarm's associated metric.
MetricAlarm	withOKActions(Collection<String> oKActions) The list of actions to execute when this alarm transitions into an OK state from any other state.
MetricAlarm	withOKActions(String... oKActions) The list of actions to execute when this alarm transitions into an OK state from any other state.
MetricAlarm	withPeriod(Integer period) The period in seconds over which the statistic is applied.
MetricAlarm	withStateReason(String stateReason) A human-readable explanation for the alarm's state.
MetricAlarm	withStateReasonData(String stateReasonData) An explanation for the alarm's state in machine-readable JSON format
MetricAlarm	withStateUpdatedTimestamp(Date stateUpdatedTimestamp) The time stamp of the last update to the alarm's state.
MetricAlarm	withStateValue(StateValue stateValue) The state value for the alarm.
MetricAlarm	withStateValue(String stateValue) The state value for the alarm.
MetricAlarm	withStatistic(Statistic statistic) The statistic to apply to the alarm's associated metric.
MetricAlarm	withStatistic(String statistic) The statistic to apply to the alarm's associated metric.
MetricAlarm	withThreshold(Double threshold) The value against which the specified statistic is compared.
MetricAlarm	withUnit(StandardUnit unit) The unit of the alarm's associated metric.
MetricAlarm	withUnit(String unit) The unit of the alarm's associated metric.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MetricAlarm

public MetricAlarm()

Method Detail

getAlarmName

public String getAlarmName()

The name of the alarm.

Constraints:
Length: 1 - 255

Returns:

The name of the alarm.

setAlarmName

public void setAlarmName(String alarmName)

The name of the alarm.

Constraints:
Length: 1 - 255

Parameters:

alarmName - The name of the alarm.

withAlarmName

public MetricAlarm withAlarmName(String alarmName)

The name of the alarm.

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

Constraints:
Length: 1 - 255

Parameters:

alarmName - The name of the alarm.

Returns:

A reference to this updated object so that method calls can be chained together.

getAlarmArn

public String getAlarmArn()

The Amazon Resource Name (ARN) of the alarm.

Constraints:
Length: 1 - 1600

Returns:

The Amazon Resource Name (ARN) of the alarm.

setAlarmArn

public void setAlarmArn(String alarmArn)

The Amazon Resource Name (ARN) of the alarm.

Constraints:
Length: 1 - 1600

Parameters:

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

withAlarmArn

public MetricAlarm withAlarmArn(String alarmArn)

The Amazon Resource Name (ARN) of the alarm.

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

Constraints:
Length: 1 - 1600

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getAlarmDescription

public String getAlarmDescription()

The description for the alarm.

Constraints:
Length: 0 - 255

Returns:

The description for the alarm.

setAlarmDescription

public void setAlarmDescription(String alarmDescription)

The description for the alarm.

Constraints:
Length: 0 - 255

Parameters:

alarmDescription - The description for the alarm.

withAlarmDescription

public MetricAlarm withAlarmDescription(String alarmDescription)

The description for the alarm.

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

Constraints:
Length: 0 - 255

Parameters:

alarmDescription - The description for the alarm.

Returns:

A reference to this updated object so that method calls can be chained together.

getAlarmConfigurationUpdatedTimestamp

public Date getAlarmConfigurationUpdatedTimestamp()

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

Returns:

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

setAlarmConfigurationUpdatedTimestamp

public void setAlarmConfigurationUpdatedTimestamp(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.

withAlarmConfigurationUpdatedTimestamp

public MetricAlarm withAlarmConfigurationUpdatedTimestamp(Date alarmConfigurationUpdatedTimestamp)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

isActionsEnabled

public Boolean isActionsEnabled()

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

Returns:

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

setActionsEnabled

public void setActionsEnabled(Boolean actionsEnabled)

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

Parameters:

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

withActionsEnabled

public MetricAlarm withActionsEnabled(Boolean actionsEnabled)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getActionsEnabled

public Boolean getActionsEnabled()

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

Returns:

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

getOKActions

public List<String> getOKActions()

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

Returns:

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

setOKActions

public void setOKActions(Collection<String> oKActions)

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

Parameters:

oKActions - The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

withOKActions

public MetricAlarm withOKActions(String... oKActions)

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

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

Constraints:
Length: 0 - 5

Parameters:

oKActions - The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Returns:

A reference to this updated object so that method calls can be chained together.

withOKActions

public MetricAlarm withOKActions(Collection<String> oKActions)

The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

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

Constraints:
Length: 0 - 5

Parameters:

oKActions - The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Returns:

A reference to this updated object so that method calls can be chained together.

getAlarmActions

public List<String> getAlarmActions()

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

Returns:

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

setAlarmActions

public void setAlarmActions(Collection<String> alarmActions)

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

Parameters:

alarmActions - The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

withAlarmActions

public MetricAlarm withAlarmActions(String... alarmActions)

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

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

Constraints:
Length: 0 - 5

Parameters:

alarmActions - The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Returns:

A reference to this updated object so that method calls can be chained together.

withAlarmActions

public MetricAlarm withAlarmActions(Collection<String> alarmActions)

The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

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

Constraints:
Length: 0 - 5

Parameters:

alarmActions - The list of actions to execute when this alarm transitions into an ALARM state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic and triggering an Auto Scaling policy.

Returns:

A reference to this updated object so that method calls can be chained together.

getInsufficientDataActions

public List<String> getInsufficientDataActions()

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

Returns:

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

setInsufficientDataActions

public void setInsufficientDataActions(Collection<String> insufficientDataActions)

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

Constraints:
Length: 0 - 5

Parameters:

insufficientDataActions - The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

withInsufficientDataActions

public MetricAlarm withInsufficientDataActions(String... insufficientDataActions)

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

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

Constraints:
Length: 0 - 5

Parameters:

insufficientDataActions - The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

Returns:

A reference to this updated object so that method calls can be chained together.

withInsufficientDataActions

public MetricAlarm withInsufficientDataActions(Collection<String> insufficientDataActions)

The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

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

Constraints:
Length: 0 - 5

Parameters:

insufficientDataActions - The list of actions to execute when this alarm transitions into an INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Number (ARN). Currently the only actions supported are publishing to an Amazon SNS topic or triggering an Auto Scaling policy.

Returns:

A reference to this updated object so that method calls can be chained together.

getStateValue

public String getStateValue()

The state value for the alarm.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Returns:

The state value for the alarm.

See Also:

StateValue

setStateValue

public void setStateValue(String stateValue)

The state value for the alarm.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Parameters:

stateValue - The state value for the alarm.

See Also:

StateValue

withStateValue

public MetricAlarm withStateValue(String stateValue)

The state value for the alarm.

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

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Parameters:

stateValue - The state value for the alarm.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StateValue

setStateValue

public void setStateValue(StateValue stateValue)

The state value for the alarm.

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Parameters:

stateValue - The state value for the alarm.

See Also:

StateValue

withStateValue

public MetricAlarm withStateValue(StateValue stateValue)

The state value for the alarm.

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

Constraints:
Allowed Values: OK, ALARM, INSUFFICIENT_DATA

Parameters:

stateValue - The state value for the alarm.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StateValue

getStateReason

public String getStateReason()

A human-readable explanation for the alarm's state.

Constraints:
Length: 0 - 1023

Returns:

A human-readable explanation for the alarm's state.

setStateReason

public void setStateReason(String stateReason)

A human-readable explanation for the alarm's state.

Constraints:
Length: 0 - 1023

Parameters:

stateReason - A human-readable explanation for the alarm's state.

withStateReason

public MetricAlarm withStateReason(String stateReason)

A human-readable explanation for the alarm's state.

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

Constraints:
Length: 0 - 1023

Parameters:

stateReason - A human-readable explanation for the alarm's state.

Returns:

A reference to this updated object so that method calls can be chained together.

getStateReasonData

public String getStateReasonData()

An explanation for the alarm's state in machine-readable JSON format

Constraints:
Length: 0 - 4000

Returns:

An explanation for the alarm's state in machine-readable JSON format

setStateReasonData

public void setStateReasonData(String stateReasonData)

An explanation for the alarm's state in machine-readable JSON format

Constraints:
Length: 0 - 4000

Parameters:

stateReasonData - An explanation for the alarm's state in machine-readable JSON format

withStateReasonData

public MetricAlarm withStateReasonData(String stateReasonData)

An explanation for the alarm's state in machine-readable JSON format

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

Constraints:
Length: 0 - 4000

Parameters:

stateReasonData - An explanation for the alarm's state in machine-readable JSON format

Returns:

A reference to this updated object so that method calls can be chained together.

getStateUpdatedTimestamp

public Date getStateUpdatedTimestamp()

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

Returns:

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

setStateUpdatedTimestamp

public void setStateUpdatedTimestamp(Date stateUpdatedTimestamp)

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

Parameters:

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

withStateUpdatedTimestamp

public MetricAlarm withStateUpdatedTimestamp(Date stateUpdatedTimestamp)

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

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMetricName

public String getMetricName()

The name of the alarm's metric.

Constraints:
Length: 1 - 255

Returns:

The name of the alarm's metric.

setMetricName

public void setMetricName(String metricName)

The name of the alarm's metric.

Constraints:
Length: 1 - 255

Parameters:

metricName - The name of the alarm's metric.

withMetricName

public MetricAlarm withMetricName(String metricName)

The name of the alarm's metric.

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

Constraints:
Length: 1 - 255

Parameters:

metricName - The name of the alarm's metric.

Returns:

A reference to this updated object so that method calls can be chained together.

getNamespace

public String getNamespace()

The namespace of alarm's associated metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Returns:

The namespace of alarm's associated metric.

setNamespace

public void setNamespace(String namespace)

The namespace of alarm's associated metric.

Constraints:
Length: 1 - 255
Pattern: [^:].*

Parameters:

namespace - The namespace of alarm's associated metric.

withNamespace

public MetricAlarm withNamespace(String namespace)

The namespace of alarm's associated metric.

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

Constraints:
Length: 1 - 255
Pattern: [^:].*

Parameters:

namespace - The namespace of alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

getStatistic

public String getStatistic()

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Returns:

The statistic to apply to the alarm's associated metric.

See Also:

Statistic

setStatistic

public void setStatistic(String statistic)

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic to apply to the alarm's associated metric.

See Also:

Statistic

withStatistic

public MetricAlarm withStatistic(String statistic)

The statistic to apply to the alarm's associated metric.

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

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic to apply to the alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Statistic

setStatistic

public void setStatistic(Statistic statistic)

The statistic to apply to the alarm's associated metric.

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic to apply to the alarm's associated metric.

See Also:

Statistic

withStatistic

public MetricAlarm withStatistic(Statistic statistic)

The statistic to apply to the alarm's associated metric.

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

Constraints:
Allowed Values: SampleCount, Average, Sum, Minimum, Maximum

Parameters:

statistic - The statistic to apply to the alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

Statistic

getDimensions

public List<Dimension> getDimensions()

The list of dimensions associated with the alarm's associated metric.

Constraints:
Length: 0 - 10

Returns:

The list of dimensions associated with the alarm's associated metric.

setDimensions

public void setDimensions(Collection<Dimension> dimensions)

The list of dimensions associated with the alarm's associated metric.

Constraints:
Length: 0 - 10

Parameters:

dimensions - The list of dimensions associated with the alarm's associated metric.

withDimensions

public MetricAlarm withDimensions(Dimension... dimensions)

The list of dimensions associated with the alarm's associated metric.

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

Constraints:
Length: 0 - 10

Parameters:

dimensions - The list of dimensions associated with the alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

withDimensions

public MetricAlarm withDimensions(Collection<Dimension> dimensions)

The list of dimensions associated with the alarm's associated metric.

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

Constraints:
Length: 0 - 10

Parameters:

dimensions - The list of dimensions associated with the alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

getPeriod

public Integer getPeriod()

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

Returns:

The period in seconds over which the statistic is applied.

setPeriod

public void setPeriod(Integer period)

The period in seconds over which the statistic is applied.

Constraints:
Range: 60 -

Parameters:

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

withPeriod

public MetricAlarm withPeriod(Integer period)

The period in seconds over which the statistic is applied.

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

Constraints:
Range: 60 -

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getUnit

public String getUnit()

The unit of the alarm's associated metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Returns:

The unit of the alarm's associated metric.

See Also:

StandardUnit

setUnit

public void setUnit(String unit)

The unit of the alarm's associated metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Parameters:

unit - The unit of the alarm's associated metric.

See Also:

StandardUnit

withUnit

public MetricAlarm withUnit(String unit)

The unit of the alarm's associated metric.

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

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Parameters:

unit - The unit of the alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StandardUnit

setUnit

public void setUnit(StandardUnit unit)

The unit of the alarm's associated metric.

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Parameters:

unit - The unit of the alarm's associated metric.

See Also:

StandardUnit

withUnit

public MetricAlarm withUnit(StandardUnit unit)

The unit of the alarm's associated metric.

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

Constraints:
Allowed Values: Seconds, Microseconds, Milliseconds, Bytes, Kilobytes, Megabytes, Gigabytes, Terabytes, Bits, Kilobits, Megabits, Gigabits, Terabits, Percent, Count, Bytes/Second, Kilobytes/Second, Megabytes/Second, Gigabytes/Second, Terabytes/Second, Bits/Second, Kilobits/Second, Megabits/Second, Gigabits/Second, Terabits/Second, Count/Second, None

Parameters:

unit - The unit of the alarm's associated metric.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

StandardUnit

getEvaluationPeriods

public Integer getEvaluationPeriods()

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

Constraints:
Range: 1 -

Returns:

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

setEvaluationPeriods

public void setEvaluationPeriods(Integer evaluationPeriods)

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

Constraints:
Range: 1 -

Parameters:

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

withEvaluationPeriods

public MetricAlarm withEvaluationPeriods(Integer evaluationPeriods)

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

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

Constraints:
Range: 1 -

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getThreshold

public Double getThreshold()

The value against which the specified statistic is compared.

Returns:

The value against which the specified statistic is compared.

setThreshold

public void setThreshold(Double threshold)

The value against which the specified statistic is compared.

Parameters:

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

withThreshold

public MetricAlarm withThreshold(Double threshold)

The value against which the specified statistic is compared.

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

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getComparisonOperator

public String getComparisonOperator()

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

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

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

setComparisonOperator

public void setComparisonOperator(String comparisonOperator)

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

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

Parameters:

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

withComparisonOperator

public MetricAlarm withComparisonOperator(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 a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ComparisonOperator

setComparisonOperator

public void setComparisonOperator(ComparisonOperator comparisonOperator)

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

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

Parameters:

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

withComparisonOperator

public MetricAlarm withComparisonOperator(ComparisonOperator comparisonOperator)

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

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

Constraints:
Allowed Values: GreaterThanOrEqualToThreshold, GreaterThanThreshold, LessThanThreshold, LessThanOrEqualToThreshold

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:

A reference to this updated object so that method calls can be chained together.

See Also:

ComparisonOperator

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object