Package software.amazon.awssdk.services.ssm.model

Class NotificationConfig

java.lang.Object

software.amazon.awssdk.services.ssm.model.NotificationConfig

All Implemented Interfaces:

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

@Generated("software.amazon.awssdk:codegen")
public final class NotificationConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NotificationConfig.Builder,NotificationConfig>

Configurations for sending notifications.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	NotificationConfig.Builder

Method Summary

Modifier and Type	Method	Description
static NotificationConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNotificationEvents()	For responses, this returns true if the service returned a value for the NotificationEvents property.
String	notificationArn()	An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic.
List<NotificationEvent>	notificationEvents()	The different events for which you can receive notifications.
List<String>	notificationEventsAsStrings()	The different events for which you can receive notifications.
NotificationType	notificationType()	The type of notification.
String	notificationTypeAsString()	The type of notification.
List<SdkField<?>>	sdkFields()
static Class<? extends NotificationConfig.Builder>	serializableBuilderClass()
NotificationConfig.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

notificationArn

public final String notificationArn()

An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.

Returns:

An Amazon Resource Name (ARN) for an Amazon Simple Notification Service (Amazon SNS) topic. Run Command pushes notifications about command status changes to this topic.

notificationEvents

public final List<NotificationEvent> notificationEvents()

The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

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 hasNotificationEvents() method.

Returns:

The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

hasNotificationEvents

public final boolean hasNotificationEvents()

For responses, this returns true if the service returned a value for the NotificationEvents 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.

notificationEventsAsStrings

public final List<String> notificationEventsAsStrings()

The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

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 hasNotificationEvents() method.

Returns:

The different events for which you can receive notifications. To learn more about these events, see Monitoring Systems Manager status changes using Amazon SNS notifications in the Amazon Web Services Systems Manager User Guide.

notificationType

public final NotificationType notificationType()

The type of notification.

• Command: Receive notification when the status of a command changes.

• Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.

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

Returns:

The type of notification.

• Command: Receive notification when the status of a command changes.

• Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.

See Also:

NotificationType

notificationTypeAsString

public final String notificationTypeAsString()

The type of notification.

• Command: Receive notification when the status of a command changes.

• Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.

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

Returns:

The type of notification.

• Command: Receive notification when the status of a command changes.

• Invocation: For commands sent to multiple managed nodes, receive notification on a per-node basis when the status of a command changes.

See Also:

NotificationType

toBuilder

public NotificationConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NotificationConfig.Builder,NotificationConfig>

builder

public static NotificationConfig.Builder builder()

serializableBuilderClass

public static Class<? extends NotificationConfig.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