Package software.amazon.awscdk.services.rds

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.rds.CfnEventSubscription
All Implemented Interfaces:
IInspectable, ITaggable, IEventSubscriptionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:18.852Z") @Stability(Stable) public class CfnEventSubscription extends CfnResource implements IInspectable, IEventSubscriptionRef, ITaggable
The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

For more information, see Using Amazon RDS Event Notification in the Amazon RDS 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.rds.*;
 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)
      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

    • fromSubscriptionName

      @Stability(Stable) @NotNull public static IEventSubscriptionRef fromSubscriptionName(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String subscriptionName)
      Creates a new IEventSubscriptionRef from a subscriptionName.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      subscriptionName - 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.

    • 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 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()
      Specifies whether to activate the subscription.

    • setEnabled

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

    • setEnabled

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

    • getEventCategories

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

    • setEventCategories

      @Stability(Stable) public void setEventCategories(@Nullable List<String> value)
      A list of event categories for a particular source type ( 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.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An optional array of key-value pairs to apply to this subscription.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An optional array of key-value pairs to apply to this subscription.