Class CfnEventSubscriptionProps
Properties for defining a CfnEventSubscription.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventSubscriptionProps : Object, ICfnEventSubscriptionPropsSyntax (vb)
Public Class CfnEventSubscriptionProps
Inherits Object
Implements ICfnEventSubscriptionPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.RDS;
var cfnEventSubscriptionProps = new CfnEventSubscriptionProps {
SnsTopicArn = "snsTopicArn",
// the properties below are optional
Enabled = false,
EventCategories = new [] { "eventCategories" },
SourceIds = new [] { "sourceIds" },
SourceType = "sourceType",
SubscriptionName = "subscriptionName",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};Synopsis
Constructors
| Cfn |
Properties
| Enabled | Specifies whether to activate the subscription. |
| Event |
A list of event categories for a particular source type ( |
| Sns |
The Amazon Resource Name (ARN) of the SNS topic created for event notification. |
| Source |
The list of identifiers of the event sources for which events are returned. |
| Source |
The type of source that is generating the events. |
| Subscription |
The name of the subscription. |
| Tags | An optional array of key-value pairs to apply to this subscription. |
Constructors
CfnEventSubscriptionProps()
public CfnEventSubscriptionProps()Properties
Enabled
Specifies whether to activate the subscription.
public object Enabled { get; set; }Property Value
System.
Remarks
If the event notification subscription isn't activated, the subscription is created but not active.
Default: - true
EventCategories
A list of event categories for a particular source type ( SourceType ) that you want to subscribe to.
public string[] EventCategories { get; set; }Property Value
System.
Remarks
You can see a list of the categories for a given source type in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide . You can also see this list by using the DescribeEventCategories operation.
SnsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification.
public string SnsTopicArn { get; set; }Property Value
System.
Remarks
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
The list of identifiers of the event sources for which events are returned.
public string[] SourceIds { get; set; }Property Value
System.
Remarks
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
The type of source that is generating the events.
public string SourceType { get; set; }Property Value
System.
Remarks
For example, if you want to be notified of events generated by a DB instance, you set this parameter to db-instance . For RDS Proxy events, specify db-proxy . If this value isn't specified, all events are returned.
Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy | zero-etl | custom-engine-version | blue-green-deployment
SubscriptionName
The name of the subscription.
public string SubscriptionName { get; set; }Property Value
System.
Remarks
Constraints: The name must be less than 255 characters.
Tags
An optional array of key-value pairs to apply to this subscription.
public ICfnTag[] Tags { get; set; }Property Value
ICfn