Package software.amazon.awssdk.services.lightsail.model

Class PutAlarmRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.lightsail.model.LightsailRequest

software.amazon.awssdk.services.lightsail.model.PutAlarmRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutAlarmRequest.Builder,PutAlarmRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutAlarmRequest
extends LightsailRequest
implements ToCopyableBuilder<PutAlarmRequest.Builder,PutAlarmRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutAlarmRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	alarmName()	The name for the alarm.
static PutAlarmRequest.Builder	builder()
ComparisonOperator	comparisonOperator()	The arithmetic operation to use when comparing the specified statistic to the threshold.
String	comparisonOperatorAsString()	The arithmetic operation to use when comparing the specified statistic to the threshold.
List<ContactProtocol>	contactProtocols()	The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
List<String>	contactProtocolsAsStrings()	The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.
Integer	datapointsToAlarm()	The number of data points that must be not within the specified threshold to trigger the alarm.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	evaluationPeriods()	The number of most recent periods over which data is compared to the specified threshold.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContactProtocols()	For responses, this returns true if the service returned a value for the ContactProtocols property.
int	hashCode()
boolean	hasNotificationTriggers()	For responses, this returns true if the service returned a value for the NotificationTriggers property.
MetricName	metricName()	The name of the metric to associate with the alarm.
String	metricNameAsString()	The name of the metric to associate with the alarm.
String	monitoredResourceName()	The name of the Lightsail resource that will be monitored.
Boolean	notificationEnabled()	Indicates whether the alarm is enabled.
List<AlarmState>	notificationTriggers()	The alarm states that trigger a notification.
List<String>	notificationTriggersAsStrings()	The alarm states that trigger a notification.
List<SdkField<?>>	sdkFields()
static Class<? extends PutAlarmRequest.Builder>	serializableBuilderClass()
Double	threshold()	The value against which the specified statistic is compared.
PutAlarmRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
TreatMissingData	treatMissingData()	Sets how this alarm will handle missing data points.
String	treatMissingDataAsString()	Sets how this alarm will handle missing data points.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

alarmName

public final String alarmName()

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

Returns:

The name for the alarm. Specify the name of an existing alarm to update, and overwrite the previous configuration of the alarm.

metricName

public final MetricName metricName()

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

• Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

• Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

• Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

If the service returns an enum value that is not available in the current SDK version, metricName will return MetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

• Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

• Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

• Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

See Also:

MetricName

metricNameAsString

public final String metricNameAsString()

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

• Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

• Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

• Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

If the service returns an enum value that is not available in the current SDK version, metricName will return MetricName.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricNameAsString().

Returns:

The name of the metric to associate with the alarm.

You can configure up to two alarms per metric.

The following metrics are available for each resource type:

• Instances: BurstCapacityPercentage, BurstCapacityTime, CPUUtilization, NetworkIn, NetworkOut, StatusCheckFailed, StatusCheckFailed_Instance, and StatusCheckFailed_System.

• Load balancers: ClientTLSNegotiationErrorCount, HealthyHostCount, UnhealthyHostCount, HTTPCode_LB_4XX_Count, HTTPCode_LB_5XX_Count, HTTPCode_Instance_2XX_Count, HTTPCode_Instance_3XX_Count, HTTPCode_Instance_4XX_Count, HTTPCode_Instance_5XX_Count, InstanceResponseTime, RejectedConnectionCount, and RequestCount.

• Relational databases: CPUUtilization, DatabaseConnections, DiskQueueDepth, FreeStorageSpace, NetworkReceiveThroughput, and NetworkTransmitThroughput.

For more information about these metrics, see Metrics available in Lightsail.

See Also:

MetricName

monitoredResourceName

public final String monitoredResourceName()

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

Returns:

The name of the Lightsail resource that will be monitored.

Instances, load balancers, and relational databases are the only Lightsail resources that can currently be monitored by alarms.

comparisonOperator

public final ComparisonOperator comparisonOperator()

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

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

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

See Also:

ComparisonOperator

comparisonOperatorAsString

public final String comparisonOperatorAsString()

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

If the service returns an enum value that is not available in the current SDK version, comparisonOperator will return ComparisonOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from comparisonOperatorAsString().

Returns:

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

See Also:

ComparisonOperator

threshold

public final Double threshold()

The value against which the specified statistic is compared.

Returns:

The value against which the specified statistic is compared.

evaluationPeriods

public final Integer evaluationPeriods()

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

Returns:

The number of most recent periods over which data is compared to the specified threshold. If you are setting an "M out of N" alarm, this value (evaluationPeriods) is the N.

If you are setting an alarm that requires that a number of consecutive data points be breaching to trigger the alarm, this value specifies the rolling period of time in which data points are evaluated.

Each evaluation period is five minutes long. For example, specify an evaluation period of 24 to evaluate a metric over a rolling period of two hours.

You can specify a minimum valuation period of 1 (5 minutes), and a maximum evaluation period of 288 (24 hours).

datapointsToAlarm

public final Integer datapointsToAlarm()

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

Returns:

The number of data points that must be not within the specified threshold to trigger the alarm. If you are setting an "M out of N" alarm, this value (datapointsToAlarm) is the M.

treatMissingData

public final TreatMissingData treatMissingData()

Sets how this alarm will handle 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.

If treatMissingData is not specified, the default behavior of missing is used.

If the service returns an enum value that is not available in the current SDK version, treatMissingData will return TreatMissingData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from treatMissingDataAsString().

Returns:

Sets how this alarm will handle 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.

If treatMissingData is not specified, the default behavior of missing is used.

See Also:

TreatMissingData

treatMissingDataAsString

public final String treatMissingDataAsString()

Sets how this alarm will handle 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.

If treatMissingData is not specified, the default behavior of missing is used.

If the service returns an enum value that is not available in the current SDK version, treatMissingData will return TreatMissingData.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from treatMissingDataAsString().

Returns:

Sets how this alarm will handle 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.

If treatMissingData is not specified, the default behavior of missing is used.

See Also:

TreatMissingData

contactProtocols

public final List<ContactProtocol> contactProtocols()

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContactProtocols() method.

Returns:

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

hasContactProtocols

public final boolean hasContactProtocols()

For responses, this returns true if the service returned a value for the ContactProtocols property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

contactProtocolsAsStrings

public final List<String> contactProtocolsAsStrings()

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContactProtocols() method.

Returns:

The contact protocols to use for the alarm, such as Email, SMS (text messaging), or both.

A notification is sent via the specified contact protocol if notifications are enabled for the alarm, and when the alarm is triggered.

A notification is not sent if a contact protocol is not specified, if the specified contact protocol is not configured in the Amazon Web Services Region, or if notifications are not enabled for the alarm using the notificationEnabled paramater.

Use the CreateContactMethod action to configure a contact protocol in an Amazon Web Services Region.

notificationTriggers

public final List<AlarmState> notificationTriggers()

The alarm states that trigger a notification.

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.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

• If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

• If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotificationTriggers() method.

Returns:

The alarm states that trigger a notification.

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.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

• If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

• If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

hasNotificationTriggers

public final boolean hasNotificationTriggers()

For responses, this returns true if the service returned a value for the NotificationTriggers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

notificationTriggersAsStrings

public final List<String> notificationTriggersAsStrings()

The alarm states that trigger a notification.

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.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

• If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

• If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotificationTriggers() method.

Returns:

The alarm states that trigger a notification.

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.

When you specify a notification trigger, the ALARM state must be specified. The INSUFFICIENT_DATA and OK states can be specified in addition to the ALARM state.

• If you specify OK as an alarm trigger, a notification is sent when the alarm switches from an ALARM or INSUFFICIENT_DATA alarm state to an OK state. This can be thought of as an all clear alarm notification.

• If you specify INSUFFICIENT_DATA as the alarm trigger, a notification is sent when the alarm switches from an OK or ALARM alarm state to an INSUFFICIENT_DATA state.

The notification trigger defaults to ALARM if you don't specify this parameter.

notificationEnabled

public final Boolean notificationEnabled()

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

Returns:

Indicates whether the alarm is enabled.

Notifications are enabled by default if you don't specify this parameter.

toBuilder

public PutAlarmRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutAlarmRequest.Builder,PutAlarmRequest>

Specified by:

toBuilder in class LightsailRequest

builder

public static PutAlarmRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutAlarmRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo