software.amazon.awssdk.services.ssm.model

Class AlarmConfiguration

java.lang.Object

software.amazon.awssdk.services.ssm.model.AlarmConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>

@Generated(value="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 and Description
static interface	AlarmConfiguration.Builder

Method Summary

Modifier and Type	Method and 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() If you specify true for this value, your automation or command continue to run even if we can't gather information about the state of your CloudWatch alarm.
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()

If you specify true for this value, your automation or command continue to run even if we can't gather information about the state of your CloudWatch alarm. The default value is false.

Returns:

If you specify true for this value, your automation or command continue to run even if we can't gather information about the state of your CloudWatch alarm. The default value 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 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.

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 interface ToCopyableBuilder<AlarmConfiguration.Builder,AlarmConfiguration>

builder

public static AlarmConfiguration.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo