Package software.amazon.awscdk.services.docdb

Interface CfnEventSubscriptionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEventSubscriptionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:09.186Z")
@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.docdb.*;
 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")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-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()	A Boolean value;
default List<String>	getEventCategories()	A list of event categories for a 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.

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.

Amazon SNS creates the ARN when you create a topic and subscribe to it.

See Also:

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

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

A Boolean value;

set to true to activate the subscription, set to false to create the subscription but not active it.

See Also:

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

getEventCategories

@Stability(Stable)
@Nullable
default List<String> getEventCategories()

A list of event categories for a SourceType that you want to subscribe to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-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 SourceIds are provided, SourceType must also be provided.
• If the source type is an instance, a DBInstanceIdentifier must be provided.
• If the source type is a security group, a DBSecurityGroupName must be provided.
• If the source type is a parameter group, a DBParameterGroupName must be provided.
• If the source type is a snapshot, a DBSnapshotIdentifier must be provided.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdb-eventsubscription.html#cfn-docdb-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 an instance, you would set this parameter to db-instance . If this value is not specified, all events are returned.

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

See Also:

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

getSubscriptionName

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

The name of the subscription.

Constraints: The name must be fewer than 255 characters.

See Also:

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

builder

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

Returns:

a CfnEventSubscriptionProps.Builder of CfnEventSubscriptionProps