Class AlarmConfiguration
- java.lang.Object
-
- software.amazon.awssdk.services.ssm.model.AlarmConfiguration
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class AlarmConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>
The details for the CloudWatch alarm you want to apply to an automation or command.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AlarmConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<Alarm>
alarms()
The name of the CloudWatch alarm specified in the configuration.static AlarmConfiguration.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAlarms()
For responses, this returns true if the service returned a value for the Alarms property.int
hashCode()
Boolean
ignorePollAlarmFailure()
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch.List<SdkField<?>>
sdkFields()
static Class<? extends AlarmConfiguration.Builder>
serializableBuilderClass()
AlarmConfiguration.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
ignorePollAlarmFailure
public final Boolean ignorePollAlarmFailure()
When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
- Returns:
- When this value is true, your automation or command continues to run in cases where we can’t retrieve alarm status information from CloudWatch. In cases where we successfully retrieve an alarm status of OK or INSUFFICIENT_DATA, the automation or command continues to run, regardless of this value. Default is false.
-
hasAlarms
public final boolean hasAlarms()
For responses, this returns true if the service returned a value for the Alarms 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.
-
alarms
public final List<Alarm> alarms()
The name of the CloudWatch alarm specified in the configuration.
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
hasAlarms()
method.- Returns:
- The name of the CloudWatch alarm specified in the configuration.
-
toBuilder
public AlarmConfiguration.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>
-
builder
public static AlarmConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends AlarmConfiguration.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-