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.
Container for the parameters to the CreateEventSubscription operation. 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.
Namespace: Amazon.RDS.Model
Assembly: AWSSDK.RDS.dll
Version: 3.x.y.z
public class CreateEventSubscriptionRequest : AmazonRDSRequest IAmazonWebServiceRequest
The CreateEventSubscriptionRequest type exposes the following members
Name | Description | |
---|---|---|
CreateEventSubscriptionRequest() |
Name | Type | Description | |
---|---|---|---|
Enabled | System.Boolean |
Gets and sets the property Enabled. Specifies whether to activate the subscription. If the event notification subscription isn't activated, the subscription is created but not active. |
|
EventCategories | System.Collections.Generic.List<System.String> |
Gets and sets the property EventCategories.
A list of event categories for a particular source type ( |
|
SnsTopicArn | System.String |
Gets and sets the property SnsTopicArn. The Amazon Resource Name (ARN) of the SNS topic created for event notification. SNS automatically creates the ARN when you create a topic and subscribe to it. RDS doesn't support FIFO (first in, first out) topics. For more information, see Message ordering and deduplication (FIFO topics) in the Amazon Simple Notification Service Developer Guide. |
|
SourceIds | System.Collections.Generic.List<System.String> |
Gets and sets the property SourceIds. 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:
|
|
SourceType | System.String |
Gets and sets the property SourceType.
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 set this parameter to
Valid Values: |
|
SubscriptionName | System.String |
Gets and sets the property SubscriptionName. The name of the subscription. Constraints: The name must be less than 255 characters. |
|
Tags | System.Collections.Generic.List<Amazon.RDS.Model.Tag> |
Gets and sets the property Tags. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5