Class CfnEventSubscriptionProps
Properties for defining a CfnEventSubscription
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.AWS.RDS.dll
Syntax (csharp)
public class CfnEventSubscriptionProps : Object, ICfnEventSubscriptionProps
Syntax (vb)
Public Class CfnEventSubscriptionProps
Inherits Object
Implements ICfnEventSubscriptionProps
Remarks
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
CfnEventSubscriptionProps() |
Properties
Enabled | A value that indicates whether to activate the subscription. |
EventCategories | A list of event categories for a particular source type ( |
SnsTopicArn | The Amazon Resource Name (ARN) of the SNS topic created for event notification. |
SourceIds | The list of identifiers of the event sources for which events are returned. |
SourceType | The type of source that is generating the events. |
SubscriptionName | The name of the subscription. |
Tags | An optional array of key-value pairs to apply to this subscription. |
Constructors
CfnEventSubscriptionProps()
public CfnEventSubscriptionProps()
Properties
Enabled
A value that indicates whether to activate the subscription.
public object Enabled { get; set; }
Property Value
System.Object
Remarks
If the event notification subscription isn't activated, the subscription is created but not active.
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.String[]
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.String
Remarks
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 are returned.
public string[] SourceIds { get; set; }
Property Value
System.String[]
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.String
Remarks
For example, if you want to be notified of events generated by a DB instance, set this parameter to db-instance
. 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
SubscriptionName
The name of the subscription.
public string SubscriptionName { get; set; }
Property Value
System.String
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
ICfnTag[]