Package software.amazon.awscdk.services.rds

Class CfnEventSubscription

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.rds.CfnEventSubscription
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.063Z") @Stability(Stable) public class CfnEventSubscription extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::EventSubscription.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnEventSubscriptionProps props)
      Create a new AWS::RDS::EventSubscription.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional array of key-value pairs to apply to this subscription.

    • getSnsTopicArn

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

      The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • setSnsTopicArn

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

      The ARN is created by Amazon SNS when you create a topic and subscribe to it.

    • getEnabled

      @Stability(Stable) @Nullable public Object getEnabled()
      A value that indicates whether to activate the subscription.

      If the event notification subscription isn't activated, the subscription is created but not active.

    • setEnabled

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

      If the event notification subscription isn't activated, the subscription is created but not active.

    • setEnabled

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

      If the event notification subscription isn't activated, the subscription is created but not active.

    • 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.

      You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

    • 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.

      You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.

    • getSourceIds

      @Stability(Stable) @Nullable public 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 a SourceIds value is supplied, SourceType must also be provided.
      • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
      • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
      • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
      • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
      • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
      • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    • setSourceIds

      @Stability(Stable) public void setSourceIds(@Nullable List<String> value)
      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 a SourceIds value is supplied, SourceType must also be provided.
      • If the source type is a DB instance, a DBInstanceIdentifier value must be supplied.
      • If the source type is a DB cluster, a DBClusterIdentifier value must be supplied.
      • If the source type is a DB parameter group, a DBParameterGroupName value must be supplied.
      • If the source type is a DB security group, a DBSecurityGroupName value must be supplied.
      • If the source type is a DB snapshot, a DBSnapshotIdentifier value must be supplied.
      • If the source type is a DB cluster snapshot, a DBClusterSnapshotIdentifier value must be supplied.

    • getSourceType

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

      For example, if you want to be notified of events generated by a DB instance, set this parameter to db-instance . If this value isn't specified, all events are returned.

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

    • setSourceType

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

      For example, if you want to be notified of events generated by a DB instance, set this parameter to db-instance . If this value isn't specified, all events are returned.

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

    • getSubscriptionName

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

      Constraints: The name must be less than 255 characters.

    • setSubscriptionName

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

      Constraints: The name must be less than 255 characters.