software.amazon.awscdk.services.rds

Class CfnEventSubscription.Builder

java.lang.Object

software.amazon.awscdk.services.rds.CfnEventSubscription.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventSubscription>

Enclosing class:

CfnEventSubscription

@Stability(value=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 and Description
CfnEventSubscription	build()
static CfnEventSubscription.Builder	create(software.constructs.Construct scope, String id)
CfnEventSubscription.Builder	enabled(Boolean enabled) A value that indicates whether to activate the subscription.
CfnEventSubscription.Builder	enabled(IResolvable enabled) A value that indicates whether to activate the subscription.
CfnEventSubscription.Builder	eventCategories(List<String> eventCategories) A list of event categories for a particular source type ( `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) `AWS::RDS::EventSubscription.SubscriptionName`.
CfnEventSubscription.Builder	tags(List<? extends CfnTag> tags) `AWS::RDS::EventSubscription.Tags`.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=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 - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnEventSubscription.Builder.

snsTopicArn

@Stability(value=Stable)
public CfnEventSubscription.Builder snsTopicArn(String snsTopicArn)

The Amazon Resource Name (ARN) of the 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 SNS topic created for event notification. This parameter is required.

Returns:

this

enabled

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

A value that indicates whether to activate the subscription.

If the event notification subscription isn't activated, the subscription is created but not active.

Parameters:

enabled - A value that indicates whether to activate the subscription. This parameter is required.

Returns:

this

enabled

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

A value that indicates whether to activate the subscription.

If the event notification subscription isn't activated, the subscription is created but not active.

Parameters:

enabled - A value that indicates whether to activate the subscription. This parameter is required.

Returns:

this

eventCategories

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

A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to.

You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

Parameters:

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

Returns:

this

sourceIds

@Stability(value=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 a SourceIds value is supplied, SourceType must also be provided.
• If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
• If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
• If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
• If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
• If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
• If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

Parameters:

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

Returns:

this

sourceType

@Stability(value=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 a DB instance, set this parameter to db-instance . If this value isn't specified, all events are returned.

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

Parameters:

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

Returns:

this

subscriptionName

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

`AWS::RDS::EventSubscription.SubscriptionName`.

Parameters:

subscriptionName - `AWS::RDS::EventSubscription.SubscriptionName`. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnEventSubscription.Builder tags(List<? extends CfnTag> tags)

`AWS::RDS::EventSubscription.Tags`.

Parameters:

tags - `AWS::RDS::EventSubscription.Tags`. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnEventSubscription build()

Specified by:

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