Interface ICfnEventSubscriptionProps

Properties for defining a CfnEventSubscription.

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.AWS.RDS.dll

Syntax (csharp)

public interface ICfnEventSubscriptionProps

Syntax (vb)

Public Interface ICfnEventSubscriptionProps

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html

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

Properties

Enabled	A value that indicates whether to activate the subscription.
EventCategories	A list of event categories for a particular source type ( `SourceType` ) that you want to subscribe to.
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.

Properties

Enabled

A value that indicates whether to activate the subscription.

virtual object Enabled { get; }

Property Value

System.Object

Remarks

If the event notification subscription isn't activated, the subscription is created but not active.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-enabled

EventCategories

A list of event categories for a particular source type ( SourceType ) that you want to subscribe to.

virtual string[] EventCategories { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-eventcategories

SnsTopicArn

The Amazon Resource Name (ARN) of the SNS topic created for event notification.

string SnsTopicArn { get; }

Property Value

System.String

Remarks

The ARN is created by Amazon SNS when you create a topic and subscribe to it.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-snstopicarn

SourceIds

The list of identifiers of the event sources for which events are returned.

virtual string[] SourceIds { get; }

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:

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourceids

SourceType

The type of source that is generating the events.

virtual string SourceType { get; }

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-sourcetype

SubscriptionName

The name of the subscription.

virtual string SubscriptionName { get; }

Property Value

System.String

Remarks

Constraints: The name must be less than 255 characters.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-eventsubscription.html#cfn-rds-eventsubscription-subscriptionname