Class PutAlarmRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<PutAlarmRequest.Builder,
PutAlarmRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The name for the alarm.static PutAlarmRequest.Builder
builder()
final ComparisonOperator
The arithmetic operation to use when comparing the specified statistic to the threshold.final String
The arithmetic operation to use when comparing the specified statistic to the threshold.final List
<ContactProtocol> The contact protocols to use for the alarm, such asEmail
,SMS
(text messaging), or both.The contact protocols to use for the alarm, such asEmail
,SMS
(text messaging), or both.final Integer
The number of data points that must be not within the specified threshold to trigger the alarm.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Integer
The number of most recent periods over which data is compared to the specified threshold.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the ContactProtocols property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NotificationTriggers property.final MetricName
The name of the metric to associate with the alarm.final String
The name of the metric to associate with the alarm.final String
The name of the Lightsail resource that will be monitored.final Boolean
Indicates whether the alarm is enabled.final List
<AlarmState> The alarm states that trigger a notification.The alarm states that trigger a notification.static Class
<? extends PutAlarmRequest.Builder> final Double
The value against which the specified statistic is compared.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final TreatMissingData
Sets how this alarm will handle missing data points.final String
Sets how this alarm will handle missing data points.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
, andStatusCheckFailed_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
, andRequestCount
. -
Relational databases:
CPUUtilization
,DatabaseConnections
,DiskQueueDepth
,FreeStorageSpace
,NetworkReceiveThroughput
, andNetworkTransmitThroughput
.
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 returnMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- 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
, andStatusCheckFailed_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
, andRequestCount
. -
Relational databases:
CPUUtilization
,DatabaseConnections
,DiskQueueDepth
,FreeStorageSpace
,NetworkReceiveThroughput
, andNetworkTransmitThroughput
.
For more information about these metrics, see Metrics available in Lightsail.
-
- See Also:
-
-
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
, andStatusCheckFailed_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
, andRequestCount
. -
Relational databases:
CPUUtilization
,DatabaseConnections
,DiskQueueDepth
,FreeStorageSpace
,NetworkReceiveThroughput
, andNetworkTransmitThroughput
.
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 returnMetricName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetricNameAsString()
.- 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
, andStatusCheckFailed_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
, andRequestCount
. -
Relational databases:
CPUUtilization
,DatabaseConnections
,DiskQueueDepth
,FreeStorageSpace
,NetworkReceiveThroughput
, andNetworkTransmitThroughput
.
For more information about these metrics, see Metrics available in Lightsail.
-
- See Also:
-
-
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
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 returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- 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:
-
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 returnComparisonOperator.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomparisonOperatorAsString()
.- 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:
-
threshold
The value against which the specified statistic is compared.
- Returns:
- The value against which the specified statistic is compared.
-
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
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
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 ofmissing
is used.If the service returns an enum value that is not available in the current SDK version,
treatMissingData
will returnTreatMissingData.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtreatMissingDataAsString()
.- 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 ofmissing
is used. -
- See Also:
-
-
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 ofmissing
is used.If the service returns an enum value that is not available in the current SDK version,
treatMissingData
will returnTreatMissingData.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtreatMissingDataAsString()
.- 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 ofmissing
is used. -
- See Also:
-
-
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 theisEmpty()
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
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
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. TheINSUFFICIENT_DATA
andOK
states can be specified in addition to theALARM
state.-
If you specify
OK
as an alarm trigger, a notification is sent when the alarm switches from anALARM
orINSUFFICIENT_DATA
alarm state to anOK
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 anOK
orALARM
alarm state to anINSUFFICIENT_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. TheINSUFFICIENT_DATA
andOK
states can be specified in addition to theALARM
state.-
If you specify
OK
as an alarm trigger, a notification is sent when the alarm switches from anALARM
orINSUFFICIENT_DATA
alarm state to anOK
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 anOK
orALARM
alarm state to anINSUFFICIENT_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 theisEmpty()
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
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. TheINSUFFICIENT_DATA
andOK
states can be specified in addition to theALARM
state.-
If you specify
OK
as an alarm trigger, a notification is sent when the alarm switches from anALARM
orINSUFFICIENT_DATA
alarm state to anOK
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 anOK
orALARM
alarm state to anINSUFFICIENT_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. TheINSUFFICIENT_DATA
andOK
states can be specified in addition to theALARM
state.-
If you specify
OK
as an alarm trigger, a notification is sent when the alarm switches from anALARM
orINSUFFICIENT_DATA
alarm state to anOK
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 anOK
orALARM
alarm state to anINSUFFICIENT_DATA
state.
The notification trigger defaults to
ALARM
if you don't specify this parameter. -
-
-
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PutAlarmRequest.Builder,
PutAlarmRequest> - Specified by:
toBuilder
in classLightsailRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-