CloudWatchAlarmDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticmapreduce.model.CloudWatchAlarmDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CloudWatchAlarmDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
The definition of a CloudWatch metric alarm, which determines when an automatic scaling activity is triggered. When the defined alarm conditions are satisfied, scaling activity begins.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CloudWatchAlarmDefinition()

Constructors
Constructor and Description
`CloudWatchAlarmDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CloudWatchAlarmDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getComparisonOperator()` Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold`.
`List<MetricDimension>`	`getDimensions()` A CloudWatch metric dimension.
`Integer`	`getEvaluationPeriods()` The number of periods, expressed in seconds using `Period`, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
`String`	`getMetricName()` The name of the CloudWatch metric that is watched to determine an alarm condition.
`String`	`getNamespace()` The namespace for the CloudWatch metric.
`Integer`	`getPeriod()` The period, in seconds, over which the statistic is applied.
`String`	`getStatistic()` The statistic to apply to the metric associated with the alarm.
`Double`	`getThreshold()` The value against which the specified statistic is compared.
`String`	`getUnit()` The unit of measure associated with the CloudWatch metric being watched.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setComparisonOperator(ComparisonOperator comparisonOperator)` Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold`.
`void`	`setComparisonOperator(String comparisonOperator)` Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold`.
`void`	`setDimensions(Collection<MetricDimension> dimensions)` A CloudWatch metric dimension.
`void`	`setEvaluationPeriods(Integer evaluationPeriods)` The number of periods, expressed in seconds using `Period`, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
`void`	`setMetricName(String metricName)` The name of the CloudWatch metric that is watched to determine an alarm condition.
`void`	`setNamespace(String namespace)` The namespace for the CloudWatch metric.
`void`	`setPeriod(Integer period)` The period, in seconds, over which the statistic is applied.
`void`	`setStatistic(Statistic statistic)` The statistic to apply to the metric associated with the alarm.
`void`	`setStatistic(String statistic)` The statistic to apply to the metric associated with the alarm.
`void`	`setThreshold(Double threshold)` The value against which the specified statistic is compared.
`void`	`setUnit(String unit)` The unit of measure associated with the CloudWatch metric being watched.
`void`	`setUnit(Unit unit)` The unit of measure associated with the CloudWatch metric being watched.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`CloudWatchAlarmDefinition`	`withComparisonOperator(ComparisonOperator comparisonOperator)` Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold`.
`CloudWatchAlarmDefinition`	`withComparisonOperator(String comparisonOperator)` Determines how the metric specified by `MetricName` is compared to the value specified by `Threshold`.
`CloudWatchAlarmDefinition`	`withDimensions(Collection<MetricDimension> dimensions)` A CloudWatch metric dimension.
`CloudWatchAlarmDefinition`	`withDimensions(MetricDimension... dimensions)` A CloudWatch metric dimension.
`CloudWatchAlarmDefinition`	`withEvaluationPeriods(Integer evaluationPeriods)` The number of periods, expressed in seconds using `Period`, during which the alarm condition must exist before the alarm triggers automatic scaling activity.
`CloudWatchAlarmDefinition`	`withMetricName(String metricName)` The name of the CloudWatch metric that is watched to determine an alarm condition.
`CloudWatchAlarmDefinition`	`withNamespace(String namespace)` The namespace for the CloudWatch metric.
`CloudWatchAlarmDefinition`	`withPeriod(Integer period)` The period, in seconds, over which the statistic is applied.
`CloudWatchAlarmDefinition`	`withStatistic(Statistic statistic)` The statistic to apply to the metric associated with the alarm.
`CloudWatchAlarmDefinition`	`withStatistic(String statistic)` The statistic to apply to the metric associated with the alarm.
`CloudWatchAlarmDefinition`	`withThreshold(Double threshold)` The value against which the specified statistic is compared.
`CloudWatchAlarmDefinition`	`withUnit(String unit)` The unit of measure associated with the CloudWatch metric being watched.
`CloudWatchAlarmDefinition`	`withUnit(Unit unit)` The unit of measure associated with the CloudWatch metric being watched.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CloudWatchAlarmDefinition
```
public CloudWatchAlarmDefinition()
```
- Method Detail
  - setComparisonOperator
```
public void setComparisonOperator(String comparisonOperator)
```
    Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Parameters:
    
    comparisonOperator - Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    See Also:
    
    ComparisonOperator
  - getComparisonOperator
```
public String getComparisonOperator()
```
    Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Returns:
    
    Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public CloudWatchAlarmDefinition withComparisonOperator(String comparisonOperator)
```
    Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Parameters:
    
    comparisonOperator - Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - setComparisonOperator
```
public void setComparisonOperator(ComparisonOperator comparisonOperator)
```
    Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Parameters:
    
    comparisonOperator - Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public CloudWatchAlarmDefinition withComparisonOperator(ComparisonOperator comparisonOperator)
```
    Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Parameters:
    
    comparisonOperator - Determines how the metric specified by MetricName is compared to the value specified by Threshold.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - setEvaluationPeriods
```
public void setEvaluationPeriods(Integer evaluationPeriods)
```
    The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
    
    Parameters:
    
    evaluationPeriods - The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
  - getEvaluationPeriods
```
public Integer getEvaluationPeriods()
```
    The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
    
    Returns:
    
    The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
  - withEvaluationPeriods
```
public CloudWatchAlarmDefinition withEvaluationPeriods(Integer evaluationPeriods)
```
    The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
    
    Parameters:
    
    evaluationPeriods - The number of periods, expressed in seconds using Period, during which the alarm condition must exist before the alarm triggers automatic scaling activity. The default value is 1.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the CloudWatch metric that is watched to determine an alarm condition.
    
    Parameters:
    
    metricName - The name of the CloudWatch metric that is watched to determine an alarm condition.
  - getMetricName
```
public String getMetricName()
```
    The name of the CloudWatch metric that is watched to determine an alarm condition.
    
    Returns:
    
    The name of the CloudWatch metric that is watched to determine an alarm condition.
  - withMetricName
```
public CloudWatchAlarmDefinition withMetricName(String metricName)
```
    The name of the CloudWatch metric that is watched to determine an alarm condition.
    
    Parameters:
    
    metricName - The name of the CloudWatch metric that is watched to determine an alarm condition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamespace
```
public void setNamespace(String namespace)
```
    The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
    
    Parameters:
    
    namespace - The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
  - getNamespace
```
public String getNamespace()
```
    The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
    
    Returns:
    
    The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
  - withNamespace
```
public CloudWatchAlarmDefinition withNamespace(String namespace)
```
    The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
    
    Parameters:
    
    namespace - The namespace for the CloudWatch metric. The default is AWS/ElasticMapReduce.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPeriod
```
public void setPeriod(Integer period)
```
    The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
    
    Parameters:
    
    period - The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
  - getPeriod
```
public Integer getPeriod()
```
    The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
    
    Returns:
    
    The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
  - withPeriod
```
public CloudWatchAlarmDefinition withPeriod(Integer period)
```
    The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
    
    Parameters:
    
    period - The period, in seconds, over which the statistic is applied. EMR CloudWatch metrics are emitted every five minutes (300 seconds), so if an EMR CloudWatch metric is specified, specify 300.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatistic
```
public void setStatistic(String statistic)
```
    The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Parameters:
    
    statistic - The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    See Also:
    
    Statistic
  - getStatistic
```
public String getStatistic()
```
    The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Returns:
    
    The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    See Also:
    
    Statistic
  - withStatistic
```
public CloudWatchAlarmDefinition withStatistic(String statistic)
```
    The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Parameters:
    
    statistic - The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Statistic
  - setStatistic
```
public void setStatistic(Statistic statistic)
```
    The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Parameters:
    
    statistic - The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    See Also:
    
    Statistic
  - withStatistic
```
public CloudWatchAlarmDefinition withStatistic(Statistic statistic)
```
    The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Parameters:
    
    statistic - The statistic to apply to the metric associated with the alarm. The default is AVERAGE.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Statistic
  - 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.
  - getThreshold
```
public Double getThreshold()
```
    The value against which the specified statistic is compared.
    
    Returns:
    
    The value against which the specified statistic is compared.
  - withThreshold
```
public CloudWatchAlarmDefinition withThreshold(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.
  - setUnit
```
public void setUnit(String unit)
```
    The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Parameters:
    
    unit - The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    See Also:
    
    Unit
  - getUnit
```
public String getUnit()
```
    The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Returns:
    
    The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    See Also:
    
    Unit
  - withUnit
```
public CloudWatchAlarmDefinition withUnit(String unit)
```
    The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Parameters:
    
    unit - The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Unit
  - setUnit
```
public void setUnit(Unit unit)
```
    The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Parameters:
    
    unit - The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    See Also:
    
    Unit
  - withUnit
```
public CloudWatchAlarmDefinition withUnit(Unit unit)
```
    The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Parameters:
    
    unit - The unit of measure associated with the CloudWatch metric being watched. The value specified for Unit must correspond to the units specified in the CloudWatch metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Unit
  - getDimensions
```
public List<MetricDimension> getDimensions()
```
    A CloudWatch metric dimension.
    
    Returns:
    
    A CloudWatch metric dimension.
  - setDimensions
```
public void setDimensions(Collection<MetricDimension> dimensions)
```
    A CloudWatch metric dimension.
    
    Parameters:
    
    dimensions - A CloudWatch metric dimension.
  - withDimensions
```
public CloudWatchAlarmDefinition withDimensions(MetricDimension... dimensions)
```
    A CloudWatch metric dimension.
    
    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 - A CloudWatch metric dimension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDimensions
```
public CloudWatchAlarmDefinition withDimensions(Collection<MetricDimension> dimensions)
```
    A CloudWatch metric dimension.
    
    Parameters:
    
    dimensions - A CloudWatch metric dimension.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CloudWatchAlarmDefinition clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class CloudWatchAlarmDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CloudWatchAlarmDefinition

Method Detail

setComparisonOperator

getComparisonOperator

withComparisonOperator

setComparisonOperator

withComparisonOperator

setEvaluationPeriods

getEvaluationPeriods

withEvaluationPeriods

setMetricName

getMetricName

withMetricName

setNamespace

getNamespace

withNamespace

setPeriod

getPeriod

withPeriod

setStatistic

getStatistic

withStatistic

setStatistic

withStatistic

setThreshold

getThreshold

withThreshold

setUnit

getUnit

withUnit

setUnit

withUnit

getDimensions

setDimensions

withDimensions

withDimensions

toString

equals

hashCode

clone

marshall