replication_configs

Creates, updates, deletes or gets a replication_config resource or lists replication_configs in a region

Overview

Name	replication_configs
Type	Resource
Description	A replication configuration that you later provide to configure and start a AWS DMS Serverless replication
Id	awscc.dms.replication_configs

Fields

get (all properties)

Name	Datatype	Description
replication_config_identifier	string	A unique identifier of replication configuration
replication_config_arn	string	The Amazon Resource Name (ARN) of the Replication Config
source_endpoint_arn	string	The Amazon Resource Name (ARN) of the source endpoint for this AWS DMS Serverless replication configuration
target_endpoint_arn	string	The Amazon Resource Name (ARN) of the target endpoint for this AWS DMS Serverless replication configuration
replication_type	string	The type of AWS DMS Serverless replication to provision using this replication configuration
▶compute_config	object	Configuration parameters for provisioning a AWS DMS Serverless replication
replication_settings	object	JSON settings for Servereless replications that are provisioned using this replication configuration
supplemental_settings	object	JSON settings for specifying supplemental data
resource_identifier	string	A unique value or name that you get set for a given resource that can be used to construct an Amazon Resource Name (ARN) for that resource
table_mappings	object	JSON table mappings for AWS DMS Serverless replications that are provisioned using this replication configuration
▶tags	array	<p>Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.</p>
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
replication_config_arn	string	The Amazon Resource Name (ARN) of the Replication Config
region	string	AWS region.

For more information, see AWS::DMS::ReplicationConfig.

Methods

Name	Resource	Accessible by	Required Params
create_resource	replication_configs	INSERT	ReplicationConfigIdentifier, SourceEndpointArn, TargetEndpointArn, ReplicationType, ComputeConfig, TableMappings, region
delete_resource	replication_configs	DELETE	Identifier, region
update_resource	replication_configs	UPDATE	Identifier, PatchDocument, region
list_resources	replication_configs_list_only	SELECT	region
get_resource	replication_configs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual replication_config.

SELECT
  region,
  replication_config_identifier,
  replication_config_arn,
  source_endpoint_arn,
  target_endpoint_arn,
  replication_type,
  compute_config,
  replication_settings,
  supplemental_settings,
  resource_identifier,
  table_mappings,
  tags
FROM awscc.dms.replication_configs
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ replication_config_arn }}';

list (identifiers only)

Lists all replication_configs in a region.

SELECT
  region,
  replication_config_arn
FROM awscc.dms.replication_configs_list_only
WHERE
  region = 'us-east-1';

INSERT example

Use the following StackQL query and manifest file to create a new replication_config resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO awscc.dms.replication_configs (
  ReplicationConfigIdentifier,
  SourceEndpointArn,
  TargetEndpointArn,
  ReplicationType,
  ComputeConfig,
  TableMappings,
  region
)
SELECT
  '{{ replication_config_identifier }}',
  '{{ source_endpoint_arn }}',
  '{{ target_endpoint_arn }}',
  '{{ replication_type }}',
  '{{ compute_config }}',
  '{{ table_mappings }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.dms.replication_configs (
  ReplicationConfigIdentifier,
  SourceEndpointArn,
  TargetEndpointArn,
  ReplicationType,
  ComputeConfig,
  ReplicationSettings,
  SupplementalSettings,
  ResourceIdentifier,
  TableMappings,
  Tags,
  region
)
SELECT
  '{{ replication_config_identifier }}',
  '{{ source_endpoint_arn }}',
  '{{ target_endpoint_arn }}',
  '{{ replication_type }}',
  '{{ compute_config }}',
  '{{ replication_settings }}',
  '{{ supplemental_settings }}',
  '{{ resource_identifier }}',
  '{{ table_mappings }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: replication_config
    props:
      - name: replication_config_identifier
        value: '{{ replication_config_identifier }}'
      - name: source_endpoint_arn
        value: '{{ source_endpoint_arn }}'
      - name: target_endpoint_arn
        value: '{{ target_endpoint_arn }}'
      - name: replication_type
        value: '{{ replication_type }}'
      - name: compute_config
        value:
          availability_zone: '{{ availability_zone }}'
          dns_name_servers: '{{ dns_name_servers }}'
          kms_key_id: '{{ kms_key_id }}'
          max_capacity_units: '{{ max_capacity_units }}'
          min_capacity_units: '{{ min_capacity_units }}'
          multi_az: '{{ multi_az }}'
          preferred_maintenance_window: '{{ preferred_maintenance_window }}'
          replication_subnet_group_id: '{{ replication_subnet_group_id }}'
          vpc_security_group_ids:
            - '{{ vpc_security_group_ids[0] }}'
      - name: replication_settings
        value: {}
      - name: supplemental_settings
        value: {}
      - name: resource_identifier
        value: '{{ resource_identifier }}'
      - name: table_mappings
        value: {}
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

Use the following StackQL query and manifest file to update a replication_config resource, using stack-deploy.

/*+ update */
UPDATE awscc.dms.replication_configs
SET PatchDocument = string('{{ {
    "ReplicationConfigIdentifier": replication_config_identifier,
    "SourceEndpointArn": source_endpoint_arn,
    "TargetEndpointArn": target_endpoint_arn,
    "ReplicationType": replication_type,
    "ComputeConfig": compute_config,
    "ReplicationSettings": replication_settings,
    "SupplementalSettings": supplemental_settings,
    "TableMappings": table_mappings,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ replication_config_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.dms.replication_configs
WHERE
  Identifier = '{{ replication_config_arn }}' AND
  region = 'us-east-1';

Permissions

To operate on the replication_configs resource, the following permissions are required:

Create

dms:CreateReplicationConfig,
dms:AddTagsToResource,
dms:ListTagsForResource,
iam:CreateServiceLinkedRole,
iam:AttachRolePolicy,
iam:PutRolePolicy,
iam:UpdateRoleDescription

Read

dms:DescribeReplicationConfigs,
dms:ListTagsForResource

Update

dms:ModifyReplicationConfig,
dms:AddTagsToResource,
dms:RemoveTagsFromResource,
dms:ListTagsForResource,
iam:CreateServiceLinkedRole,
iam:AttachRolePolicy,
iam:PutRolePolicy,
iam:UpdateRoleDescription

List

dms:DescribeReplicationConfigs,
dms:ListTagsForResource

Delete

dms:DescribeReplicationConfigs,
dms:DeleteReplicationConfig,
dms:ListTagsForResource,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus