replications

Creates, updates, deletes, gets or lists a replications resource.

Overview

Name	replications
Type	Resource
Id	aws.dms.replications

Fields

The following fields are returned by SELECT queries:

describe_replications

Name	Datatype	Description
marker	string	An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
replications	array	The replication descriptions.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_replications	select	region		Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.
move_replication_task	exec	region, ReplicationTaskArn, TargetReplicationInstanceArn		Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.
reboot_replication_instance	exec	region, ReplicationInstanceArn		Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.
start_replication_task	exec	region, ReplicationTaskArn, StartReplicationTaskType		Starts the replication task. For more information about DMS tasks, see Working with Migration Tasks in the Database Migration Service User Guide.
stop_replication_task	exec	region, ReplicationTaskArn		Stops the replication task.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_replications

Provides details on replication progress by returning status information for one or more provisioned DMS Serverless replications.

SELECT
marker,
replications
FROM aws.dms.replications
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

move_replication_task

Moves a replication task from its current replication instance to a different target replication instance using the specified parameters. The target replication instance must be created with the same or later DMS version as the current replication instance.

EXEC aws.dms.replications.move_replication_task 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationTaskArn": "{{ ReplicationTaskArn }}", 
"TargetReplicationInstanceArn": "{{ TargetReplicationInstanceArn }}"
}'
;

reboot_replication_instance

Reboots a replication instance. Rebooting results in a momentary outage, until the replication instance becomes available again.

EXEC aws.dms.replications.reboot_replication_instance 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationInstanceArn": "{{ ReplicationInstanceArn }}", 
"ForceFailover": {{ ForceFailover }}, 
"ForcePlannedFailover": {{ ForcePlannedFailover }}
}'
;

start_replication_task

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

EXEC aws.dms.replications.start_replication_task 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationTaskArn": "{{ ReplicationTaskArn }}", 
"StartReplicationTaskType": "{{ StartReplicationTaskType }}", 
"CdcStartTime": "{{ CdcStartTime }}", 
"CdcStartPosition": "{{ CdcStartPosition }}", 
"CdcStopPosition": "{{ CdcStopPosition }}"
}'
;

stop_replication_task

Stops the replication task.

EXEC aws.dms.replications.stop_replication_task 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationTaskArn": "{{ ReplicationTaskArn }}"
}'
;