Creates an RDS event notification subscription. This action requires a topic ARN (Amazon Resource Name) 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) you want to be notified of, provide a list of RDS 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 will be notified of all the db-instance events for the specified source. If you specify a SourceType but do not specify a SourceIdentifier, you will receive notice of the events for that source type for all your RDS sources. If you do not specify either the SourceType nor the SourceIdentifier, you will be notified of events generated from all RDS sources belonging to your customer account.
Declaration Syntax| C# |
public class CreateEventSubscriptionRequest : AmazonWebServiceRequest
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | CreateEventSubscriptionRequest()()()() | Initializes a new instance of the CreateEventSubscriptionRequest class |
 | Enabled |
A Boolean value; set to true to activate the subscription, set to false to create the subscription but not active it.
|
| Equals(Object) | (Inherited from Object.) |
| EventCategories |
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 in
the Events topic in the Amazon RDS User Guide or by
using the DescribeEventCategories action.
|
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| SnsTopicArn |
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.
|
| SourceIds |
The list of identifiers of the event sources for which events will be 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 cannot end with a hyphen or
contain two consecutive hyphens. Constraints:
|
| SourceType |
The type of source that will be 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-parameter-group | db-security-group | db-snapshot
|
| SubscriptionName |
The name of the subscription. Constraints: The name must be less than 255 characters.
|
| Tags |
A list of tags.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| WithEnabled(Boolean) | Obsolete.
Sets the Enabled property
|
| WithEventCategories(array<String>[]()[][]) | Obsolete.
Adds elements to the EventCategories collection
|
| WithEventCategories(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the EventCategories collection
|
| WithSnsTopicArn(String) | Obsolete.
Sets the SnsTopicArn property
|
| WithSourceIds(array<String>[]()[][]) | Obsolete.
Adds elements to the SourceIds collection
|
| WithSourceIds(IEnumerable<(Of <<'(String>)>>)) | Obsolete.
Adds elements to the SourceIds collection
|
| WithSourceType(String) | Obsolete.
Sets the SourceType property
|
| WithSubscriptionName(String) | Obsolete.
Sets the SubscriptionName property
|
| WithTags(array<Tag>[]()[][]) | Obsolete.
Adds elements to the Tags collection
|
| WithTags(IEnumerable<(Of <<'(Tag>)>>)) | Obsolete.
Adds elements to the Tags collection
|
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceRequest | |
| CreateEventSubscriptionRequest | |