AWS::Redshift::EventSubscription

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Redshift::EventSubscription",
  "Properties" : {
      "Enabled" : Boolean,
      "EventCategories" : [ String, ... ],
      "Severity" : String,
      "SnsTopicArn" : String,
      "SourceIds" : [ String, ... ],
      "SourceType" : String,
      "SubscriptionName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Redshift::EventSubscription
Properties:
  Enabled: Boolean
  EventCategories: 
    - String
  Severity: String
  SnsTopicArn: String
  SourceIds: 
    - String
  SourceType: String
  SubscriptionName: String
  Tags: 
    - Tag

Properties

Enabled

A boolean value; set to true to activate the subscription, and set to false to create the subscription but not activate it.

Required: No

Type: Boolean

Update requires: No interruption

EventCategories

Specifies the Amazon Redshift event categories to be published by the event notification subscription.

Values: configuration, management, monitoring, security, pending

Required: No

Type: Array of String

Allowed values: configuration | management | monitoring | security | pending

Update requires: No interruption

Severity

Specifies the Amazon Redshift event severity to be published by the event notification subscription.

Values: ERROR, INFO

Required: No

Type: String

Allowed values: ERROR | INFO

Update requires: No interruption

SnsTopicArn

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.

Required: No

Type: String

Maximum: 2147483647

Update requires: No interruption

SourceIds

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

Required: No

Type: Array of String

Update requires: No interruption

SourceType

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.

Required: No

Type: String

Allowed values: cluster | cluster-parameter-group | cluster-security-group | cluster-snapshot | scheduled-action

Update requires: No interruption

SubscriptionName

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.

Required: Yes

Type: String

Pattern: ^(?=^[a-zA-Z][a-zA-Z0-9]*(-[a-zA-Z0-9]+)*$).{1,255}$

Update requires: Replacement

Tags

A list of tag instances.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "mySubscriptionName" }

For the Amazon Redshift EventSubscription, Ref returns the name of the subscription.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CustomerAwsId

The AWS account associated with the Amazon Redshift event notification subscription.

CustSubscriptionId

The name of the Amazon Redshift event notification subscription.

EventCategoriesList

The list of Amazon Redshift event categories specified in the event notification subscription.

Values: Configuration, Management, Monitoring, Security, Pending

SourceIdsList

A list of the sources that publish events to the Amazon Redshift event notification subscription.

Status

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.

SubscriptionCreationTime

The date and time the Amazon Redshift event notification subscription was created.