software.amazon.awssdk.services.databasemigration.model

Class CreateEventSubscriptionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest

software.amazon.awssdk.services.databasemigration.model.CreateEventSubscriptionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateEventSubscriptionRequest
extends DatabaseMigrationRequest
implements ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateEventSubscriptionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateEventSubscriptionRequest.Builder	builder()
Boolean	enabled() A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.
boolean	equals(Object obj)
List<String>	eventCategories() A list of event categories for a source type that you want to subscribe to.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateEventSubscriptionRequest.Builder>	serializableBuilderClass()
String	snsTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
List<String>	sourceIds() The list of identifiers of the event sources for which events will be returned.
String	sourceType() The type of AWS DMS resource that generates the events.
String	subscriptionName() The name of the AWS DMS event notification subscription.
List<Tag>	tags() A tag to be attached to the event subscription.
CreateEventSubscriptionRequest.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 software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

subscriptionName

public String subscriptionName()

The name of the AWS DMS event notification subscription.

Constraints: The name must be less than 255 characters.

Returns:

The name of the AWS DMS event notification subscription.

Constraints: The name must be less than 255 characters.

snsTopicArn

public String snsTopicArn()

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Returns:

The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

sourceType

public String sourceType()

The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.

Valid values: replication-instance | migration-task

Returns:

The type of AWS DMS resource that generates the events. For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance. If this value is not specified, all events are returned.

Valid values: replication-instance | migration-task

eventCategories

public List<String> eventCategories()

A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.

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

Returns:

A list of event categories for a source type that you want to subscribe to. You can see a list of the categories for a given source type by calling the DescribeEventCategories action or in the topic Working with Events and Notifications in the AWS Database Migration Service User Guide.

sourceIds

public List<String> sourceIds()

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

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

Returns:

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

enabled

public Boolean enabled()

A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

Returns:

A Boolean value; set to true to activate the subscription, or set to false to create the subscription but not activate it.

tags

public List<Tag> tags()

A tag to be attached to the event subscription.

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

Returns:

A tag to be attached to the event subscription.

toBuilder

public CreateEventSubscriptionRequest.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<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>

Specified by:

toBuilder in class DatabaseMigrationRequest

Returns:

a builder for type T

builder

public static CreateEventSubscriptionRequest.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

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.