Package software.amazon.awscdk.services.docdb

Class CfnEventSubscription.Builder

java.lang.Object

software.amazon.awscdk.services.docdb.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)	A Boolean value;
CfnEventSubscription.Builder	enabled(IResolvable enabled)	A Boolean value;
CfnEventSubscription.Builder	eventCategories(List<String> eventCategories)	A list of event categories for a SourceType that you want to subscribe to.
CfnEventSubscription.Builder	snsTopicArn(String snsTopicArn)	The Amazon Resource Name (ARN) of the SNS topic created for event notification.
CfnEventSubscription.Builder	sourceIds(List<String> sourceIds)	The list of identifiers of the event sources for which events are returned.
CfnEventSubscription.Builder	sourceType(String sourceType)	The type of source that is generating the events.
CfnEventSubscription.Builder	subscriptionName(String subscriptionName)	The name of the 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 SNS topic created for event notification.

Amazon SNS creates the ARN when you create a topic and subscribe to it.

Parameters:

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

Returns:

this

See Also:

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

enabled

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

A Boolean value;

set to true to activate the subscription, set to false to create the subscription but not active it.

Parameters:

enabled - A Boolean value;. This parameter is required.

Returns:

this

See Also:

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

enabled

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

A Boolean value;

set to true to activate the subscription, set to false to create the subscription but not active it.

Parameters:

enabled - A Boolean value;. This parameter is required.

Returns:

this

See Also:

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

eventCategories

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

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

Parameters:

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

Returns:

this

See Also:

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

sourceIds

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

The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.

Constraints:

• If SourceIds are provided, SourceType must also be provided.
• If the source type is an instance, a DBInstanceIdentifier must be provided.
• If the source type is a security group, a DBSecurityGroupName must be provided.
• If the source type is a parameter group, a DBParameterGroupName must be provided.
• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

Parameters:

sourceIds - The list of identifiers of the event sources for which events are returned. This parameter is required.

Returns:

this

See Also:

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

sourceType

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

The type of source that is generating the events.

For example, if you want to be notified of events generated by an instance, you would set this parameter to db-instance . If this value is not specified, all events are returned.

Valid values: db-instance , db-cluster , db-parameter-group , db-security-group , db-cluster-snapshot

Parameters:

sourceType - The type of source that is generating the events. This parameter is required.

Returns:

this

See Also:

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

subscriptionName

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

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

Parameters:

subscriptionName - The name of the subscription. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnEventSubscription build()

Specified by:

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

Returns:

a newly built instance of CfnEventSubscription.