Class CfnEventSubscriptionProps

Properties for defining a CfnEventSubscription.

Inheritance

object

CfnEventSubscriptionProps

Implements

ICfnEventSubscriptionProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEventSubscriptionProps : ICfnEventSubscriptionProps

Syntax (vb)

Public Class CfnEventSubscriptionProps Implements ICfnEventSubscriptionProps

Remarks

See: 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

Constructors

CfnEventSubscriptionProps()

Properties for defining a CfnEventSubscription.

Properties

Enabled	Specifies 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.

Constructors

CfnEventSubscriptionProps()

Properties for defining a CfnEventSubscription.

public CfnEventSubscriptionProps()

Remarks

See: 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"
                 } }
             };

Properties

Enabled

Specifies whether to activate the subscription.

public object? Enabled { get; set; }

Property Value

object

Remarks

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

Default: - true

See: 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.

public string[]? EventCategories { get; set; }

Property Value

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.

See: 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.

public string SnsTopicArn { get; set; }

Property Value

string

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 <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-fifo-topics.html">Message ordering and deduplication (FIFO topics)</a> in the <em>Amazon Simple Notification Service Developer Guide</em> .

See: 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.

public string[]? SourceIds { get; set; }

Property Value

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:

See: 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.

public string? SourceType { get; set; }

Property Value

string

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

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

SubscriptionName

The name of the subscription.

public string? SubscriptionName { get; set; }

Property Value

string

Remarks

Constraints: The name must be less than 255 characters.

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

Tags

An optional array of key-value pairs to apply to this subscription.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

Implements

ICfnEventSubscriptionProps