Package software.amazon.awscdk.services.docdb

Class CfnEventSubscription

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.docdb.CfnEventSubscription
All Implemented Interfaces:
IEnvironmentAware, IInspectable, IEventSubscriptionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:02.350Z") @Stability(Stable) public class CfnEventSubscription extends CfnResource implements IInspectable, IEventSubscriptionRef
Creates an Amazon DocumentDB event notification subscription.

This action requires a topic Amazon Resource Name (ARN) created by using the Amazon DocumentDB console, the Amazon SNS console, or the Amazon SNS API. To obtain an ARN with Amazon SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the Amazon SNS console.

You can specify the type of source ( SourceType ) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources ( SourceIds ) that trigger the events, and you can provide a list of event categories ( EventCategories ) for events that you want to be notified of. For example, you can specify SourceType = db-instance , SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup .

If you specify both the SourceType and SourceIds (such as SourceType = db-instance and SourceIdentifier = myDBInstance1 ), you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier , you receive notice of the events for that source type for all your Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier , you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

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.*;
 CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription")
         .snsTopicArn("snsTopicArn")
         // the properties below are optional
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .subscriptionName("subscriptionName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEventSubscription

      protected CfnEventSubscription(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEventSubscription

      protected CfnEventSubscription(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEventSubscription

      @Stability(Stable) public CfnEventSubscription(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEventSubscriptionProps props)
      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.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getEventSubscriptionRef

      @Stability(Stable) @NotNull public EventSubscriptionReference getEventSubscriptionRef()
      A reference to a EventSubscription resource.
      Specified by:
      getEventSubscriptionRef in interface IEventSubscriptionRef

    • getSnsTopicArn

      @Stability(Stable) @NotNull public String getSnsTopicArn()
      The Amazon Resource Name (ARN) of the SNS topic created for event notification.

    • setSnsTopicArn

      @Stability(Stable) public void setSnsTopicArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the SNS topic created for event notification.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      A Boolean value;

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      A Boolean value;

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      A Boolean value;

    • getEventCategories

      @Stability(Stable) @Nullable public List<String> getEventCategories()
      A list of event categories for a SourceType that you want to subscribe to.

    • setEventCategories

      @Stability(Stable) public void setEventCategories(@Nullable List<String> value)
      A list of event categories for a SourceType that you want to subscribe to.

    • getSourceIds

      @Stability(Stable) @Nullable public List<String> getSourceIds()
      The list of identifiers of the event sources for which events are returned.

    • setSourceIds

      @Stability(Stable) public void setSourceIds(@Nullable List<String> value)
      The list of identifiers of the event sources for which events are returned.

    • getSourceType

      @Stability(Stable) @Nullable public String getSourceType()
      The type of source that is generating the events.

    • setSourceType

      @Stability(Stable) public void setSourceType(@Nullable String value)
      The type of source that is generating the events.

    • getSubscriptionName

      @Stability(Stable) @Nullable public String getSubscriptionName()
      The name of the subscription.

    • setSubscriptionName

      @Stability(Stable) public void setSubscriptionName(@Nullable String value)
      The name of the subscription.