Package software.amazon.awscdk.services.dms

Class CfnEventSubscription.Builder

java.lang.Object

software.amazon.awscdk.services.dms.CfnEventSubscription.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventSubscription>

Enclosing class:

CfnEventSubscription

@Stability(Stable)
public static final class CfnEventSubscription.Builder
extends Object
implements software.amazon.jsii.Builder<CfnEventSubscription>

A fluent builder for CfnEventSubscription.

Method Summary

Modifier and Type	Method	Description
CfnEventSubscription	build()
static CfnEventSubscription.Builder	create(software.constructs.Construct scope, String id)
CfnEventSubscription.Builder	enabled(Boolean enabled)	Indicates whether to activate the subscription.
CfnEventSubscription.Builder	enabled(IResolvable enabled)	Indicates whether to activate the subscription.
CfnEventSubscription.Builder	eventCategories(List<String> eventCategories)	A list of event categories for a source type that you want to subscribe to.
CfnEventSubscription.Builder	snsTopicArn(String snsTopicArn)	The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
CfnEventSubscription.Builder	sourceIds(List<String> sourceIds)	A list of identifiers for which AWS DMS provides notification events.
CfnEventSubscription.Builder	sourceType(String sourceType)	The type of AWS DMS resource that generates the events.
CfnEventSubscription.Builder	subscriptionName(String subscriptionName)	The name of the AWS DMS event notification subscription.
CfnEventSubscription.Builder	tags(List<? extends CfnTag> tags)	One or more tags to be assigned to the event subscription.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnEventSubscription.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

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

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnEventSubscription.Builder.

snsTopicArn

@Stability(Stable)
public CfnEventSubscription.Builder snsTopicArn(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.

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-snstopicarn

enabled

@Stability(Stable)
public CfnEventSubscription.Builder enabled(Boolean enabled)

Indicates whether to activate the subscription.

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

Parameters:

enabled - Indicates whether to activate the subscription. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled

enabled

@Stability(Stable)
public CfnEventSubscription.Builder enabled(IResolvable enabled)

Indicates whether to activate the subscription.

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

Parameters:

enabled - Indicates whether to activate the subscription. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-enabled

eventCategories

@Stability(Stable)
public CfnEventSubscription.Builder eventCategories(List<String> eventCategories)

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 .

Parameters:

eventCategories - A list of event categories for a source type that you want to subscribe to. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-eventcategories

sourceIds

@Stability(Stable)
public CfnEventSubscription.Builder sourceIds(List<String> sourceIds)

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.

Parameters:

sourceIds - A list of identifiers for which AWS DMS provides notification events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourceids

sourceType

@Stability(Stable)
public CfnEventSubscription.Builder sourceType(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 isn't specified, all events are returned.

Valid values : replication-instance | replication-task

Parameters:

sourceType - The type of AWS DMS resource that generates the events. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-sourcetype

subscriptionName

@Stability(Stable)
public CfnEventSubscription.Builder subscriptionName(String subscriptionName)

The name of the AWS DMS event notification subscription.

This name must be less than 255 characters.

Parameters:

subscriptionName - The name of the AWS DMS event notification subscription. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-subscriptionname

tags

@Stability(Stable)
public CfnEventSubscription.Builder tags(List<? extends CfnTag> 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. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-eventsubscription.html#cfn-dms-eventsubscription-tags

build

@Stability(Stable)
public CfnEventSubscription build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnEventSubscription>

Returns:

a newly built instance of CfnEventSubscription.