AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Neptune::EventSubscription

CfnEventSubscription

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.

Import

import { CfnEventSubscription } from 'aws-cdk-lib/aws-neptune';

Or use the module namespace:

import * as neptune from 'aws-cdk-lib/aws-neptune';
// neptune.CfnEventSubscription

Properties

Configuration passed to the constructor as CfnEventSubscriptionProps.

snsTopicArnRequired
string

The topic ARN of the event notification subscription.

enabledOptional
boolean | IResolvable

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

Default: - true

eventCategoriesOptional
string[]

A list of event categories for a SourceType that you want to subscribe to. You can see a list of the categories for a given SourceType in the Events topic in the Amazon Neptune User Guide or by using the DescribeEventCategories action.

sourceIdsOptional
string[]

The list of identifiers of the event sources for which events will be returned. If not specified, then all sources are included in the response. An identifier must begin with a letter and must contain only ASCII letters, digits, and hyphens; it cannot end with a hyphen or contain two consecutive hyphens.

sourceTypeOptional
string

The source type for the event notification subscription.

subscriptionNameOptional
string

The name of the subscription.

tagsOptional
CfnTag[]

An array of key-value pairs to apply to this resource.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter