Class CfnReplicationTaskProps
Properties for defining a CfnReplicationTask
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.DMS
Assembly: Amazon.CDK.AWS.DMS.dll
Syntax (csharp)
public class CfnReplicationTaskProps : Object, ICfnReplicationTaskProps
Syntax (vb)
Public Class CfnReplicationTaskProps
Inherits Object
Implements ICfnReplicationTaskProps
Remarks
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 cfnReplicationTaskProps = 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
CfnReplicationTaskProps() |
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. |
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 |
|
Constructors
CfnReplicationTaskProps()
public CfnReplicationTaskProps()
Properties
CdcStartPosition
Indicates when you want a change data capture (CDC) operation to start.
public 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 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 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"
MigrationType
The migration type.
public 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 string ReplicationInstanceArn { get; set; }
Property Value
System.String
Remarks
ReplicationTaskIdentifier
An identifier for the replication task.
public string ReplicationTaskIdentifier { get; set; }
Property Value
System.String
Remarks
ReplicationTaskSettings
Overall settings for the task, in JSON format.
public 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 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 string SourceEndpointArn { get; set; }
Property Value
System.String
Remarks
TableMappings
The table mappings for the task, in JSON format.
public 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 ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
TargetEndpointArn
An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.
public string TargetEndpointArn { get; set; }
Property Value
System.String
Remarks
TaskData
AWS::DMS::ReplicationTask.TaskData
.
public string TaskData { get; set; }
Property Value
System.String