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	aws.dms.replication_configs

Fields

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	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all replication_configs in a region.

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 aws.dms.replication_configs
WHERE region = 'us-east-1';

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 aws.dms.replication_configs
WHERE region = 'us-east-1' AND data__Identifier = '<ReplicationConfigArn>';

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 aws.dms.replication_configs (
 ReplicationConfigIdentifier,
 ReplicationConfigArn,
 SourceEndpointArn,
 TargetEndpointArn,
 ReplicationType,
 ComputeConfig,
 ReplicationSettings,
 SupplementalSettings,
 ResourceIdentifier,
 TableMappings,
 Tags,
 region
)
SELECT 
'{{ ReplicationConfigIdentifier }}',
 '{{ ReplicationConfigArn }}',
 '{{ SourceEndpointArn }}',
 '{{ TargetEndpointArn }}',
 '{{ ReplicationType }}',
 '{{ ComputeConfig }}',
 '{{ ReplicationSettings }}',
 '{{ SupplementalSettings }}',
 '{{ ResourceIdentifier }}',
 '{{ TableMappings }}',
 '{{ Tags }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.dms.replication_configs (
 ReplicationConfigIdentifier,
 ReplicationConfigArn,
 SourceEndpointArn,
 TargetEndpointArn,
 ReplicationType,
 ComputeConfig,
 ReplicationSettings,
 SupplementalSettings,
 ResourceIdentifier,
 TableMappings,
 Tags,
 region
)
SELECT 
 '{{ ReplicationConfigIdentifier }}',
 '{{ ReplicationConfigArn }}',
 '{{ SourceEndpointArn }}',
 '{{ TargetEndpointArn }}',
 '{{ ReplicationType }}',
 '{{ ComputeConfig }}',
 '{{ ReplicationSettings }}',
 '{{ SupplementalSettings }}',
 '{{ ResourceIdentifier }}',
 '{{ TableMappings }}',
 '{{ 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: ReplicationConfigIdentifier
        value: '{{ ReplicationConfigIdentifier }}'
      - name: ReplicationConfigArn
        value: '{{ ReplicationConfigArn }}'
      - name: SourceEndpointArn
        value: '{{ SourceEndpointArn }}'
      - name: TargetEndpointArn
        value: '{{ TargetEndpointArn }}'
      - name: ReplicationType
        value: '{{ ReplicationType }}'
      - name: ComputeConfig
        value:
          AvailabilityZone: '{{ AvailabilityZone }}'
          DnsNameServers: '{{ DnsNameServers }}'
          KmsKeyId: '{{ KmsKeyId }}'
          MaxCapacityUnits: '{{ MaxCapacityUnits }}'
          MinCapacityUnits: '{{ MinCapacityUnits }}'
          MultiAZ: '{{ MultiAZ }}'
          PreferredMaintenanceWindow: '{{ PreferredMaintenanceWindow }}'
          ReplicationSubnetGroupId: '{{ ReplicationSubnetGroupId }}'
          VpcSecurityGroupIds:
            - '{{ VpcSecurityGroupIds[0] }}'
      - name: ReplicationSettings
        value: {}
      - name: SupplementalSettings
        value: {}
      - name: ResourceIdentifier
        value: '{{ ResourceIdentifier }}'
      - name: TableMappings
        value: {}
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.dms.replication_configs
WHERE data__Identifier = '<ReplicationConfigArn>'
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:RemoveTagsToResource,
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