IAmazonNeptune.CreateEventSubscription Method (CreateEventSubscriptionRequest)

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CreateEventSubscriptionAsync.

Namespace: Amazon.Neptune
Assembly: AWSSDK.Neptune.dll
Version: 3.x.y.z

Syntax

public abstract CreateEventSubscriptionResponse CreateEventSubscription(
         CreateEventSubscriptionRequest request
)

Parameters

request: Type: Amazon.Neptune.Model.CreateEventSubscriptionRequest

Container for the necessary parameters to execute the CreateEventSubscription service method.

Return Value

Type: CreateEventSubscriptionResponse

The response from the CreateEventSubscription service method, as returned by Neptune.

Exceptions

Exception	Condition
EventSubscriptionQuotaExceededException	You have exceeded the number of events you can subscribe to.
SNSInvalidTopicException	The SNS topic is invalid.
SNSNoAuthorizationException	There is no SNS authorization.
SNSTopicArnNotFoundException	The ARN of the SNS topic could not be found.
SourceNotFoundException	The source could not be found.
SubscriptionAlreadyExistException	This subscription already exists.
SubscriptionCategoryNotFoundException	The designated subscription category could not be found.

Examples

This example creates an event notification subscription.

To create an event notification subscription


var response = client.CreateEventSubscription(new CreateEventSubscriptionRequest 
{
    Enabled = true,
    EventCategories = new List<string> {
        "availability"
    },
    SnsTopicArn = "arn:aws:sns:us-east-1:992648334831:MyDemoSNSTopic",
    SourceIds = new List<string> {
        "mymysqlinstance"
    },
    SourceType = "db-instance",
    SubscriptionName = "mymysqleventsubscription"
});

EventSubscription eventSubscription = response.EventSubscription;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

IAmazonNeptune.CreateEventSubscription (CreateEventSubscriptionRequest)

Method