Interface CfnEventSubscriptionProps

All Superinterfaces:
All Known Implementing Classes:

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.066Z") @Stability(Stable) public interface CfnEventSubscriptionProps extends
Properties for defining a CfnEventSubscription.


 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 CfnEventSubscriptionProps cfnEventSubscriptionProps = CfnEventSubscriptionProps.builder()
         // the properties below are optional
  • Method Details

    • getSnsTopicArn

      @Stability(Stable) @NotNull 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.

    • getEnabled

      @Stability(Stable) @Nullable default 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.

    • getEventCategories

      @Stability(Stable) @Nullable default 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.

    • getSourceIds

      @Stability(Stable) @Nullable default 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.


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

    • getSubscriptionName

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

      Constraints: The name must be less than 255 characters.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      An optional array of key-value pairs to apply to this subscription.
    • builder

      @Stability(Stable) static CfnEventSubscriptionProps.Builder builder()
      a CfnEventSubscriptionProps.Builder of CfnEventSubscriptionProps