Alarm (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.lightsail.model.Alarm

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Alarm
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an alarm.

An alarm is a way to monitor your Lightsail resource metrics. For more information, see Alarms in Amazon Lightsail.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Alarm()

Constructors
Constructor and Description
`Alarm()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Alarm`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon Resource Name (ARN) of the alarm.
`String`	`getComparisonOperator()` The arithmetic operation used when comparing the specified statistic and threshold.
`List<String>`	`getContactProtocols()` The contact protocols for the alarm, such as `Email`, `SMS` (text messaging), or both.
`Date`	`getCreatedAt()` The timestamp when the alarm was created.
`Integer`	`getDatapointsToAlarm()` The number of data points that must not within the specified threshold to trigger the alarm.
`Integer`	`getEvaluationPeriods()` The number of periods over which data is compared to the specified threshold.
`ResourceLocation`	`getLocation()` An object that lists information about the location of the alarm.
`String`	`getMetricName()` The name of the metric associated with the alarm.
`MonitoredResourceInfo`	`getMonitoredResourceInfo()` An object that lists information about the resource monitored by the alarm.
`String`	`getName()` The name of the alarm.
`Boolean`	`getNotificationEnabled()` Indicates whether the alarm is enabled.
`List<String>`	`getNotificationTriggers()` The alarm states that trigger a notification.
`Integer`	`getPeriod()` The period, in seconds, over which the statistic is applied.
`String`	`getResourceType()` The Lightsail resource type of the alarm.
`String`	`getState()` The current state of the alarm.
`String`	`getStatistic()` The statistic for the metric associated with the alarm.
`String`	`getSupportCode()` The support code.
`Double`	`getThreshold()` The value against which the specified statistic is compared.
`String`	`getTreatMissingData()` Specifies how the alarm handles missing data points.
`String`	`getUnit()` The unit of the metric associated with the alarm.
`int`	`hashCode()`
`Boolean`	`isNotificationEnabled()` Indicates whether the alarm is enabled.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setArn(String arn)` The Amazon Resource Name (ARN) of the alarm.
`void`	`setComparisonOperator(String comparisonOperator)` The arithmetic operation used when comparing the specified statistic and threshold.
`void`	`setContactProtocols(Collection<String> contactProtocols)` The contact protocols for the alarm, such as `Email`, `SMS` (text messaging), or both.
`void`	`setCreatedAt(Date createdAt)` The timestamp when the alarm was created.
`void`	`setDatapointsToAlarm(Integer datapointsToAlarm)` The number of data points that must not within the specified threshold to trigger the alarm.
`void`	`setEvaluationPeriods(Integer evaluationPeriods)` The number of periods over which data is compared to the specified threshold.
`void`	`setLocation(ResourceLocation location)` An object that lists information about the location of the alarm.
`void`	`setMetricName(String metricName)` The name of the metric associated with the alarm.
`void`	`setMonitoredResourceInfo(MonitoredResourceInfo monitoredResourceInfo)` An object that lists information about the resource monitored by the alarm.
`void`	`setName(String name)` The name of the alarm.
`void`	`setNotificationEnabled(Boolean notificationEnabled)` Indicates whether the alarm is enabled.
`void`	`setNotificationTriggers(Collection<String> notificationTriggers)` The alarm states that trigger a notification.
`void`	`setPeriod(Integer period)` The period, in seconds, over which the statistic is applied.
`void`	`setResourceType(String resourceType)` The Lightsail resource type of the alarm.
`void`	`setState(String state)` The current state of the alarm.
`void`	`setStatistic(String statistic)` The statistic for the metric associated with the alarm.
`void`	`setSupportCode(String supportCode)` The support code.
`void`	`setThreshold(Double threshold)` The value against which the specified statistic is compared.
`void`	`setTreatMissingData(String treatMissingData)` Specifies how the alarm handles missing data points.
`void`	`setUnit(String unit)` The unit of the metric associated with the alarm.
`String`	`toString()` Returns a string representation of this object.
`Alarm`	`withArn(String arn)` The Amazon Resource Name (ARN) of the alarm.
`Alarm`	`withComparisonOperator(ComparisonOperator comparisonOperator)` The arithmetic operation used when comparing the specified statistic and threshold.
`Alarm`	`withComparisonOperator(String comparisonOperator)` The arithmetic operation used when comparing the specified statistic and threshold.
`Alarm`	`withContactProtocols(Collection<String> contactProtocols)` The contact protocols for the alarm, such as `Email`, `SMS` (text messaging), or both.
`Alarm`	`withContactProtocols(ContactProtocol... contactProtocols)` The contact protocols for the alarm, such as `Email`, `SMS` (text messaging), or both.
`Alarm`	`withContactProtocols(String... contactProtocols)` The contact protocols for the alarm, such as `Email`, `SMS` (text messaging), or both.
`Alarm`	`withCreatedAt(Date createdAt)` The timestamp when the alarm was created.
`Alarm`	`withDatapointsToAlarm(Integer datapointsToAlarm)` The number of data points that must not within the specified threshold to trigger the alarm.
`Alarm`	`withEvaluationPeriods(Integer evaluationPeriods)` The number of periods over which data is compared to the specified threshold.
`Alarm`	`withLocation(ResourceLocation location)` An object that lists information about the location of the alarm.
`Alarm`	`withMetricName(MetricName metricName)` The name of the metric associated with the alarm.
`Alarm`	`withMetricName(String metricName)` The name of the metric associated with the alarm.
`Alarm`	`withMonitoredResourceInfo(MonitoredResourceInfo monitoredResourceInfo)` An object that lists information about the resource monitored by the alarm.
`Alarm`	`withName(String name)` The name of the alarm.
`Alarm`	`withNotificationEnabled(Boolean notificationEnabled)` Indicates whether the alarm is enabled.
`Alarm`	`withNotificationTriggers(AlarmState... notificationTriggers)` The alarm states that trigger a notification.
`Alarm`	`withNotificationTriggers(Collection<String> notificationTriggers)` The alarm states that trigger a notification.
`Alarm`	`withNotificationTriggers(String... notificationTriggers)` The alarm states that trigger a notification.
`Alarm`	`withPeriod(Integer period)` The period, in seconds, over which the statistic is applied.
`Alarm`	`withResourceType(ResourceType resourceType)` The Lightsail resource type of the alarm.
`Alarm`	`withResourceType(String resourceType)` The Lightsail resource type of the alarm.
`Alarm`	`withState(AlarmState state)` The current state of the alarm.
`Alarm`	`withState(String state)` The current state of the alarm.
`Alarm`	`withStatistic(MetricStatistic statistic)` The statistic for the metric associated with the alarm.
`Alarm`	`withStatistic(String statistic)` The statistic for the metric associated with the alarm.
`Alarm`	`withSupportCode(String supportCode)` The support code.
`Alarm`	`withThreshold(Double threshold)` The value against which the specified statistic is compared.
`Alarm`	`withTreatMissingData(String treatMissingData)` Specifies how the alarm handles missing data points.
`Alarm`	`withTreatMissingData(TreatMissingData treatMissingData)` Specifies how the alarm handles missing data points.
`Alarm`	`withUnit(MetricUnit unit)` The unit of the metric associated with the alarm.
`Alarm`	`withUnit(String unit)` The unit of the metric associated with the alarm.

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

- Constructor Detail
  - Alarm
```
public Alarm()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the alarm.
    
    Parameters:
    
    name - The name of the alarm.
  - getName
```
public String getName()
```
    The name of the alarm.
    
    Returns:
    
    The name of the alarm.
  - withName
```
public Alarm withName(String name)
```
    The name of the alarm.
    
    Parameters:
    
    name - The name of the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The Amazon Resource Name (ARN) of the alarm.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the alarm.
  - getArn
```
public String getArn()
```
    The Amazon Resource Name (ARN) of the alarm.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the alarm.
  - withArn
```
public Alarm withArn(String arn)
```
    The Amazon Resource Name (ARN) of the alarm.
    
    Parameters:
    
    arn - The Amazon Resource Name (ARN) of the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The timestamp when the alarm was created.
    
    Parameters:
    
    createdAt - The timestamp when the alarm was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The timestamp when the alarm was created.
    
    Returns:
    
    The timestamp when the alarm was created.
  - withCreatedAt
```
public Alarm withCreatedAt(Date createdAt)
```
    The timestamp when the alarm was created.
    
    Parameters:
    
    createdAt - The timestamp when the alarm was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLocation
```
public void setLocation(ResourceLocation location)
```
    An object that lists information about the location of the alarm.
    
    Parameters:
    
    location - An object that lists information about the location of the alarm.
  - getLocation
```
public ResourceLocation getLocation()
```
    An object that lists information about the location of the alarm.
    
    Returns:
    
    An object that lists information about the location of the alarm.
  - withLocation
```
public Alarm withLocation(ResourceLocation location)
```
    An object that lists information about the location of the alarm.
    
    Parameters:
    
    location - An object that lists information about the location of the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResourceType
```
public void setResourceType(String resourceType)
```
    The Lightsail resource type of the alarm.
    
    Parameters:
    
    resourceType - The Lightsail resource type of the alarm.
    
    See Also:
    
    ResourceType
  - getResourceType
```
public String getResourceType()
```
    The Lightsail resource type of the alarm.
    
    Returns:
    
    The Lightsail resource type of the alarm.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Alarm withResourceType(String resourceType)
```
    The Lightsail resource type of the alarm.
    
    Parameters:
    
    resourceType - The Lightsail resource type of the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - withResourceType
```
public Alarm withResourceType(ResourceType resourceType)
```
    The Lightsail resource type of the alarm.
    
    Parameters:
    
    resourceType - The Lightsail resource type of the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ResourceType
  - setSupportCode
```
public void setSupportCode(String supportCode)
```
    The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
    
    Parameters:
    
    supportCode - The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
  - getSupportCode
```
public String getSupportCode()
```
    The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
  - withSupportCode
```
public Alarm withSupportCode(String supportCode)
```
    The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
    
    Parameters:
    
    supportCode - The support code. Include this code in your email to support when you have questions about your Lightsail alarm. This code enables our support team to look up your Lightsail information more easily.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMonitoredResourceInfo
```
public void setMonitoredResourceInfo(MonitoredResourceInfo monitoredResourceInfo)
```
    An object that lists information about the resource monitored by the alarm.
    
    Parameters:
    
    monitoredResourceInfo - An object that lists information about the resource monitored by the alarm.
  - getMonitoredResourceInfo
```
public MonitoredResourceInfo getMonitoredResourceInfo()
```
    An object that lists information about the resource monitored by the alarm.
    
    Returns:
    
    An object that lists information about the resource monitored by the alarm.
  - withMonitoredResourceInfo
```
public Alarm withMonitoredResourceInfo(MonitoredResourceInfo monitoredResourceInfo)
```
    An object that lists information about the resource monitored by the alarm.
    
    Parameters:
    
    monitoredResourceInfo - An object that lists information about the resource monitored by the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComparisonOperator
```
public void setComparisonOperator(String comparisonOperator)
```
    The arithmetic operation used when comparing the specified statistic and threshold.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation used when comparing the specified statistic and threshold.
    
    See Also:
    
    ComparisonOperator
  - getComparisonOperator
```
public String getComparisonOperator()
```
    The arithmetic operation used when comparing the specified statistic and threshold.
    
    Returns:
    
    The arithmetic operation used when comparing the specified statistic and threshold.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public Alarm withComparisonOperator(String comparisonOperator)
```
    The arithmetic operation used when comparing the specified statistic and threshold.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation used when comparing the specified statistic and threshold.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ComparisonOperator
  - withComparisonOperator
```
public Alarm withComparisonOperator(ComparisonOperator comparisonOperator)
```
    The arithmetic operation used when comparing the specified statistic and threshold.
    
    Parameters:
    
    comparisonOperator - The arithmetic operation used when comparing the specified statistic and 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 over which data is compared to the specified threshold.
    
    Parameters:
    
    evaluationPeriods - The number of periods over which data is compared to the specified threshold.
  - getEvaluationPeriods
```
public Integer getEvaluationPeriods()
```
    The number of periods over which data is compared to the specified threshold.
    
    Returns:
    
    The number of periods over which data is compared to the specified threshold.
  - withEvaluationPeriods
```
public Alarm withEvaluationPeriods(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.
  - setPeriod
```
public void setPeriod(Integer period)
```
    The period, in seconds, over which the statistic is applied.
    
    Parameters:
    
    period - The period, in seconds, over which the statistic is applied.
  - getPeriod
```
public Integer getPeriod()
```
    The period, in seconds, over which the statistic is applied.
    
    Returns:
    
    The period, in seconds, over which the statistic is applied.
  - withPeriod
```
public Alarm withPeriod(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.
  - 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 Alarm 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.
  - setDatapointsToAlarm
```
public void setDatapointsToAlarm(Integer datapointsToAlarm)
```
    The number of data points that must not within the specified threshold to trigger the alarm.
    
    Parameters:
    
    datapointsToAlarm - The number of data points that must not within the specified threshold to trigger the alarm.
  - getDatapointsToAlarm
```
public Integer getDatapointsToAlarm()
```
    The number of data points that must not within the specified threshold to trigger the alarm.
    
    Returns:
    
    The number of data points that must not within the specified threshold to trigger the alarm.
  - withDatapointsToAlarm
```
public Alarm withDatapointsToAlarm(Integer datapointsToAlarm)
```
    The number of data points that must not within the specified threshold to trigger the alarm.
    
    Parameters:
    
    datapointsToAlarm - The number of data points that must not within the specified threshold to trigger the alarm.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatMissingData
```
public void setTreatMissingData(String treatMissingData)
```
    Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    - breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    - notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    - ignore - Ignore the missing data. Maintains the current alarm state.
    - missing - Missing data is treated as missing.
    Parameters:
    treatMissingData - Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    
    breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    
    notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    
    ignore - Ignore the missing data. Maintains the current alarm state.
    
    missing - Missing data is treated as missing.
    See Also:
    
    TreatMissingData
  - getTreatMissingData
```
public String getTreatMissingData()
```
    Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    - breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    - notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    - ignore - Ignore the missing data. Maintains the current alarm state.
    - missing - Missing data is treated as missing.
    Returns:
    Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    
    breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    
    notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    
    ignore - Ignore the missing data. Maintains the current alarm state.
    
    missing - Missing data is treated as missing.
    See Also:
    
    TreatMissingData
  - withTreatMissingData
```
public Alarm withTreatMissingData(String treatMissingData)
```
    Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    - breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    - notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    - ignore - Ignore the missing data. Maintains the current alarm state.
    - missing - Missing data is treated as missing.
    Parameters:
    treatMissingData - Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    
    breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    
    notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    
    ignore - Ignore the missing data. Maintains the current alarm state.
    
    missing - Missing data is treated as missing.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TreatMissingData
  - withTreatMissingData
```
public Alarm withTreatMissingData(TreatMissingData treatMissingData)
```
    Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    - breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    - notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    - ignore - Ignore the missing data. Maintains the current alarm state.
    - missing - Missing data is treated as missing.
    Parameters:
    treatMissingData - Specifies how the alarm handles missing data points.
    
    An alarm can treat missing data in the following ways:
    
    breaching - Assume the missing data is not within the threshold. Missing data counts towards the number of times the metric is not within the threshold.
    
    notBreaching - Assume the missing data is within the threshold. Missing data does not count towards the number of times the metric is not within the threshold.
    
    ignore - Ignore the missing data. Maintains the current alarm state.
    
    missing - Missing data is treated as missing.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TreatMissingData
  - setStatistic
```
public void setStatistic(String statistic)
```
    The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    - Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    - Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    - SampleCount - The count, or number, of data points used for the statistical calculation.
    Parameters:
    statistic - The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    
    Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    
    Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    
    Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    
    SampleCount - The count, or number, of data points used for the statistical calculation.
    See Also:
    
    MetricStatistic
  - getStatistic
```
public String getStatistic()
```
    The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    - Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    - Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    - SampleCount - The count, or number, of data points used for the statistical calculation.
    Returns:
    The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    
    Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    
    Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    
    Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    
    SampleCount - The count, or number, of data points used for the statistical calculation.
    See Also:
    
    MetricStatistic
  - withStatistic
```
public Alarm withStatistic(String statistic)
```
    The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    - Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    - Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    - SampleCount - The count, or number, of data points used for the statistical calculation.
    Parameters:
    statistic - The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    
    Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    
    Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    
    Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    
    SampleCount - The count, or number, of data points used for the statistical calculation.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - withStatistic
```
public Alarm withStatistic(MetricStatistic statistic)
```
    The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    - Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    - Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    - Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    - SampleCount - The count, or number, of data points used for the statistical calculation.
    Parameters:
    statistic - The statistic for the metric associated with the alarm.
    
    The following statistics are available:
    
    Minimum - The lowest value observed during the specified period. Use this value to determine low volumes of activity for your application.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    
    Sum - All values submitted for the matching metric added together. You can use this statistic to determine the total volume of a metric.
    
    Average - The value of Sum / SampleCount during the specified period. By comparing this statistic with the Minimum and Maximum values, you can determine the full scope of a metric and how close the average use is to the Minimum and Maximum values. This comparison helps you to know when to increase or decrease your resources.
    
    SampleCount - The count, or number, of data points used for the statistical calculation.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the metric associated with the alarm.
    
    Parameters:
    
    metricName - The name of the metric associated with the alarm.
    
    See Also:
    
    MetricName
  - getMetricName
```
public String getMetricName()
```
    The name of the metric associated with the alarm.
    
    Returns:
    
    The name of the metric associated with the alarm.
    
    See Also:
    
    MetricName
  - withMetricName
```
public Alarm withMetricName(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.
    
    See Also:
    
    MetricName
  - withMetricName
```
public Alarm withMetricName(MetricName 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.
    
    See Also:
    
    MetricName
  - setState
```
public void setState(String state)
```
    The current state of the alarm.
    
    An alarm has the following possible states:
    - ALARM - The metric is outside of the defined threshold.
    - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    - OK - The metric is within the defined threshold.
    Parameters:
    state - The current state of the alarm.
    
    An alarm has the following possible states:
    
    ALARM - The metric is outside of the defined threshold.
    
    INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    
    OK - The metric is within the defined threshold.
    See Also:
    
    AlarmState
  - getState
```
public String getState()
```
    The current state of the alarm.
    
    An alarm has the following possible states:
    - ALARM - The metric is outside of the defined threshold.
    - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    - OK - The metric is within the defined threshold.
    Returns:
    The current state of the alarm.
    
    An alarm has the following possible states:
    
    ALARM - The metric is outside of the defined threshold.
    
    INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    
    OK - The metric is within the defined threshold.
    See Also:
    
    AlarmState
  - withState
```
public Alarm withState(String state)
```
    The current state of the alarm.
    
    An alarm has the following possible states:
    - ALARM - The metric is outside of the defined threshold.
    - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    - OK - The metric is within the defined threshold.
    Parameters:
    state - The current state of the alarm.
    
    An alarm has the following possible states:
    
    ALARM - The metric is outside of the defined threshold.
    
    INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    
    OK - The metric is within the defined threshold.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmState
  - withState
```
public Alarm withState(AlarmState state)
```
    The current state of the alarm.
    
    An alarm has the following possible states:
    - ALARM - The metric is outside of the defined threshold.
    - INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    - OK - The metric is within the defined threshold.
    Parameters:
    state - The current state of the alarm.
    
    An alarm has the following possible states:
    
    ALARM - The metric is outside of the defined threshold.
    
    INSUFFICIENT_DATA - The alarm has just started, the metric is not available, or not enough data is available for the metric to determine the alarm state.
    
    OK - The metric is within the defined threshold.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmState
  - setUnit
```
public void setUnit(String unit)
```
    The unit of the metric associated with the alarm.
    
    Parameters:
    
    unit - The unit of the metric associated with the alarm.
    
    See Also:
    
    MetricUnit
  - getUnit
```
public String getUnit()
```
    The unit of the metric associated with the alarm.
    
    Returns:
    
    The unit of the metric associated with the alarm.
    
    See Also:
    
    MetricUnit
  - withUnit
```
public Alarm withUnit(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:
    
    MetricUnit
  - withUnit
```
public Alarm withUnit(MetricUnit 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:
    
    MetricUnit
  - getContactProtocols
```
public List<String> getContactProtocols()
```
    The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Returns:
    
    The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    See Also:
    
    ContactProtocol
  - setContactProtocols
```
public void setContactProtocols(Collection<String> contactProtocols)
```
    The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Parameters:
    
    contactProtocols - The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    See Also:
    
    ContactProtocol
  - withContactProtocols
```
public Alarm withContactProtocols(String... contactProtocols)
```
    The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    NOTE: This method appends the values to the existing list (if any). Use setContactProtocols(java.util.Collection) or withContactProtocols(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    contactProtocols - The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContactProtocol
  - withContactProtocols
```
public Alarm withContactProtocols(Collection<String> contactProtocols)
```
    The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Parameters:
    
    contactProtocols - The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContactProtocol
  - withContactProtocols
```
public Alarm withContactProtocols(ContactProtocol... contactProtocols)
```
    The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Parameters:
    
    contactProtocols - The contact protocols for the alarm, such as Email, SMS (text messaging), or both.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ContactProtocol
  - getNotificationTriggers
```
public List<String> getNotificationTriggers()
```
    The alarm states that trigger a notification.
    
    Returns:
    
    The alarm states that trigger a notification.
    
    See Also:
    
    AlarmState
  - setNotificationTriggers
```
public void setNotificationTriggers(Collection<String> notificationTriggers)
```
    The alarm states that trigger a notification.
    
    Parameters:
    
    notificationTriggers - The alarm states that trigger a notification.
    
    See Also:
    
    AlarmState
  - withNotificationTriggers
```
public Alarm withNotificationTriggers(String... notificationTriggers)
```
    The alarm states that trigger a notification.
    
    NOTE: This method appends the values to the existing list (if any). Use setNotificationTriggers(java.util.Collection) or withNotificationTriggers(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notificationTriggers - The alarm states that trigger a notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmState
  - withNotificationTriggers
```
public Alarm withNotificationTriggers(Collection<String> notificationTriggers)
```
    The alarm states that trigger a notification.
    
    Parameters:
    
    notificationTriggers - The alarm states that trigger a notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmState
  - withNotificationTriggers
```
public Alarm withNotificationTriggers(AlarmState... notificationTriggers)
```
    The alarm states that trigger a notification.
    
    Parameters:
    
    notificationTriggers - The alarm states that trigger a notification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AlarmState
  - setNotificationEnabled
```
public void setNotificationEnabled(Boolean notificationEnabled)
```
    Indicates whether the alarm is enabled.
    
    Parameters:
    
    notificationEnabled - Indicates whether the alarm is enabled.
  - getNotificationEnabled
```
public Boolean getNotificationEnabled()
```
    Indicates whether the alarm is enabled.
    
    Returns:
    
    Indicates whether the alarm is enabled.
  - withNotificationEnabled
```
public Alarm withNotificationEnabled(Boolean notificationEnabled)
```
    Indicates whether the alarm is enabled.
    
    Parameters:
    
    notificationEnabled - Indicates whether the alarm is enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isNotificationEnabled
```
public Boolean isNotificationEnabled()
```
    Indicates whether the alarm is enabled.
    
    Returns:
    
    Indicates whether the alarm is enabled.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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 Alarm 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.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Alarm

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Alarm

Method Detail

setName

getName

withName

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setLocation

getLocation

withLocation

setResourceType

getResourceType

withResourceType

withResourceType

setSupportCode

getSupportCode

withSupportCode

setMonitoredResourceInfo

getMonitoredResourceInfo

withMonitoredResourceInfo

setComparisonOperator

getComparisonOperator

withComparisonOperator

withComparisonOperator

setEvaluationPeriods

getEvaluationPeriods

withEvaluationPeriods

setPeriod

getPeriod

withPeriod

setThreshold

getThreshold

withThreshold

setDatapointsToAlarm

getDatapointsToAlarm

withDatapointsToAlarm

setTreatMissingData

getTreatMissingData

withTreatMissingData

withTreatMissingData

setStatistic

getStatistic

withStatistic

withStatistic

setMetricName

getMetricName

withMetricName

withMetricName

setState

getState

withState

withState

setUnit

getUnit

withUnit

withUnit

getContactProtocols

setContactProtocols

withContactProtocols

withContactProtocols

withContactProtocols

getNotificationTriggers

setNotificationTriggers

withNotificationTriggers

withNotificationTriggers

withNotificationTriggers

setNotificationEnabled

getNotificationEnabled

withNotificationEnabled

isNotificationEnabled