Package software.amazon.awscdk.cfnpropertymixins.services.rds

Class CfnEventSubscriptionMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.rds.CfnEventSubscriptionMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnEventSubscriptionMixinProps>

Enclosing interface:

CfnEventSubscriptionMixinProps

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

A builder for CfnEventSubscriptionMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnEventSubscriptionMixinProps	build()	Builds the configured instance.
CfnEventSubscriptionMixinProps.Builder	enabled(Boolean enabled)	Sets the value of CfnEventSubscriptionMixinProps.getEnabled()
CfnEventSubscriptionMixinProps.Builder	enabled(IResolvable enabled)	Sets the value of CfnEventSubscriptionMixinProps.getEnabled()
CfnEventSubscriptionMixinProps.Builder	eventCategories(List<String> eventCategories)	Sets the value of CfnEventSubscriptionMixinProps.getEventCategories()
CfnEventSubscriptionMixinProps.Builder	snsTopicArn(String snsTopicArn)	Sets the value of CfnEventSubscriptionMixinProps.getSnsTopicArn()
CfnEventSubscriptionMixinProps.Builder	snsTopicArn(ITopicRef snsTopicArn)	Sets the value of CfnEventSubscriptionMixinProps.getSnsTopicArn()
CfnEventSubscriptionMixinProps.Builder	sourceIds(List<? extends Object> sourceIds)	Sets the value of CfnEventSubscriptionMixinProps.getSourceIds()
CfnEventSubscriptionMixinProps.Builder	sourceType(String sourceType)	Sets the value of CfnEventSubscriptionMixinProps.getSourceType()
CfnEventSubscriptionMixinProps.Builder	subscriptionName(String subscriptionName)	Sets the value of CfnEventSubscriptionMixinProps.getSubscriptionName()
CfnEventSubscriptionMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnEventSubscriptionMixinProps.getTags()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

enabled

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

Sets the value of CfnEventSubscriptionMixinProps.getEnabled()

Parameters:

enabled - Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Returns:

this

enabled

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

Sets the value of CfnEventSubscriptionMixinProps.getEnabled()

Parameters:

enabled - Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active.

Returns:

this

eventCategories

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

Sets the value of CfnEventSubscriptionMixinProps.getEventCategories()

Parameters:

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.

Returns:

this

snsTopicArn

@Stability(Stable)
public CfnEventSubscriptionMixinProps.Builder snsTopicArn(String snsTopicArn)

Sets the value of CfnEventSubscriptionMixinProps.getSnsTopicArn()

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.

RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide .

Returns:

this

snsTopicArn

@Stability(Stable)
public CfnEventSubscriptionMixinProps.Builder snsTopicArn(ITopicRef snsTopicArn)

Sets the value of CfnEventSubscriptionMixinProps.getSnsTopicArn()

Parameters:

snsTopicArn - The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it.

RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide .

Returns:

this

sourceIds

@Stability(Stable)
public CfnEventSubscriptionMixinProps.Builder sourceIds(List<? extends Object> sourceIds)

Sets the value of CfnEventSubscriptionMixinProps.getSourceIds()

Parameters:

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 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.
• If the source type is an RDS Proxy, a DBProxyName value must be supplied.

Returns:

this

sourceType

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

Sets the value of CfnEventSubscriptionMixinProps.getSourceType()

Parameters:

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, you set this parameter to db-instance . For RDS Proxy events, specify db-proxy . 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 | db-proxy | zero-etl | custom-engine-version | blue-green-deployment

Returns:

this

subscriptionName

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

Sets the value of CfnEventSubscriptionMixinProps.getSubscriptionName()

Parameters:

subscriptionName - The name of the subscription. Constraints: The name must be less than 255 characters.

Returns:

this

tags

@Stability(Stable)
public CfnEventSubscriptionMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnEventSubscriptionMixinProps.getTags()

Parameters:

tags - An optional array of key-value pairs to apply to this subscription.

Returns:

this

build

@Stability(Stable)
public CfnEventSubscriptionMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnEventSubscriptionMixinProps

Throws:

NullPointerException - if any required attribute was not provided