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

Method Summary

Modifier and Type	Method and Description
static NotificationConfig.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	notificationArn() An Amazon Resource Name (ARN) for a Simple Notification Service (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() Command: Receive notification when the status of a command changes.
String	notificationTypeAsString() Command: Receive notification when the status of a command changes.
List<SdkField<?>>	sdkFields()
static Class<? extends NotificationConfig.Builder>	serializableBuilderClass()
NotificationConfig.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

notificationArn

public String notificationArn()

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

Returns:

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

notificationEvents

public List<NotificationEvent> notificationEvents()

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.

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

Returns:

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.

notificationEventsAsStrings

public List<String> notificationEventsAsStrings()

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.

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

Returns:

The different events for which you can receive notifications. These events include the following: All (events), InProgress, Success, TimedOut, Cancelled, Failed. To learn more about these events, see Configuring Amazon SNS Notifications for Run Command in the AWS Systems Manager User Guide.

notificationType

public NotificationType notificationType()

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance 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:

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

See Also:

NotificationType

notificationTypeAsString

public String notificationTypeAsString()

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance 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:

Command: Receive notification when the status of a command changes. Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes.

See Also:

NotificationType

toBuilder

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

Returns:

a builder for type T

builder

public static NotificationConfig.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.