Interface CreateEventSubscriptionRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateEventSubscriptionRequest.Builder,
,CreateEventSubscriptionRequest> DatabaseMigrationRequest.Builder
,SdkBuilder<CreateEventSubscriptionRequest.Builder,
,CreateEventSubscriptionRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateEventSubscriptionRequest
-
Method Summary
Modifier and TypeMethodDescriptionA Boolean value; set totrue
to activate the subscription, or set tofalse
to create the subscription but not activate it.eventCategories
(String... eventCategories) A list of event categories for a source type that you want to subscribe to.eventCategories
(Collection<String> eventCategories) A list of event categories for a source type that you want to subscribe to.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.snsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.A list of identifiers for which DMS provides notification events.sourceIds
(Collection<String> sourceIds) A list of identifiers for which DMS provides notification events.sourceType
(String sourceType) The type of DMS resource that generates the events.subscriptionName
(String subscriptionName) The name of the DMS event notification subscription.tags
(Collection<Tag> tags) One or more tags to be assigned to the event subscription.tags
(Consumer<Tag.Builder>... tags) One or more tags to be assigned to the event subscription.One or more tags to be assigned to the event subscription.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.databasemigration.model.DatabaseMigrationRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
subscriptionName
The name of the DMS event notification subscription. This name must be less than 255 characters.
- Parameters:
subscriptionName
- The name of the DMS event notification subscription. This name must be less than 255 characters.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sourceType
The type of 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 isn't specified, all events are returned.Valid values:
replication-instance
|replication-task
- Parameters:
sourceType
- The type of 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 toreplication-instance
. If this value isn't specified, all events are returned.Valid values:
replication-instance
|replication-task
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventCategories
A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.
- Parameters:
eventCategories
- A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eventCategories
A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.
- Parameters:
eventCategories
- A list of event categories for a source type that you want to subscribe to. For more information, see Working with Events and Notifications in the Database Migration Service User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIds
A list of identifiers for which DMS provides notification events.
If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
- Parameters:
sourceIds
- A list of identifiers for which DMS provides notification events.If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIds
A list of identifiers for which DMS provides notification events.
If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
- Parameters:
sourceIds
- A list of identifiers for which DMS provides notification events.If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
enabled
A Boolean value; set to
true
to activate the subscription, or set tofalse
to create the subscription but not activate it.- Parameters:
enabled
- A Boolean value; set totrue
to activate the subscription, or set tofalse
to create the subscription but not activate it.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the event subscription.
- Parameters:
tags
- One or more tags to be assigned to the event subscription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the event subscription.
- Parameters:
tags
- One or more tags to be assigned to the event subscription.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tags
One or more tags to be assigned to the event subscription.
This is a convenience method that creates an instance of theTag.Builder
avoiding the need to create one manually viaTag.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed totags(List<Tag>)
.- Parameters:
tags
- a consumer that will call methods onTag.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CreateEventSubscriptionRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateEventSubscriptionRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-