CreateEventSubscriptionCommand

Suggest an Edit

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

You can specify the type of source (SourceType) that you want to be notified of. You can also provide a list of Amazon DocumentDB sources (SourceIds) that trigger the events, and you can provide a list of event categories (EventCategories) for events that 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 Amazon DocumentDB sources. If you do not specify either the SourceType or the SourceIdentifier, you are notified of events generated from all Amazon DocumentDB sources belonging to your customer account.

Example Syntax

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

import { DocDBClient, CreateEventSubscriptionCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, CreateEventSubscriptionCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(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. Amazon SNS creates the ARN when you create a topic and subscribe to it.

SubscriptionName
Required
string | undefined

The name of the subscription.

Constraints: The name must be fewer 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.

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 provided, SourceType must also be provided.

  • If the source type is an instance, a DBInstanceIdentifier must be provided.

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

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

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

SourceType
string | undefined

The type of source that is generating the events. For example, if you want to be notified of events generated by an 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-cluster-snapshot

Tags
Tag[] | undefined

The tags to be assigned to the event subscription.

CreateEventSubscriptionCommand Output

See CreateEventSubscriptionCommandOutput for details

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

Detailed information about an event to which you have subscribed.

Throws

Name
Fault
Details
EventSubscriptionQuotaExceededFault
client

You have reached the maximum number of event subscriptions.

SNSInvalidTopicFault
client

Amazon SNS has responded that there is a problem with the specified topic.

SNSNoAuthorizationFault
client

You do not have permission to publish to the SNS topic Amazon Resource Name (ARN).

SNSTopicArnNotFoundFault
client

The SNS topic Amazon Resource Name (ARN) does not exist.

SourceNotFoundFault
client

The requested source could not be found.

SubscriptionAlreadyExistFault
client

The provided subscription name already exists.

SubscriptionCategoryNotFoundFault
client

The provided category does not exist.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.