Package software.amazon.awscdk.services.redshift

Interface CfnEventSubscriptionProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnEventSubscriptionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.803Z") @Stability(Stable) public interface CfnEventSubscriptionProps extends software.amazon.jsii.JsiiSerializable
Properties for defining a CfnEventSubscription.

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.redshift.*;
 CfnEventSubscriptionProps cfnEventSubscriptionProps = CfnEventSubscriptionProps.builder()
         .subscriptionName("subscriptionName")
         // the properties below are optional
         .enabled(false)
         .eventCategories(List.of("eventCategories"))
         .severity("severity")
         .snsTopicArn("snsTopicArn")
         .sourceIds(List.of("sourceIds"))
         .sourceType("sourceType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Method Details

    • getSubscriptionName

      @Stability(Stable) @NotNull String getSubscriptionName()
      The name of the event subscription to be created.

      Constraints:

      • Cannot be null, empty, or blank.
      • Must contain from 1 to 255 alphanumeric characters or hyphens.
      • First character must be a letter.
      • Cannot end with a hyphen or contain two consecutive hyphens.

    • getEnabled

      @Stability(Stable) @Nullable default Object getEnabled()
      A boolean value;

      set to true to activate the subscription, and set to false to create the subscription but not activate it.

    • getEventCategories

      @Stability(Stable) @Nullable default List<String> getEventCategories()
      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: configuration, management, monitoring, security, pending

    • getSeverity

      @Stability(Stable) @Nullable default String getSeverity()
      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

      Values: ERROR, INFO

    • getSnsTopicArn

      @Stability(Stable) @Nullable default String getSnsTopicArn()
      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.

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

    • getSourceIds

      @Stability(Stable) @Nullable default List<String> getSourceIds()
      A list of one or more identifiers of Amazon Redshift source objects.

      All of the objects must be of the same type as was specified in the source type parameter. The event subscription will return only events generated by the specified objects. If not specified, then events are returned for all objects within the source type specified.

      Example: my-cluster-1, my-cluster-2

      Example: my-snapshot-20131010

    • getSourceType

      @Stability(Stable) @Nullable default String getSourceType()
      The type of source that will be generating the events.

      For example, if you want to be notified of events generated by a cluster, you would set this parameter to cluster. If this value is not specified, events are returned for all Amazon Redshift objects in your AWS account . You must specify a source type in order to specify source IDs.

      Valid values: cluster, cluster-parameter-group, cluster-security-group, cluster-snapshot, and scheduled-action.

    • getTags

      @Stability(Stable) @Nullable default List<CfnTag> getTags()
      A list of tag instances.

    • builder

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