Package software.amazon.awscdk.cfnpropertymixins.services.docdb

Class CfnEventSubscriptionPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.docdb.CfnEventSubscriptionPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:58.262Z") @Stability(Stable) public class CfnEventSubscriptionPropsMixin extends Mixin implements software.constructs.IMixin
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.cfnpropertymixins.services.docdb.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnEventSubscriptionPropsMixin cfnEventSubscriptionPropsMixin = CfnEventSubscriptionPropsMixin.Builder.create(CfnEventSubscriptionMixinProps.builder()
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .snsTopicArn("snsTopicArn")
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .subscriptionName("subscriptionName")
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnEventSubscriptionPropsMixin

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

    • CfnEventSubscriptionPropsMixin

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

    • CfnEventSubscriptionPropsMixin

      @Stability(Stable) public CfnEventSubscriptionPropsMixin(@NotNull CfnEventSubscriptionMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::DocDB::EventSubscription.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnEventSubscriptionPropsMixin

      @Stability(Stable) public CfnEventSubscriptionPropsMixin(@NotNull CfnEventSubscriptionMixinProps props)
      Create a mixin to apply properties to AWS::DocDB::EventSubscription.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnEventSubscriptionMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()