replication_configurations

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

Overview

Name	replication_configurations
Type	Resource
Id	aws.drs.replication_configurations

Fields

The following fields are returned by SELECT queries:

get_replication_configuration

Name	Datatype	Description
name	string	The name of the Replication Configuration.
associate_default_security_group	boolean	Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.
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.
replicated_disks	array	The configuration of the disks of the Source Server to be replicated.
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.
source_server_id	string	The ID of the Source Server for this Replication Configuration. (pattern: <code>s-[0-9a-zA-Z]{17}</code>)
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.
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	Optional Params	Description
get_replication_configuration	select	region		Gets a ReplicationConfiguration, filtered by Source Server ID.
update_replication_configuration	update	region, sourceServerID		Allows you to update a ReplicationConfiguration by Source Server 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

get_replication_configuration

Gets a ReplicationConfiguration, filtered by Source Server ID.

SELECT
name,
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,
replicated_disks,
replication_server_instance_type,
replication_servers_security_groups_ids,
source_server_id,
staging_area_subnet_id,
staging_area_tags,
use_dedicated_replication_server
FROM aws.drs.replication_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_replication_configuration

Allows you to update a ReplicationConfiguration by Source Server ID.

UPDATE aws.drs.replication_configurations
SET 
sourceServerID = '{{ sourceServerID }}',
name = '{{ name }}',
stagingAreaSubnetId = '{{ stagingAreaSubnetId }}',
associateDefaultSecurityGroup = {{ associateDefaultSecurityGroup }},
replicationServersSecurityGroupsIDs = '{{ replicationServersSecurityGroupsIDs }}',
replicationServerInstanceType = '{{ replicationServerInstanceType }}',
useDedicatedReplicationServer = {{ useDedicatedReplicationServer }},
defaultLargeStagingDiskType = '{{ defaultLargeStagingDiskType }}',
replicatedDisks = '{{ replicatedDisks }}',
ebsEncryption = '{{ ebsEncryption }}',
ebsEncryptionKeyArn = '{{ ebsEncryptionKeyArn }}',
bandwidthThrottling = {{ bandwidthThrottling }},
dataPlaneRouting = '{{ dataPlaneRouting }}',
createPublicIP = {{ createPublicIP }},
stagingAreaTags = '{{ stagingAreaTags }}',
pitPolicy = '{{ pitPolicy }}',
autoReplicateNewDisks = {{ autoReplicateNewDisks }},
internetProtocol = '{{ internetProtocol }}'
WHERE 
region = '{{ region }}' --required
AND sourceServerID = '{{ sourceServerID }}' --required
RETURNING
name,
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,
replicated_disks,
replication_server_instance_type,
replication_servers_security_groups_ids,
source_server_id,
staging_area_subnet_id,
staging_area_tags,
use_dedicated_replication_server;