Class CfnEventSubscription
Use the AWS::DMS::EventSubscription
resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service .
Inherited Members
Namespace: Amazon.CDK.AWS.DMS
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 Working with events and notifications in AWS Database Migration Service in the AWS Database Migration Service User Guide .
CloudformationResource: AWS::DMS::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.DMS;
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
AttrId | |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
Enabled | Indicates whether to activate the subscription. |
EventCategories | A list of event categories for a source type that you want to subscribe to. |
SnsTopicArn | The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification. |
SourceIds | A list of identifiers for which AWS DMS provides notification events. |
SourceType | The type of AWS DMS resource that generates the events. |
SubscriptionName | The name of the AWS DMS event notification subscription. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | One or more tags to be assigned to the event 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
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
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
Indicates whether to activate the subscription.
public virtual object Enabled { get; set; }
Property Value
System.Object
EventCategories
A list of event categories for a source type that you want to subscribe to.
public virtual string[] EventCategories { get; set; }
Property Value
System.String[]
SnsTopicArn
The Amazon Resource Name (ARN) of the Amazon SNS topic created for event notification.
public virtual string SnsTopicArn { get; set; }
Property Value
System.String
SourceIds
A list of identifiers for which AWS DMS provides notification events.
public virtual string[] SourceIds { get; set; }
Property Value
System.String[]
SourceType
The type of AWS DMS resource that generates the events.
public virtual string SourceType { get; set; }
Property Value
System.String
SubscriptionName
The name of the AWS DMS event notification 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
One or more tags to be assigned to the event 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>