replication_configuration_templates

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

Overview

Name	replication_configuration_templates
Type	Resource
Id	aws.mgn.replication_configuration_templates

Fields

The following fields are returned by SELECT queries:

describe_replication_configuration_templates

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_replication_configuration_templates	select	region		Lists all ReplicationConfigurationTemplates, filtered by Source Server IDs.
create_replication_configuration_template	insert	region, stagingAreaSubnetId, associateDefaultSecurityGroup, replicationServersSecurityGroupsIDs, replicationServerInstanceType, useDedicatedReplicationServer, defaultLargeStagingDiskType, ebsEncryption, bandwidthThrottling, dataPlaneRouting, createPublicIP, stagingAreaTags		Creates a new ReplicationConfigurationTemplate.
update_replication_configuration_template	update	region, replicationConfigurationTemplateID		Updates multiple ReplicationConfigurationTemplates 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,
bandwidth_throttling,
create_public_ip,
data_plane_routing,
default_large_staging_disk_type,
ebs_encryption,
ebs_encryption_key_arn,
internet_protocol,
replication_configuration_template_id,
replication_server_instance_type,
replication_servers_security_groups_ids,
staging_area_subnet_id,
staging_area_tags,
storage_configuration,
store_snapshot_on_local_zone,
tags,
use_dedicated_replication_server,
use_fips_endpoint
FROM aws.mgn.replication_configuration_templates
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_replication_configuration_template

Creates a new ReplicationConfigurationTemplate.

INSERT INTO aws.mgn.replication_configuration_templates (
stagingAreaSubnetId,
associateDefaultSecurityGroup,
replicationServersSecurityGroupsIDs,
replicationServerInstanceType,
useDedicatedReplicationServer,
defaultLargeStagingDiskType,
ebsEncryption,
ebsEncryptionKeyArn,
bandwidthThrottling,
dataPlaneRouting,
createPublicIP,
stagingAreaTags,
useFipsEndpoint,
tags,
internetProtocol,
storeSnapshotOnLocalZone,
storageConfiguration,
region
)
SELECT 
'{{ stagingAreaSubnetId }}' /* required */,
{{ associateDefaultSecurityGroup }} /* required */,
'{{ replicationServersSecurityGroupsIDs }}' /* required */,
'{{ replicationServerInstanceType }}' /* required */,
{{ useDedicatedReplicationServer }} /* required */,
'{{ defaultLargeStagingDiskType }}' /* required */,
'{{ ebsEncryption }}' /* required */,
'{{ ebsEncryptionKeyArn }}',
{{ bandwidthThrottling }} /* required */,
'{{ dataPlaneRouting }}' /* required */,
{{ createPublicIP }} /* required */,
'{{ stagingAreaTags }}' /* required */,
{{ useFipsEndpoint }},
'{{ tags }}',
'{{ internetProtocol }}',
{{ storeSnapshotOnLocalZone }},
'{{ storageConfiguration }}',
'{{ region }}'
RETURNING
arn,
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,
replication_configuration_template_id,
replication_server_instance_type,
replication_servers_security_groups_ids,
staging_area_subnet_id,
staging_area_tags,
storage_configuration,
store_snapshot_on_local_zone,
tags,
use_dedicated_replication_server,
use_fips_endpoint
;

Manifest

# 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', 'ST1', 'GP3']
  - name: ebsEncryption
    value: "{{ ebsEncryption }}"
    valid_values: ['DEFAULT', 'CUSTOM']
  - 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: useFipsEndpoint
    value: {{ useFipsEndpoint }}
  - name: tags
    value: "{{ tags }}"
  - name: internetProtocol
    value: "{{ internetProtocol }}"
    valid_values: ['IPV4', 'IPV6']
  - name: storeSnapshotOnLocalZone
    value: {{ storeSnapshotOnLocalZone }}
  - name: storageConfiguration
    description: |
      Storage configuration for replication.
    value:
      storageType: "{{ storageType }}"
      fsxOntapConfiguration:
        storageVirtualMachineId: "{{ storageVirtualMachineId }}"
        credentialsSecretArn: "{{ credentialsSecretArn }}"

UPDATE examples

update_replication_configuration_template

Updates multiple ReplicationConfigurationTemplates by ID.

UPDATE aws.mgn.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 }}',
useFipsEndpoint = {{ useFipsEndpoint }},
internetProtocol = '{{ internetProtocol }}',
storeSnapshotOnLocalZone = {{ storeSnapshotOnLocalZone }},
storageConfiguration = '{{ storageConfiguration }}'
WHERE 
region = '{{ region }}' --required
AND replicationConfigurationTemplateID = '{{ replicationConfigurationTemplateID }}' --required
RETURNING
arn,
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,
replication_configuration_template_id,
replication_server_instance_type,
replication_servers_security_groups_ids,
staging_area_subnet_id,
staging_area_tags,
storage_configuration,
store_snapshot_on_local_zone,
tags,
use_dedicated_replication_server,
use_fips_endpoint;

DELETE examples

delete_replication_configuration_template

Deletes a single Replication Configuration Template by ID

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