Class CfnReplicationTask
A CloudFormation AWS::DMS::ReplicationTask
.
Inherited Members
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class CfnReplicationTask : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnReplicationTask
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::DMS::ReplicationTask
resource creates an AWS DMS replication task.
CloudformationResource: AWS::DMS::ReplicationTask
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.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.DMS;
var cfnReplicationTask = new CfnReplicationTask(this, "MyCfnReplicationTask", new CfnReplicationTaskProps {
MigrationType = "migrationType",
ReplicationInstanceArn = "replicationInstanceArn",
SourceEndpointArn = "sourceEndpointArn",
TableMappings = "tableMappings",
TargetEndpointArn = "targetEndpointArn",
// the properties below are optional
CdcStartPosition = "cdcStartPosition",
CdcStartTime = 123,
CdcStopPosition = "cdcStopPosition",
ReplicationTaskIdentifier = "replicationTaskIdentifier",
ReplicationTaskSettings = "replicationTaskSettings",
ResourceIdentifier = "resourceIdentifier",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
TaskData = "taskData"
});
Synopsis
Constructors
CfnReplicationTask(Construct, String, ICfnReplicationTaskProps) | Create a new |
CfnReplicationTask(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReplicationTask(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
CdcStartPosition | Indicates when you want a change data capture (CDC) operation to start. |
CdcStartTime | Indicates the start time for a change data capture (CDC) operation. |
CdcStopPosition | Indicates when you want a change data capture (CDC) operation to stop. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
MigrationType | The migration type. |
ReplicationInstanceArn | The Amazon Resource Name (ARN) of a replication instance. |
ReplicationTaskIdentifier | An identifier for the replication task. |
ReplicationTaskSettings | Overall settings for the task, in JSON format. |
ResourceIdentifier | A display name for the resource identifier at the end of the |
SourceEndpointArn | An Amazon Resource Name (ARN) that uniquely identifies the source endpoint. |
TableMappings | The table mappings for the task, in JSON format. |
Tags | One or more tags to be assigned to the replication task. |
TargetEndpointArn | An Amazon Resource Name (ARN) that uniquely identifies the target endpoint. |
TaskData |
|
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReplicationTask(Construct, String, ICfnReplicationTaskProps)
Create a new AWS::DMS::ReplicationTask
.
public CfnReplicationTask(Construct scope, string id, ICfnReplicationTaskProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnReplicationTaskProps
- resource properties.
CfnReplicationTask(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReplicationTask(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReplicationTask(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReplicationTask(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
CdcStartPosition
Indicates when you want a change data capture (CDC) operation to start.
public virtual string CdcStartPosition { get; set; }
Property Value
System.String
Remarks
Use either CdcStartPosition
or CdcStartTime
to specify when you want a CDC operation to start. Specifying both values results in an error.
The value can be in date, checkpoint, log sequence number (LSN), or system change number (SCN) format.
Here is a date example: --cdc-start-position "2018-03-08T12:12:12"
Here is a checkpoint example: --cdc-start-position "checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93"
Here is an LSN example: --cdc-start-position “mysql-bin-changelog.000024:373”
When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName
extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for AWS DMS in the AWS Database Migration Service User Guide .
CdcStartTime
Indicates the start time for a change data capture (CDC) operation.
public virtual Nullable<double> CdcStartTime { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
CdcStopPosition
Indicates when you want a change data capture (CDC) operation to stop.
public virtual string CdcStopPosition { get; set; }
Property Value
System.String
Remarks
The value can be either server time or commit time.
Here is a server time example: --cdc-stop-position "server_time:2018-02-09T12:12:12"
Here is a commit time example: --cdc-stop-position "commit_time: 2018-02-09T12:12:12"
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
MigrationType
The migration type.
public virtual string MigrationType { get; set; }
Property Value
System.String
Remarks
Valid values: full-load
| cdc
| full-load-and-cdc
ReplicationInstanceArn
The Amazon Resource Name (ARN) of a replication instance.
public virtual string ReplicationInstanceArn { get; set; }
Property Value
System.String
Remarks
ReplicationTaskIdentifier
An identifier for the replication task.
public virtual string ReplicationTaskIdentifier { get; set; }
Property Value
System.String
Remarks
ReplicationTaskSettings
Overall settings for the task, in JSON format.
public virtual string ReplicationTaskSettings { get; set; }
Property Value
System.String
Remarks
For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide .
ResourceIdentifier
A display name for the resource identifier at the end of the EndpointArn
response parameter that is returned in the created Endpoint
object.
public virtual string ResourceIdentifier { get; set; }
Property Value
System.String
Remarks
The value for this parameter can have up to 31 characters. It can contain only ASCII letters, digits, and hyphen ('-'). Also, it can't end with a hyphen or contain two consecutive hyphens, and can only begin with a letter, such as Example-App-ARN1
.
For example, this value might result in the EndpointArn
value arn:aws:dms:eu-west-1:012345678901:rep:Example-App-ARN1
. If you don't specify a ResourceIdentifier
value, AWS DMS generates a default identifier value for the end of EndpointArn
.
SourceEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.
public virtual string SourceEndpointArn { get; set; }
Property Value
System.String
Remarks
TableMappings
The table mappings for the task, in JSON format.
public virtual string TableMappings { get; set; }
Property Value
System.String
Remarks
For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide .
Tags
One or more tags to be assigned to the replication task.
public virtual TagManager Tags { get; }
Property Value
Remarks
TargetEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
public virtual string TargetEndpointArn { get; set; }
Property Value
System.String
Remarks
TaskData
AWS::DMS::ReplicationTask.TaskData
.
public virtual string TaskData { get; set; }
Property Value
System.String
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>