AWS::Neptune::EventSubscription

Creates an event notification subscription. This action requires a topic ARN (Amazon Resource Name) created by either the Neptune console, the SNS console, or the SNS API. To obtain an ARN with SNS, you must create a topic in Amazon SNS and subscribe to the topic. The ARN is displayed in the SNS console.

You can specify the type of source (SourceType) you want to be notified of, provide a list of Neptune sources (SourceIds) that triggers the events, and provide a list of event categories (EventCategories) for events you want to be notified of. For example, you can specify SourceType = db-instance, SourceIds = mydbinstance1, mydbinstance2 and EventCategories = Availability, Backup.

If you specify both the SourceType and SourceIds, such as SourceType = db-instance and SourceIdentifier = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you receive notice of the events for that source type for all your Neptune sources. If you do not specify either the SourceType nor the SourceIdentifier, you are notified of events generated from all Neptune sources belonging to your customer account.

Syntax

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

JSON

{
  "Type" : "AWS::Neptune::EventSubscription",
  "Properties" : {
      "Enabled" : Boolean,
      "EventCategories" : [ String, ... ],
      "SnsTopicArn" : String,
      "SourceIds" : [ String, ... ],
      "SourceType" : String
    }
}

YAML

Type: AWS::Neptune::EventSubscription
Properties:
  Enabled: Boolean
  EventCategories: 
    - String
  SnsTopicArn: String
  SourceIds: 
    - String
  SourceType: String

Properties

Enabled

A Boolean value indicating if the subscription is enabled. True indicates the subscription is enabled.

Required: No

Type: Boolean

Update requires: No interruption

EventCategories

Property description not available.

Required: No

Type: Array of String

Update requires: No interruption

SnsTopicArn

The topic ARN of the event notification subscription.

Required: No

Type: String

Update requires: Replacement

SourceIds

Property description not available.

Required: No

Type: Array of String

Update requires: No interruption

SourceType

The source type for the event notification subscription.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt