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).
Inherited Members
Namespace: Amazon.CDK.AWS.RDS
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnEventSubscription : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnEventSubscription
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
For more information, see Using Amazon RDS Event Notification in the Amazon RDS User Guide .
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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEventSubscription(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnEventSubscription(Construct, String, ICfnEventSubscriptionProps) |
Properties
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Enabled | Specifies 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 | Tag Manager which manages the tags for this resource. |
TagsRaw | An optional array of key-value pairs to apply to this subscription. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEventSubscription(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEventSubscription(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEventSubscription(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEventSubscription(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnEventSubscription(Construct, String, ICfnEventSubscriptionProps)
public CfnEventSubscription(Construct scope, string id, ICfnEventSubscriptionProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnEventSubscriptionProps
Resource properties.
Properties
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Enabled
Specifies whether to activate the subscription.
public virtual object Enabled { get; set; }
Property Value
System.Object
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
System.String[]
SnsTopicArn
The Amazon Resource Name (ARN) of the SNS topic created for event notification.
public virtual string SnsTopicArn { get; set; }
Property Value
System.String
SourceIds
The list of identifiers of the event sources for which events are returned.
public virtual string[] SourceIds { get; set; }
Property Value
System.String[]
SourceType
The type of source that is generating the events.
public virtual string SourceType { get; set; }
Property Value
System.String
SubscriptionName
The name of the subscription.
public virtual string SubscriptionName { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An optional array of key-value pairs to apply to this subscription.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>