software.amazon.awscdk.services.dms

Class CfnEventSubscription

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.dms.CfnEventSubscription

All Implemented Interfaces:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.50.0 (build d1830a4)",
           date="2022-01-04T15:39:05.635Z")
 @Stability(value=Stable)
public class CfnEventSubscription
extends CfnResource
implements IInspectable

A CloudFormation `AWS::DMS::EventSubscription`.

Use the AWS::DMS::EventSubscription resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service. For more information, see Using AWS DMS Event Notification in the AWS Database Migration Service User Guide.

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.*;
 CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription")
         .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	Class and Description
static class	CfnEventSubscription.Builder A fluent builder for CfnEventSubscription.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEventSubscription(Construct scope, String id, CfnEventSubscriptionProps props) Create a new `AWS::DMS::EventSubscription`.
protected	CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
Object	getEnabled() Indicates whether to activate the subscription.
List<String>	getEventCategories() A list of event categories for a source type that you want to subscribe to.
String	getSnsTopicArn() The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
List<String>	getSourceIds() A list of identifiers for which AWS DMS provides notification events.
String	getSourceType() The type of AWS DMS resource that generates the events.
String	getSubscriptionName() The name of the AWS DMS event notification subscription.
TagManager	getTags() One or more tags to be assigned to the event subscription.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setEnabled(Boolean value) Indicates whether to activate the subscription.
void	setEnabled(IResolvable value) Indicates whether to activate the subscription.
void	setEventCategories(List<String> value) A list of event categories for a source type that you want to subscribe to.
void	setSnsTopicArn(String value) The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
void	setSourceIds(List<String> value) A list of identifiers for which AWS DMS provides notification events.
void	setSourceType(String value) The type of AWS DMS resource that generates the events.
void	setSubscriptionName(String value) The name of the AWS DMS event notification subscription.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEventSubscription

protected CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)

CfnEventSubscription

protected CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnEventSubscription

@Stability(value=Stable)
public CfnEventSubscription(@NotNull
                                                     Construct scope,
                                                     @NotNull
                                                     String id,
                                                     @NotNull
                                                     CfnEventSubscriptionProps props)

Create a new `AWS::DMS::EventSubscription`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getSnsTopicArn

@Stability(value=Stable)
 @NotNull
public 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.

setSnsTopicArn

@Stability(value=Stable)
public void setSnsTopicArn(@NotNull
                                                    String value)

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

@Stability(value=Stable)
 @Nullable
public Object getEnabled()

Indicates whether to activate the subscription.

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

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                Boolean value)

Indicates whether to activate the subscription.

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

setEnabled

@Stability(value=Stable)
public void setEnabled(@Nullable
                                                IResolvable value)

Indicates whether to activate the subscription.

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

getEventCategories

@Stability(value=Stable)
 @Nullable
public List<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 .

setEventCategories

@Stability(value=Stable)
public void setEventCategories(@Nullable
                                                        List<String> value)

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

@Stability(value=Stable)
 @Nullable
public List<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.

setSourceIds

@Stability(value=Stable)
public void setSourceIds(@Nullable
                                                  List<String> value)

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

@Stability(value=Stable)
 @Nullable
public 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

setSourceType

@Stability(value=Stable)
public void setSourceType(@Nullable
                                                   String value)

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

@Stability(value=Stable)
 @Nullable
public String getSubscriptionName()

The name of the AWS DMS event notification subscription.

This name must be less than 255 characters.

setSubscriptionName

@Stability(value=Stable)
public void setSubscriptionName(@Nullable
                                                         String value)

The name of the AWS DMS event notification subscription.

This name must be less than 255 characters.