replication_configurations

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

Overview

Name	replication_configurations
Type	Resource
Id	aws.mgn.replication_configurations

Fields

The following fields are returned by SELECT queries:

get_replication_configuration

Name	Datatype	Description
name	string	Replication Configuration name.
associate_default_security_group	boolean	Replication Configuration associate default Application Migration Service Security Group.
bandwidth_throttling	integer (int64)	Replication Configuration set bandwidth throttling.
create_public_ip	boolean	Replication Configuration create Public IP.
data_plane_routing	string	Replication Configuration data plane routing. (PRIVATE_IP, PUBLIC_IP)
default_large_staging_disk_type	string	Replication Configuration use default large Staging Disks. (GP2, ST1, GP3)
ebs_encryption	string	Replication Configuration EBS encryption. (DEFAULT, CUSTOM)
ebs_encryption_key_arn	string	Replication Configuration EBS encryption key ARN.
internet_protocol	string	Replication Configuration internet protocol. (IPV4, IPV6)
replicated_disks	array	Replication Configuration replicated disks.
replication_server_instance_type	string	Replication Configuration Replication Server instance type.
replication_servers_security_groups_ids	array	Replication Configuration Replication Server Security Group IDs.
source_server_id	string	Replication Configuration Source Server ID. (pattern: <code>s-[0-9a-zA-Z]{17}</code>)
staging_area_subnet_id	string	Replication Configuration Staging Area subnet ID. (pattern: <code>subnet-[0-9a-fA-F]{8,}</code>)
staging_area_tags	object	Replication Configuration Staging Area tags.
storage_configuration	object	Storage configuration for replication.
store_snapshot_on_local_zone	boolean	Replication Configuration store snapshot on local zone.
use_dedicated_replication_server	boolean	Replication Configuration use Dedicated Replication Server.
use_fips_endpoint	boolean	Replication Configuration use Fips Endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_replication_configuration	select	region		Lists all ReplicationConfigurations, filtered by Source Server ID.
update_replication_configuration	update	region, sourceServerID		Allows you to update multiple ReplicationConfigurations 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

Lists all ReplicationConfigurations, filtered by Source Server ID.

SELECT
name,
associate_default_security_group,
bandwidth_throttling,
create_public_ip,
data_plane_routing,
default_large_staging_disk_type,
ebs_encryption,
ebs_encryption_key_arn,
internet_protocol,
replicated_disks,
replication_server_instance_type,
replication_servers_security_groups_ids,
source_server_id,
staging_area_subnet_id,
staging_area_tags,
storage_configuration,
store_snapshot_on_local_zone,
use_dedicated_replication_server,
use_fips_endpoint
FROM aws.mgn.replication_configurations
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_replication_configuration

Allows you to update multiple ReplicationConfigurations by Source Server ID.

UPDATE aws.mgn.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 }}',
useFipsEndpoint = {{ useFipsEndpoint }},
accountID = '{{ accountID }}',
internetProtocol = '{{ internetProtocol }}',
storeSnapshotOnLocalZone = {{ storeSnapshotOnLocalZone }},
storageConfiguration = '{{ storageConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND sourceServerID = '{{ sourceServerID }}' --required
RETURNING
name,
associate_default_security_group,
bandwidth_throttling,
create_public_ip,
data_plane_routing,
default_large_staging_disk_type,
ebs_encryption,
ebs_encryption_key_arn,
internet_protocol,
replicated_disks,
replication_server_instance_type,
replication_servers_security_groups_ids,
source_server_id,
staging_area_subnet_id,
staging_area_tags,
storage_configuration,
store_snapshot_on_local_zone,
use_dedicated_replication_server,
use_fips_endpoint;