Package software.amazon.awscdk.services.dms

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.dms.CfnEventSubscription
All Implemented Interfaces:
IInspectable, IEventSubscriptionRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.366Z") @Stability(Stable) public class CfnEventSubscription extends CfnResource implements IInspectable, IEventSubscriptionRef, ITaggable
Use the AWS::DMS::EventSubscription resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service .

For more information, see Working with events and notifications in AWS Database Migration Service in the AWS Database Migration Service User Guide .

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.dms.*;
 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")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .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)
      Create a new AWS::DMS::EventSubscription.

      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

    • isCfnEventSubscription

      @Stability(Stable) @NotNull public static Boolean isCfnEventSubscription(@NotNull Object x)
      Checks whether the given object is a CfnEventSubscription.

      Parameters:
      x - This parameter is required.

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getSnsTopicArn

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

    • setSnsTopicArn

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

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      Indicates whether to activate the subscription.

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      Indicates whether to activate the subscription.

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      Indicates whether to activate the subscription.

    • getEventCategories

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

    • setEventCategories

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

    • getSourceIds

      @Stability(Stable) @Nullable public List<String> getSourceIds()
      A list of identifiers for which AWS DMS provides notification events.

    • setSourceIds

      @Stability(Stable) public void setSourceIds(@Nullable List<String> value)
      A list of identifiers for which AWS DMS provides notification events.

    • getSourceType

      @Stability(Stable) @Nullable public String getSourceType()
      The type of AWS DMS resource that generates the events.

    • setSourceType

      @Stability(Stable) public void setSourceType(@Nullable String value)
      The type of AWS DMS resource that generates the events.

    • getSubscriptionName

      @Stability(Stable) @Nullable public String getSubscriptionName()
      The name of the AWS DMS event notification subscription.

    • setSubscriptionName

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

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      One or more tags to be assigned to the event subscription.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      One or more tags to be assigned to the event subscription.