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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNotificationEvents() Returns true if the NotificationEvents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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() 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()
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 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 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 AWS Systems Manager in the AWS Systems Manager User Guide.

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

You can use hasNotificationEvents() to see if a value was sent in this field.

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 AWS Systems Manager in the AWS Systems Manager User Guide.

hasNotificationEvents

public boolean hasNotificationEvents()

Returns true if the NotificationEvents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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 AWS Systems Manager in the AWS Systems Manager User Guide.

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

You can use hasNotificationEvents() to see if a value was sent in this field.

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 AWS Systems Manager 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()

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo