Package software.amazon.awscdk.services.redshift

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.redshift.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:42.800Z") @Stability(Stable) public class CfnEventSubscription extends CfnResource implements IInspectable
A CloudFormation AWS::Redshift::EventSubscription.

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

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

    • 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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      A list of tag instances.

    • getSubscriptionName

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

    • setSubscriptionName

      @Stability(Stable) public void setSubscriptionName(@NotNull String value)
      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 public Object getEnabled()
      A boolean value;

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

    • setEnabled

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

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

    • setEnabled

      @Stability(Stable) public void setEnabled(@Nullable IResolvable value)
      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 public List<String> getEventCategories()
      Specifies the Amazon Redshift event categories to be published by the event notification subscription.

      Values: configuration, management, monitoring, security, pending

    • setEventCategories

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

      Values: configuration, management, monitoring, security, pending

    • getSeverity

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

      Values: ERROR, INFO

    • setSeverity

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

      Values: ERROR, INFO

    • getSnsTopicArn

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

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

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

    • getSourceIds

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

    • setSourceIds

      @Stability(Stable) public void setSourceIds(@Nullable List<String> value)
      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 public 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.

    • setSourceType

      @Stability(Stable) public void setSourceType(@Nullable String value)
      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.