Class CfnEventSubscription.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnEventSubscription>
- Enclosing class:
CfnEventSubscription
CfnEventSubscription
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
static CfnEventSubscription.Builder
Specifies whether to activate the subscription.enabled
(IResolvable enabled) Specifies whether to activate the subscription.eventCategories
(List<String> eventCategories) A list of event categories for a particular source type (SourceType
) that you want to subscribe to.snsTopicArn
(String snsTopicArn) The Amazon Resource Name (ARN) of the SNS topic created for event notification.The list of identifiers of the event sources for which events are returned.sourceType
(String sourceType) The type of source that is generating the events.subscriptionName
(String subscriptionName) The name of the subscription.An optional array of key-value pairs to apply to this subscription.
-
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
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 .
- Parameters:
snsTopicArn
- The Amazon Resource Name (ARN) of the SNS topic created for event notification. This parameter is required.- Returns:
this
- See Also:
-
enabled
Specifies whether to activate the subscription.If the event notification subscription isn't activated, the subscription is created but not active.
Default: - true
- Parameters:
enabled
- Specifies whether to activate the subscription. This parameter is required.- Returns:
this
- See Also:
-
enabled
Specifies whether to activate the subscription.If the event notification subscription isn't activated, the subscription is created but not active.
Default: - true
- Parameters:
enabled
- Specifies whether to activate the subscription. This parameter is required.- Returns:
this
- See Also:
-
eventCategories
@Stability(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
- See Also:
-
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.
- Parameters:
sourceIds
- The list of identifiers of the event sources for which events are returned. This parameter is required.- Returns:
this
- See Also:
- If
-
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, specifydb-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
- Parameters:
sourceType
- The type of source that is generating the events. This parameter is required.- Returns:
this
- See Also:
-
subscriptionName
The name of the subscription.Constraints: The name must be less than 255 characters.
- Parameters:
subscriptionName
- The name of the subscription. This parameter is required.- Returns:
this
- See Also:
-
tags
An optional array of key-value pairs to apply to this subscription.- Parameters:
tags
- An optional array of key-value pairs to apply to this subscription. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnEventSubscription>
- Returns:
- a newly built instance of
CfnEventSubscription
.
-