replication_configuration_templates

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

Overview

Name	`replication_configuration_templates`
Type	Resource
Id	`aws.drs.replication_configuration_templates`

Fields

The following fields are returned by SELECT queries:

describe_replication_configuration_templates

Name	Datatype	Description
`arn`	`string`	The Replication Configuration Template ARN. (pattern: <code>arn:.{16,2044}</code>)
`associate_default_security_group`	`boolean`	Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration Template.
`auto_replicate_new_disks`	`boolean`	Whether to allow the AWS replication agent to automatically replicate newly added disks.
`bandwidth_throttling`	`integer (int64)`	Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.
`create_public_ip`	`boolean`	Whether to create a Public IP for the Recovery Instance by default.
`data_plane_routing`	`string`	The data plane routing mechanism that will be used for replication. (PRIVATE_IP, PUBLIC_IP)
`default_large_staging_disk_type`	`string`	The Staging Disk EBS volume type to be used during replication. (GP2, GP3, ST1, AUTO)
`ebs_encryption`	`string`	The type of EBS encryption to be used during replication. (DEFAULT, CUSTOM, NONE)
`ebs_encryption_key_arn`	`string`	The ARN of the EBS encryption key to be used during replication. (pattern: <code>arn:.{16,2044}</code>)
`internet_protocol`	`string`	Which version of the Internet Protocol to use for replication of data. (IPv4 or IPv6) (IPV4, IPV6)
`pit_policy`	`array`	The Point in time (PIT) policy to manage snapshots taken during replication.
`replication_configuration_template_id`	`string`	The Replication Configuration Template ID. (pattern: <code>rct-[0-9a-zA-Z]{17}</code>)
`replication_server_instance_type`	`string`	The instance type to be used for the replication server.
`replication_servers_security_groups_ids`	`array`	The security group IDs that will be used by the replication server.
`staging_area_subnet_id`	`string`	The subnet to be used by the replication staging area. (pattern: <code>subnet-[0-9a-fA-F]{8,}</code>)
`staging_area_tags`	`object`	A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.
`tags`	`object`	A set of tags to be associated with the Replication Configuration Template resource.
`use_dedicated_replication_server`	`boolean`	Whether to use a dedicated Replication Server in the replication staging area.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Description
`describe_replication_configuration_templates`	`select`	`region`	Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
`create_replication_configuration_template`	`insert`	`region`, `stagingAreaSubnetId`, `replicationServersSecurityGroupsIDs`, `ebsEncryption`, `bandwidthThrottling`, `stagingAreaTags`, `pitPolicy`	Creates a new ReplicationConfigurationTemplate.
`update_replication_configuration_template`	`update`	`region`, `replicationConfigurationTemplateID`	Updates a ReplicationConfigurationTemplate by ID.
`delete_replication_configuration_template`	`delete`	`region`	Deletes a single Replication Configuration Template by ID

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_configuration_templates

Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.

SELECT
arn,
associate_default_security_group,
auto_replicate_new_disks,
bandwidth_throttling,
create_public_ip,
data_plane_routing,
default_large_staging_disk_type,
ebs_encryption,
ebs_encryption_key_arn,
internet_protocol,
pit_policy,
replication_configuration_template_id,
replication_server_instance_type,
replication_servers_security_groups_ids,
staging_area_subnet_id,
staging_area_tags,
tags,
use_dedicated_replication_server
FROM aws.drs.replication_configuration_templates
WHERE region = '{{ region }}' -- required
;

`INSERT` examples

create_replication_configuration_template
Manifest

Creates a new ReplicationConfigurationTemplate.

INSERT INTO aws.drs.replication_configuration_templates (
stagingAreaSubnetId,
associateDefaultSecurityGroup,
replicationServersSecurityGroupsIDs,
replicationServerInstanceType,
useDedicatedReplicationServer,
defaultLargeStagingDiskType,
ebsEncryption,
ebsEncryptionKeyArn,
bandwidthThrottling,
dataPlaneRouting,
createPublicIP,
stagingAreaTags,
pitPolicy,
tags,
autoReplicateNewDisks,
internetProtocol,
region
)
SELECT 
'{{ stagingAreaSubnetId }}' /* required */,
{{ associateDefaultSecurityGroup }},
'{{ replicationServersSecurityGroupsIDs }}' /* required */,
'{{ replicationServerInstanceType }}',
{{ useDedicatedReplicationServer }},
'{{ defaultLargeStagingDiskType }}',
'{{ ebsEncryption }}' /* required */,
'{{ ebsEncryptionKeyArn }}',
{{ bandwidthThrottling }} /* required */,
'{{ dataPlaneRouting }}',
{{ createPublicIP }},
'{{ stagingAreaTags }}' /* required */,
'{{ pitPolicy }}' /* required */,
'{{ tags }}',
{{ autoReplicateNewDisks }},
'{{ internetProtocol }}',
'{{ region }}'
RETURNING
arn,
associate_default_security_group,
auto_replicate_new_disks,
bandwidth_throttling,
create_public_ip,
data_plane_routing,
default_large_staging_disk_type,
ebs_encryption,
ebs_encryption_key_arn,
internet_protocol,
pit_policy,
replication_configuration_template_id,
replication_server_instance_type,
replication_servers_security_groups_ids,
staging_area_subnet_id,
staging_area_tags,
tags,
use_dedicated_replication_server
;

# Description fields are for documentation purposes
- name: replication_configuration_templates
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the replication_configuration_templates resource.
  - name: stagingAreaSubnetId
    value: "{{ stagingAreaSubnetId }}"
  - name: associateDefaultSecurityGroup
    value: {{ associateDefaultSecurityGroup }}
  - name: replicationServersSecurityGroupsIDs
    value:
      - "{{ replicationServersSecurityGroupsIDs }}"
  - name: replicationServerInstanceType
    value: "{{ replicationServerInstanceType }}"
  - name: useDedicatedReplicationServer
    value: {{ useDedicatedReplicationServer }}
  - name: defaultLargeStagingDiskType
    value: "{{ defaultLargeStagingDiskType }}"
    valid_values: ['GP2', 'GP3', 'ST1', 'AUTO']
  - name: ebsEncryption
    value: "{{ ebsEncryption }}"
    valid_values: ['DEFAULT', 'CUSTOM', 'NONE']
  - name: ebsEncryptionKeyArn
    value: "{{ ebsEncryptionKeyArn }}"
  - name: bandwidthThrottling
    value: {{ bandwidthThrottling }}
  - name: dataPlaneRouting
    value: "{{ dataPlaneRouting }}"
    valid_values: ['PRIVATE_IP', 'PUBLIC_IP']
  - name: createPublicIP
    value: {{ createPublicIP }}
  - name: stagingAreaTags
    value: "{{ stagingAreaTags }}"
  - name: pitPolicy
    value:
      - ruleID: {{ ruleID }}
        units: "{{ units }}"
        interval: {{ interval }}
        retentionDuration: {{ retentionDuration }}
        enabled: {{ enabled }}
  - name: tags
    value: "{{ tags }}"
  - name: autoReplicateNewDisks
    value: {{ autoReplicateNewDisks }}
  - name: internetProtocol
    value: "{{ internetProtocol }}"
    valid_values: ['IPV4', 'IPV6']

`UPDATE` examples

update_replication_configuration_template

Updates a ReplicationConfigurationTemplate by ID.

UPDATE aws.drs.replication_configuration_templates
SET 
replicationConfigurationTemplateID = '{{ replicationConfigurationTemplateID }}',
arn = '{{ arn }}',
stagingAreaSubnetId = '{{ stagingAreaSubnetId }}',
associateDefaultSecurityGroup = {{ associateDefaultSecurityGroup }},
replicationServersSecurityGroupsIDs = '{{ replicationServersSecurityGroupsIDs }}',
replicationServerInstanceType = '{{ replicationServerInstanceType }}',
useDedicatedReplicationServer = {{ useDedicatedReplicationServer }},
defaultLargeStagingDiskType = '{{ defaultLargeStagingDiskType }}',
ebsEncryption = '{{ ebsEncryption }}',
ebsEncryptionKeyArn = '{{ ebsEncryptionKeyArn }}',
bandwidthThrottling = {{ bandwidthThrottling }},
dataPlaneRouting = '{{ dataPlaneRouting }}',
createPublicIP = {{ createPublicIP }},
stagingAreaTags = '{{ stagingAreaTags }}',
pitPolicy = '{{ pitPolicy }}',
autoReplicateNewDisks = {{ autoReplicateNewDisks }},
internetProtocol = '{{ internetProtocol }}'
WHERE 
region = '{{ region }}' --required
AND replicationConfigurationTemplateID = '{{ replicationConfigurationTemplateID }}' --required
RETURNING
arn,
associate_default_security_group,
auto_replicate_new_disks,
bandwidth_throttling,
create_public_ip,
data_plane_routing,
default_large_staging_disk_type,
ebs_encryption,
ebs_encryption_key_arn,
internet_protocol,
pit_policy,
replication_configuration_template_id,
replication_server_instance_type,
replication_servers_security_groups_ids,
staging_area_subnet_id,
staging_area_tags,
tags,
use_dedicated_replication_server;

`DELETE` examples

delete_replication_configuration_template

Deletes a single Replication Configuration Template by ID

DELETE FROM aws.drs.replication_configuration_templates
WHERE region = '{{ region }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​