software.amazon.awscdk.services.dms

Interface CfnEventSubscriptionProps

All Known Implementing Classes:

CfnEventSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-07-01T09:58:30.610Z")
public interface CfnEventSubscriptionProps

Properties for defining a `CfnEventSubscription`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.dms.*;
 CfnEventSubscriptionProps cfnEventSubscriptionProps = CfnEventSubscriptionProps.builder()
         .snsTopicArn("snsTopicArn")
         // the properties below are optional
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .subscriptionName("subscriptionName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnEventSubscriptionProps.Builder A builder for CfnEventSubscriptionProps
static class	CfnEventSubscriptionProps.Jsii$Proxy An implementation for CfnEventSubscriptionProps

Method Summary

Modifier and Type	Method and Description
static CfnEventSubscriptionProps.Builder	builder()
default java.lang.Object	getEnabled() Indicates whether to activate the subscription.
default java.util.List<java.lang.String>	getEventCategories() A list of event categories for a source type that you want to subscribe to.
java.lang.String	getSnsTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
default java.util.List<java.lang.String>	getSourceIds() A list of identifiers for which AWS DMS provides notification events.
default java.lang.String	getSourceType() The type of AWS DMS resource that generates the events.
default java.lang.String	getSubscriptionName() The name of the AWS DMS event notification subscription.
default java.util.List<CfnTag>	getTags() One or more tags to be assigned to the event subscription.

Method Detail

getSnsTopicArn

java.lang.String getSnsTopicArn()

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.

getEnabled

default java.lang.Object getEnabled()

Indicates whether to activate the subscription.

If you don't specify this property, AWS CloudFormation activates the subscription.

getEventCategories

default java.util.List<java.lang.String> getEventCategories()

A list of event categories for a source type that you want to subscribe to.

If you don't specify this property, you are notified about all event categories. For more information, see Working with Events and Notifications in the AWS DMS User Guide .

getSourceIds

default java.util.List<java.lang.String> getSourceIds()

A list of identifiers for which AWS 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.

getSourceType

default java.lang.String getSourceType()

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 isn't specified, all events are returned.

Valid values : replication-instance | replication-task

getSubscriptionName

default java.lang.String getSubscriptionName()

The name of the AWS DMS event notification subscription.

This name must be less than 255 characters.

getTags

default java.util.List<CfnTag> getTags()

One or more tags to be assigned to the event subscription.

builder

static CfnEventSubscriptionProps.Builder builder()

Returns:

a CfnEventSubscriptionProps.Builder of CfnEventSubscriptionProps