@Generated(value="software.amazon.awssdk:codegen") public class CreateEventSubscriptionRequest extends DatabaseMigrationRequest implements ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CreateEventSubscriptionRequest.Builder |
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() |
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 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() |
requestOverrideConfig
copy
public String subscriptionName()
The name of the DMS event notification subscription.
Constraints: The name must be less than 255 characters.
Constraints: The name must be less than 255 characters.
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.
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
replication-instance
. If this
value is not specified, all events are returned.
Valid values: replication-instance | migration-task
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.
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.
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.
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.
public CreateEventSubscriptionRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<CreateEventSubscriptionRequest.Builder,CreateEventSubscriptionRequest>
toBuilder
in class DatabaseMigrationRequest
public static CreateEventSubscriptionRequest.Builder builder()
public static Class<? extends CreateEventSubscriptionRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
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.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.