AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Creates an RDS event notification subscription. This operation requires a topic Amazon Resource Name (ARN) created by either the RDS 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) that you want to be notified of and provide a list of RDS sources (SourceIds) that triggers the events. You can also 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 SourceIds = myDBInstance1, you are notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify SourceIds, you receive notice of the events for that source type for all your RDS sources. If you don't specify either the SourceType or the SourceIds, you are notified of events generated from all RDS sources belonging to your customer account.

For more information about subscribing to an event for RDS DB engines, see Subscribing to Amazon RDS event notification in the Amazon RDS User Guide.

For more information about subscribing to an event for Aurora DB engines, see Subscribing to Amazon RDS event notification in the Amazon Aurora User Guide.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginCreateEventSubscription and EndCreateEventSubscription.

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

Syntax

C#
public abstract Task<CreateEventSubscriptionResponse> CreateEventSubscriptionAsync(
         CreateEventSubscriptionRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.RDS.Model.CreateEventSubscriptionRequest

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

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


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

Exceptions

ExceptionCondition
EventSubscriptionQuotaExceededException You have reached the maximum number of event subscriptions.
SNSInvalidTopicException SNS has responded that there is a problem with the SNS topic specified.
SNSNoAuthorizationException You do not have permission to publish to the SNS topic ARN.
SNSTopicArnNotFoundException The SNS topic ARN does not exist.
SourceNotFoundException The requested source could not be found.
SubscriptionAlreadyExistException The supplied subscription name already exists.
SubscriptionCategoryNotFoundException The supplied category does not exist.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also