CreateEventSubscriptionCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NeptuneClient, CreateEventSubscriptionCommand } from "@aws-sdk/client-neptune"; // ES Modules import
// const { NeptuneClient, CreateEventSubscriptionCommand } = require("@aws-sdk/client-neptune"); // CommonJS import
const client = new NeptuneClient(config);
const input = { // CreateEventSubscriptionMessage
  SubscriptionName: "STRING_VALUE", // required
  SnsTopicArn: "STRING_VALUE", // required
  SourceType: "STRING_VALUE",
  EventCategories: [ // EventCategoriesList
    "STRING_VALUE",
  ],
  SourceIds: [ // SourceIdsList
    "STRING_VALUE",
  ],
  Enabled: true || false,
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CreateEventSubscriptionCommand(input);
const response = await client.send(command);
// { // CreateEventSubscriptionResult
//   EventSubscription: { // EventSubscription
//     CustomerAwsId: "STRING_VALUE",
//     CustSubscriptionId: "STRING_VALUE",
//     SnsTopicArn: "STRING_VALUE",
//     Status: "STRING_VALUE",
//     SubscriptionCreationTime: "STRING_VALUE",
//     SourceType: "STRING_VALUE",
//     SourceIdsList: [ // SourceIdsList
//       "STRING_VALUE",
//     ],
//     EventCategoriesList: [ // EventCategoriesList
//       "STRING_VALUE",
//     ],
//     Enabled: true || false,
//     EventSubscriptionArn: "STRING_VALUE",
//   },
// };

CreateEventSubscriptionCommand Input

See CreateEventSubscriptionCommandInput for more details

Parameter
Type
Description
SnsTopicArn
Required
string | undefined

The Amazon Resource Name (ARN) of the SNS topic created for event notification. The ARN is created by Amazon SNS when you create a topic and subscribe to it.

SubscriptionName
Required
string | undefined

The name of the subscription.

Constraints: The name must be less than 255 characters.

Enabled
boolean | undefined

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

EventCategories
string[] | undefined

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 by using the DescribeEventCategories action.

SourceIds
string[] | undefined

The list of identifiers of the event sources for which events are 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 can't end with a hyphen or contain two consecutive hyphens.

Constraints:

  • If SourceIds are supplied, SourceType must also be provided.

  • If the source type is a DB instance, then a DBInstanceIdentifier must be supplied.

  • If the source type is a DB security group, a DBSecurityGroupName must be supplied.

  • If the source type is a DB parameter group, a DBParameterGroupName must be supplied.

  • If the source type is a DB snapshot, a DBSnapshotIdentifier must be supplied.

SourceType
string | undefined

The type of source that is generating the events. For example, if you want to be notified of events generated by a DB instance, you would set this parameter to db-instance. if this value is not specified, all events are returned.

Valid values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot

Tags
Tag[] | undefined

The tags to be applied to the new event subscription.

CreateEventSubscriptionCommand Output

See CreateEventSubscriptionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EventSubscription
EventSubscription | undefined

Contains the results of a successful invocation of the DescribeEventSubscriptions action.

Throws

Name
Fault
Details
EventSubscriptionQuotaExceededFault
client

You have exceeded the number of events you can subscribe to.

SNSInvalidTopicFault
client

The SNS topic is invalid.

SNSNoAuthorizationFault
client

There is no SNS authorization.

SNSTopicArnNotFoundFault
client

The ARN of the SNS topic could not be found.

SourceNotFoundFault
client

The source could not be found.

SubscriptionAlreadyExistFault
client

This subscription already exists.

SubscriptionCategoryNotFoundFault
client

The designated subscription category could not be found.

NeptuneServiceException
Base exception class for all service exceptions from Neptune service.