Package software.amazon.awscdk.services.redshift

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.redshift.CfnEventSubscription
All Implemented Interfaces:
IEnvironmentAware, IInspectable, ITaggable, IEventSubscriptionRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)", date="2025-11-10T13:40:13.483Z") @Stability(Stable) public class CfnEventSubscription extends CfnResource implements IInspectable, IEventSubscriptionRef, ITaggable
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-redshift-eventsubscription.html.

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.*;
 CfnEventSubscription cfnEventSubscription = CfnEventSubscription.Builder.create(this, "MyCfnEventSubscription")
         .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();

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

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

    • getAttrCustomerAwsId

      @Stability(Stable) @NotNull public String getAttrCustomerAwsId()
      The AWS account associated with the Amazon Redshift event notification subscription.

    • getAttrCustSubscriptionId

      @Stability(Stable) @NotNull public String getAttrCustSubscriptionId()
      The name of the Amazon Redshift event notification subscription.

    • getAttrEventCategoriesList

      @Stability(Stable) @NotNull public List<String> getAttrEventCategoriesList()
      The list of Amazon Redshift event categories specified in the event notification subscription.

      Values: Configuration, Management, Monitoring, Security, Pending

    • getAttrSourceIdsList

      @Stability(Stable) @NotNull public List<String> getAttrSourceIdsList()
      A list of the sources that publish events to the Amazon Redshift event notification subscription.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the Amazon Redshift event notification subscription.

      Constraints:

      • Can be one of the following: active | no-permission | topic-not-exist
      • The status "no-permission" indicates that Amazon Redshift no longer has permission to post to the Amazon SNS topic. The status "topic-not-exist" indicates that the topic was deleted after the subscription was created.

    • getAttrSubscriptionCreationTime

      @Stability(Stable) @NotNull public String getAttrSubscriptionCreationTime()
      The date and time the Amazon Redshift event notification subscription was created.

    • 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

    • getSubscriptionName

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

    • setSubscriptionName

      @Stability(Stable) public void setSubscriptionName(@NotNull String value)
      The name of the event subscription to be created.

    • getEnabled

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

      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable Boolean value)
      A boolean value;

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      A boolean value;

    • getEventCategories

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

    • setEventCategories

      @Stability(Stable) public void setEventCategories(@Nullable List<String> value)
      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

    • getSeverity

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

    • setSeverity

      @Stability(Stable) public void setSeverity(@Nullable String value)
      Specifies the Amazon Redshift event severity to be published by the event notification subscription.

    • getSnsTopicArn

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

    • setSnsTopicArn

      @Stability(Stable) public void setSnsTopicArn(@Nullable String value)
      The Amazon Resource Name (ARN) of the Amazon SNS topic used to transmit the event notifications.

    • getSourceIds

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

    • setSourceIds

      @Stability(Stable) public void setSourceIds(@Nullable List<String> value)
      A list of one or more identifiers of Amazon Redshift source objects.

    • getSourceType

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

    • setSourceType

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

    • getTagsRaw

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

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      A list of tag instances.