replication_configs

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

Overview

Name	replication_configs
Type	Resource
Id	aws.dms.replication_configs

Fields

The following fields are returned by SELECT queries:

describe_replication_configs

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.
replication_configs	array	Returned configuration parameters that describe each provisioned DMS Serverless replication.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_replication_configs	select	region		Returns one or more existing DMS Serverless replication configurations as a list of structures.
create_replication_config	insert	region, ReplicationConfigIdentifier, SourceEndpointArn, TargetEndpointArn, ComputeConfig, ReplicationType, TableMappings		Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.
modify_replication_config	update	region, ReplicationConfigArn		Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it. Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.
delete_replication_config	delete	region		Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.
reload_replication_tables	exec	region, ReplicationConfigArn, TablesToReload		Reloads the target database table with the source data for a given DMS Serverless replication configuration. You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.
start_replication	exec	region, ReplicationConfigArn, StartReplicationType		For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.
stop_replication	exec	region, ReplicationConfigArn		For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.

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_replication_configs

Returns one or more existing DMS Serverless replication configurations as a list of structures.

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

INSERT examples

create_replication_config

Creates a configuration that you can later provide to configure and start an DMS Serverless replication. You can also provide options to validate the configuration inputs before you start the replication.

INSERT INTO aws.dms.replication_configs (
ReplicationConfigIdentifier,
SourceEndpointArn,
TargetEndpointArn,
ComputeConfig,
ReplicationType,
TableMappings,
ReplicationSettings,
SupplementalSettings,
ResourceIdentifier,
Tags,
region
)
SELECT 
'{{ ReplicationConfigIdentifier }}' /* required */,
'{{ SourceEndpointArn }}' /* required */,
'{{ TargetEndpointArn }}' /* required */,
'{{ ComputeConfig }}' /* required */,
'{{ ReplicationType }}' /* required */,
'{{ TableMappings }}' /* required */,
'{{ ReplicationSettings }}',
'{{ SupplementalSettings }}',
'{{ ResourceIdentifier }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
replication_config
;

Manifest

# Description fields are for documentation purposes
- name: replication_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the replication_configs resource.
  - name: ReplicationConfigIdentifier
    value: "{{ ReplicationConfigIdentifier }}"
    description: |
      A unique identifier that you want to use to create a ReplicationConfigArn that is returned as part of the output from this action. You can then pass this output ReplicationConfigArn as the value of the ReplicationConfigArn option for other actions to identify both DMS Serverless replications and replication configurations that you want those actions to operate on. For some actions, you can also use either this unique identifier or a corresponding ARN in action filters to identify the specific replication and replication configuration to operate on.
  - name: SourceEndpointArn
    value: "{{ SourceEndpointArn }}"
    description: |
      The Amazon Resource Name (ARN) of the source endpoint for this DMS Serverless replication configuration.
  - name: TargetEndpointArn
    value: "{{ TargetEndpointArn }}"
    description: |
      The Amazon Resource Name (ARN) of the target endpoint for this DMS serverless replication configuration.
  - name: ComputeConfig
    description: |
      Configuration parameters for provisioning an DMS Serverless replication.
    value:
      AvailabilityZone: "{{ AvailabilityZone }}"
      DnsNameServers: "{{ DnsNameServers }}"
      KmsKeyId: "{{ KmsKeyId }}"
      MaxCapacityUnits: {{ MaxCapacityUnits }}
      MinCapacityUnits: {{ MinCapacityUnits }}
      MultiAZ: {{ MultiAZ }}
      PreferredMaintenanceWindow: "{{ PreferredMaintenanceWindow }}"
      ReplicationSubnetGroupId: "{{ ReplicationSubnetGroupId }}"
      VpcSecurityGroupIds:
        - "{{ VpcSecurityGroupIds }}"
  - name: ReplicationType
    value: "{{ ReplicationType }}"
    description: |
      The type of DMS Serverless replication to provision using this replication configuration. Possible values: "full-load" "cdc" "full-load-and-cdc"
    valid_values: ['full-load', 'cdc', 'full-load-and-cdc']
  - name: TableMappings
    value: "{{ TableMappings }}"
    description: |
      JSON table mappings for DMS Serverless replications that are provisioned using this replication configuration. For more information, see Specifying table selection and transformations rules using JSON.
  - name: ReplicationSettings
    value: "{{ ReplicationSettings }}"
    description: |
      Optional JSON settings for DMS Serverless replications that are provisioned using this replication configuration. For example, see Change processing tuning settings.
  - name: SupplementalSettings
    value: "{{ SupplementalSettings }}"
    description: |
      Optional JSON settings for specifying supplemental data. For more information, see Specifying supplemental data for task settings.
  - name: ResourceIdentifier
    value: "{{ ResourceIdentifier }}"
    description: |
      Optional unique value or name that you set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource. For more information, see Fine-grained access control using resource names and tags.
  - name: Tags
    description: |
      One or more optional tags associated with resources used by the DMS Serverless replication. For more information, see Tagging resources in Database Migration Service.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
        ResourceArn: "{{ ResourceArn }}"

UPDATE examples

modify_replication_config

Modifies an existing DMS Serverless replication configuration that you can use to start a replication. This command includes input validation and logic to check the state of any replication that uses this configuration. You can only modify a replication configuration before any replication that uses it has started. As soon as you have initially started a replication with a given configuiration, you can't modify that configuration, even if you stop it. Other run statuses that allow you to run this command include FAILED and CREATED. A provisioning state that allows you to run this command is FAILED_PROVISION.

UPDATE aws.dms.replication_configs
SET 
ReplicationConfigArn = '{{ ReplicationConfigArn }}',
ReplicationConfigIdentifier = '{{ ReplicationConfigIdentifier }}',
ReplicationType = '{{ ReplicationType }}',
TableMappings = '{{ TableMappings }}',
ReplicationSettings = '{{ ReplicationSettings }}',
SupplementalSettings = '{{ SupplementalSettings }}',
ComputeConfig = '{{ ComputeConfig }}',
SourceEndpointArn = '{{ SourceEndpointArn }}',
TargetEndpointArn = '{{ TargetEndpointArn }}'
WHERE 
region = '{{ region }}' --required
AND ReplicationConfigArn = '{{ ReplicationConfigArn }}' --required
RETURNING
replication_config;

DELETE examples

delete_replication_config

Deletes an DMS Serverless replication configuration. This effectively deprovisions any and all replications that use this configuration. You can't delete the configuration for an DMS Serverless replication that is ongoing. You can delete the configuration when the replication is in a non-RUNNING and non-STARTING state.

DELETE FROM aws.dms.replication_configs
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

reload_replication_tables

Reloads the target database table with the source data for a given DMS Serverless replication configuration. You can only use this operation with a task in the RUNNING state, otherwise the service will throw an InvalidResourceStateFault exception.

EXEC aws.dms.replication_configs.reload_replication_tables 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationConfigArn": "{{ ReplicationConfigArn }}", 
"TablesToReload": "{{ TablesToReload }}", 
"ReloadOption": "{{ ReloadOption }}"
}'
;

start_replication

For a given DMS Serverless replication configuration, DMS connects to the source endpoint and collects the metadata to analyze the replication workload. Using this metadata, DMS then computes and provisions the required capacity and starts replicating to the target endpoint using the server resources that DMS has provisioned for the DMS Serverless replication.

EXEC aws.dms.replication_configs.start_replication 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationConfigArn": "{{ ReplicationConfigArn }}", 
"StartReplicationType": "{{ StartReplicationType }}", 
"PremigrationAssessmentSettings": "{{ PremigrationAssessmentSettings }}", 
"CdcStartTime": "{{ CdcStartTime }}", 
"CdcStartPosition": "{{ CdcStartPosition }}", 
"CdcStopPosition": "{{ CdcStopPosition }}"
}'
;

stop_replication

For a given DMS Serverless replication configuration, DMS stops any and all ongoing DMS Serverless replications. This command doesn't deprovision the stopped replications.

EXEC aws.dms.replication_configs.stop_replication 
@region='{{ region }}' --required 
@@json=
'{
"ReplicationConfigArn": "{{ ReplicationConfigArn }}"
}'
;