Interface CfnEventSubscriptionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnEventSubscriptionProps.Jsii$Proxy
CfnEventSubscription
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.rds.*; CfnEventSubscriptionProps cfnEventSubscriptionProps = CfnEventSubscriptionProps.builder() .snsTopicArn("snsTopicArn") // the properties below are optional .enabled(false) .eventCategories(List.of("eventCategories")) .sourceIds(List.of("sourceIds")) .sourceType("sourceType") .subscriptionName("subscriptionName") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnEventSubscriptionProps
static final class
An implementation forCfnEventSubscriptionProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Specifies whether to activate the subscription.A list of event categories for a particular source type (SourceType
) that you want to subscribe to.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.default String
The type of source that is generating the events.default String
The name of the subscription.getTags()
An optional array of key-value pairs to apply to this subscription.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getSnsTopicArn
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 .
- See Also:
-
getEnabled
Specifies whether to activate the subscription.If the event notification subscription isn't activated, the subscription is created but not active.
Default: - true
- See Also:
-
getEventCategories
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.- See Also:
-
getSourceIds
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.
- See Also:
- If
-
getSourceType
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
- See Also:
-
getSubscriptionName
The name of the subscription.Constraints: The name must be less than 255 characters.
- See Also:
-
getTags
An optional array of key-value pairs to apply to this subscription.- See Also:
-
builder
- Returns:
- a
CfnEventSubscriptionProps.Builder
ofCfnEventSubscriptionProps
-