Class CfnEventSubscription

The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnEventSubscription

Implements

IInspectable

IEventSubscriptionRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnEventSubscription : CfnResource, IInspectable, IEventSubscriptionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnEventSubscription Inherits CfnResource Implements IInspectable, IEventSubscriptionRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

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 cfnEventSubscription = new CfnEventSubscription(this, "MyCfnEventSubscription", 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

CfnEventSubscription(Construct, string, ICfnEventSubscriptionProps)

Create a new AWS::RDS::EventSubscription.

Properties

CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).
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.
EventSubscriptionRef	A reference to a EventSubscription resource.
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	Tag Manager which manages the tags for this resource.
TagsRaw	An optional array of key-value pairs to apply to this subscription.

Methods

ArnForEventSubscription(IEventSubscriptionRef)	The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).
FromSubscriptionName(Construct, string, string)	Creates a new IEventSubscriptionRef from a subscriptionName.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnEventSubscription(object)	Checks whether the given object is a CfnEventSubscription.
RenderProperties(IDictionary<string, object>)	The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

Constructors

CfnEventSubscription(Construct, string, ICfnEventSubscriptionProps)

Create a new AWS::RDS::EventSubscription.

public CfnEventSubscription(Construct scope, string id, ICfnEventSubscriptionProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnEventSubscriptionProps

Resource properties.

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

Properties

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

CfnProperties

The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

Enabled

Specifies whether to activate the subscription.

public virtual object? Enabled { get; set; }

Property Value

object

Remarks

Type union: either bool or IResolvable

EventCategories

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

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

Property Value

string[]

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

EventSubscriptionRef

A reference to a EventSubscription resource.

public virtual IEventSubscriptionReference EventSubscriptionRef { get; }

Property Value

IEventSubscriptionReference

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

SnsTopicArn

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

public virtual string SnsTopicArn { get; set; }

Property Value

string

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

SourceIds

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

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

Property Value

string[]

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

SourceType

The type of source that is generating the events.

public virtual string? SourceType { get; set; }

Property Value

string

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

SubscriptionName

The name of the subscription.

public virtual string? SubscriptionName { get; set; }

Property Value

string

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

Methods

ArnForEventSubscription(IEventSubscriptionRef)

The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

public static string ArnForEventSubscription(IEventSubscriptionRef resource)

Parameters

resource IEventSubscriptionRef

Returns

string

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

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 cfnEventSubscription = new CfnEventSubscription(this, "MyCfnEventSubscription", 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"
                 } }
             });

FromSubscriptionName(Construct, string, string)

Creates a new IEventSubscriptionRef from a subscriptionName.

public static IEventSubscriptionRef FromSubscriptionName(Construct scope, string id, string subscriptionName)

Parameters

scope Construct

id string

subscriptionName string

Returns

IEventSubscriptionRef

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

IsCfnEventSubscription(object)

Checks whether the given object is a CfnEventSubscription.

public static bool IsCfnEventSubscription(object x)

Parameters

x object

Returns

bool

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

The AWS::RDS::EventSubscription resource allows you to receive notifications for Amazon Relational Database Service events through the Amazon Simple Notification Service (Amazon SNS).

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .

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

CloudformationResource: AWS::RDS::EventSubscription

ExampleMetadata: fixture=_generated

Implements

IInspectable

IEventSubscriptionRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable