Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can click “Customize cookies” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To continue without accepting these cookies, click “Continue without accepting.” To make more detailed choices or learn more, click “Customize cookies.”

Skip to content

/AWS1/CL_DMG=>MODIFYREPLICATIONTASK()

About ModifyReplicationTask

Modifies the specified replication task.

You can't modify the task endpoints. The task must be stopped before you can modify it.

For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.

Method Signature

IMPORTING

Required arguments:

IV_REPLICATIONTASKARN TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The Amazon Resource Name (ARN) of the replication task.

Optional arguments:

IV_REPLICATIONTASKIDENTIFIER TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

The replication task identifier.

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.

IV_MIGRATIONTYPE TYPE /AWS1/DMGMIGRATIONTYPEVALUE /AWS1/DMGMIGRATIONTYPEVALUE

The migration type. Valid values: full-load | cdc | full-load-and-cdc

IV_TABLEMAPPINGS TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

When using the CLI or boto3, provide the path of the JSON file that contains the table mappings. Precede the path with file://. For example, --table-mappings file://mappingfile.json. When working with the DMS API, provide the JSON as the parameter value.

IV_REPLICATIONTASKSETTINGS TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

JSON file that contains settings for the task, such as task metadata settings.

IV_CDCSTARTTIME TYPE /AWS1/DMGTSTAMP /AWS1/DMGTSTAMP

Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

Timestamp Example: --cdc-start-time “2018-03-08T12:12:12”

IV_CDCSTARTPOSITION TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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”

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 DMS.

IV_CDCSTOPPOSITION TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

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“

IV_TASKDATA TYPE /AWS1/DMGSTRING /AWS1/DMGSTRING

Supplemental information that the task requires to migrate the data for certain source and target endpoints. For more information, see Specifying Supplemental Data for Task Settings in the Database Migration Service User Guide.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_DMGMODIFYREPLTASKRSP /AWS1/CL_DMGMODIFYREPLTASKRSP

Domain /AWS1/RT_ACCOUNT_ID
Primitive Type NUMC