Package software.amazon.awscdk.services.rds

Interface CfnEventSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:35.107Z")
@Stability(Stable)
public interface CfnEventSubscriptionProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEventSubscriptionProps.Builder	A builder for CfnEventSubscriptionProps
static final class	CfnEventSubscriptionProps.Jsii$Proxy	An implementation for CfnEventSubscriptionProps

Method Summary

Modifier and Type	Method	Description
static CfnEventSubscriptionProps.Builder	builder()
default Object	getEnabled()	Specifies whether to activate the subscription.
default List<String>	getEventCategories()	A list of event categories for a particular source type ( SourceType ) that you want to subscribe to.
String	getSnsTopicArn()	The Amazon Resource Name (ARN) of the SNS topic created for event notification.
default List<String>	getSourceIds()	The list of identifiers of the event sources for which events are returned.
default String	getSourceType()	The type of source that is generating the events.
default String	getSubscriptionName()	The name of the subscription.
default List<CfnTag>	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

@Stability(Stable)
@NotNull
String 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:

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

getEnabled

@Stability(Stable)
@Nullable
default Object 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:

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

getEventCategories

@Stability(Stable)
@Nullable
default List<String> 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:

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

getSourceIds

@Stability(Stable)
@Nullable
default List<String> 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 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.

See Also:

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

getSourceType

@Stability(Stable)
@Nullable
default String 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, 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

See Also:

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

getSubscriptionName

@Stability(Stable)
@Nullable
default String getSubscriptionName()

The name of the subscription.

Constraints: The name must be less than 255 characters.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

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

builder

@Stability(Stable)
static CfnEventSubscriptionProps.Builder builder()

Returns:

a CfnEventSubscriptionProps.Builder of CfnEventSubscriptionProps