CfnReplicationTaskProps

class aws_cdk.aws_dms.CfnReplicationTaskProps(*, migration_type, replication_instance_arn, source_endpoint_arn, table_mappings, target_endpoint_arn, cdc_start_position=None, cdc_start_time=None, cdc_stop_position=None, replication_task_identifier=None, replication_task_settings=None, resource_identifier=None, tags=None, task_data=None)

Bases: object

Properties for defining a CfnReplicationTask.

Parameters
  • migration_type (str) – The migration type. Valid values: full-load | cdc | full-load-and-cdc

  • replication_instance_arn (str) – The Amazon Resource Name (ARN) of a replication instance.

  • source_endpoint_arn (str) – An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

  • table_mappings (str) – The table mappings for the task, in JSON format. For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide.

  • target_endpoint_arn (str) – An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

  • cdc_start_position (Optional[str]) – Indicates when you want a change data capture (CDC) operation to start. 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, or LSN/SCN format. Date Example: –cdc-start-position “2018-03-08T12:12:12” 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” LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373” .. epigraph:: 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 .

  • cdc_start_time (Union[int, float, None]) – Indicates the start time for a change data capture (CDC) operation.

  • cdc_stop_position (Optional[str]) – Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time. Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12” Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

  • replication_task_identifier (Optional[str]) – An identifier for the replication task. Constraints: - Must contain 1-255 alphanumeric characters or hyphens. - First character must be a letter. - Cannot end with a hyphen or contain two consecutive hyphens.

  • replication_task_settings (Optional[str]) – Overall settings for the task, in JSON format. For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide.

  • resource_identifier (Optional[str]) – A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object. 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 .

  • tags (Optional[Sequence[CfnTag]]) – One or more tags to be assigned to the replication task.

  • task_data (Optional[str]) – AWS::DMS::ReplicationTask.TaskData.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_dms as dms

cfn_replication_task_props = dms.CfnReplicationTaskProps(
    migration_type="migrationType",
    replication_instance_arn="replicationInstanceArn",
    source_endpoint_arn="sourceEndpointArn",
    table_mappings="tableMappings",
    target_endpoint_arn="targetEndpointArn",

    # the properties below are optional
    cdc_start_position="cdcStartPosition",
    cdc_start_time=123,
    cdc_stop_position="cdcStopPosition",
    replication_task_identifier="replicationTaskIdentifier",
    replication_task_settings="replicationTaskSettings",
    resource_identifier="resourceIdentifier",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    task_data="taskData"
)

Attributes

cdc_start_position

Indicates when you want a change data capture (CDC) operation to start.

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, or LSN/SCN format.

Date Example: –cdc-start-position “2018-03-08T12:12:12”

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”

LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373” .. epigraph:

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 <https://docs.aws.amazon.com/dms/latest/userguide/CHAP_Source.PostgreSQL.html#CHAP_Source.PostgreSQL.ConnectionAttrib>`_ .
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstartposition

Return type

Optional[str]

cdc_start_time

Indicates the start time for a change data capture (CDC) operation.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstarttime

Return type

Union[int, float, None]

cdc_stop_position

Indicates when you want a change data capture (CDC) operation to stop.

The value can be either server time or commit time.

Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

Commit time example: –cdc-stop-position “commit_time: 2018-02-09T12:12:12 “

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-cdcstopposition

Return type

Optional[str]

migration_type

The migration type.

Valid values: full-load | cdc | full-load-and-cdc

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-migrationtype

Return type

str

replication_instance_arn

The Amazon Resource Name (ARN) of a replication instance.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationinstancearn

Return type

str

replication_task_identifier

An identifier for the replication task.

Constraints:

  • Must contain 1-255 alphanumeric characters or hyphens.

  • First character must be a letter.

  • Cannot end with a hyphen or contain two consecutive hyphens.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtaskidentifier

Return type

Optional[str]

replication_task_settings

Overall settings for the task, in JSON format.

For more information, see Specifying Task Settings for AWS Database Migration Service Tasks in the AWS Database Migration Service User Guide.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-replicationtasksettings

Return type

Optional[str]

resource_identifier

A friendly name for the resource identifier at the end of the EndpointArn response parameter that is returned in the created Endpoint object.

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-resourceidentifier

Return type

Optional[str]

source_endpoint_arn

An Amazon Resource Name (ARN) that uniquely identifies the source endpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-sourceendpointarn

Return type

str

table_mappings

The table mappings for the task, in JSON format.

For more information, see Using Table Mapping to Specify Task Settings in the AWS Database Migration Service User Guide.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tablemappings

Return type

str

tags

One or more tags to be assigned to the replication task.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-tags

Return type

Optional[List[CfnTag]]

target_endpoint_arn

An Amazon Resource Name (ARN) that uniquely identifies the target endpoint.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-targetendpointarn

Return type

str

task_data

AWS::DMS::ReplicationTask.TaskData.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dms-replicationtask.html#cfn-dms-replicationtask-taskdata

Return type

Optional[str]