Class CfnEventSubscription
A CloudFormation AWS::DMS::EventSubscription
.
Inherited Members
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class CfnEventSubscription : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEventSubscription
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Use the AWS::DMS::EventSubscription
resource to get notifications for AWS Database Migration Service events through the Amazon Simple Notification Service . 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(Construct, String, ICfnEventSubscriptionProps) | Create a new |
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 |
Properties
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 | 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(Construct, String, ICfnEventSubscriptionProps)
Create a new AWS::DMS::EventSubscription
.
public CfnEventSubscription(Construct scope, string id, ICfnEventSubscriptionProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEventSubscriptionProps
- resource properties.
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
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
Indicates whether to activate the subscription.
public virtual object Enabled { get; set; }
Property Value
System.Object
Remarks
If you don't specify this property, AWS CloudFormation activates the subscription.
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[]
Remarks
If you don't specify this property, you are notified about all event categories. For more information, see Working with Events and Notifications in the AWS DMS User Guide .
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
Remarks
The ARN is created by Amazon SNS when you create a topic and subscribe to it.
SourceIds
A list of identifiers for which AWS DMS provides notification events.
public virtual string[] SourceIds { get; set; }
Property Value
System.String[]
Remarks
If you don't specify a value, notifications are provided for all sources.
If you specify multiple values, they must be of the same type. For example, if you specify a database instance ID, then all of the other values must be database instance IDs.
SourceType
The type of AWS DMS resource that generates the events.
public virtual string SourceType { get; set; }
Property Value
System.String
Remarks
For example, if you want to be notified of events generated by a replication instance, you set this parameter to replication-instance
. If this value isn't specified, all events are returned.
Valid values : replication-instance
| replication-task
SubscriptionName
The name of the AWS DMS event notification subscription.
public virtual string SubscriptionName { get; set; }
Property Value
System.String
Remarks
This name must be less than 255 characters.
Tags
One or more tags to be assigned to the event subscription.
public virtual TagManager Tags { get; }
Property Value
Remarks
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>