Method: Aws::Drs::Client#create_replication_configuration_template

Defined in:

lib/aws-sdk-drs/client.rb

#create_replication_configuration_template(params = {}) ⇒ Types::ReplicationConfigurationTemplate

Creates a new ReplicationConfigurationTemplate.

Examples:

Request syntax with placeholder values

resp = client.create_replication_configuration_template({
  associate_default_security_group: false, # required
  auto_replicate_new_disks: false,
  bandwidth_throttling: 1, # required
  create_public_ip: false, # required
  data_plane_routing: "PRIVATE_IP", # required, accepts PRIVATE_IP, PUBLIC_IP
  default_large_staging_disk_type: "GP2", # required, accepts GP2, GP3, ST1, AUTO
  ebs_encryption: "DEFAULT", # required, accepts DEFAULT, CUSTOM, NONE
  ebs_encryption_key_arn: "ARN",
  pit_policy: [ # required
    {
      enabled: false,
      interval: 1, # required
      retention_duration: 1, # required
      rule_id: 1,
      units: "MINUTE", # required, accepts MINUTE, HOUR, DAY
    },
  ],
  replication_server_instance_type: "EC2InstanceType", # required
  replication_servers_security_groups_i_ds: ["SecurityGroupID"], # required
  staging_area_subnet_id: "SubnetID", # required
  staging_area_tags: { # required
    "TagKey" => "TagValue",
  },
  tags: {
    "TagKey" => "TagValue",
  },
  use_dedicated_replication_server: false, # required
})

Response structure

resp.arn #=> String
resp.associate_default_security_group #=> Boolean
resp.auto_replicate_new_disks #=> Boolean
resp.bandwidth_throttling #=> Integer
resp.create_public_ip #=> Boolean
resp.data_plane_routing #=> String, one of "PRIVATE_IP", "PUBLIC_IP"
resp.default_large_staging_disk_type #=> String, one of "GP2", "GP3", "ST1", "AUTO"
resp.ebs_encryption #=> String, one of "DEFAULT", "CUSTOM", "NONE"
resp.ebs_encryption_key_arn #=> String
resp.pit_policy #=> Array
resp.pit_policy[0].enabled #=> Boolean
resp.pit_policy[0].interval #=> Integer
resp.pit_policy[0].retention_duration #=> Integer
resp.pit_policy[0].rule_id #=> Integer
resp.pit_policy[0].units #=> String, one of "MINUTE", "HOUR", "DAY"
resp.replication_configuration_template_id #=> String
resp.replication_server_instance_type #=> String
resp.replication_servers_security_groups_i_ds #=> Array
resp.replication_servers_security_groups_i_ds[0] #=> String
resp.staging_area_subnet_id #=> String
resp.staging_area_tags #=> Hash
resp.staging_area_tags["TagKey"] #=> String
resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.use_dedicated_replication_server #=> Boolean

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :associate_default_security_group (required, 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 (required, Integer) —

  Configure bandwidth throttling for the outbound data transfer rate of the Source Server in Mbps.

• :create_public_ip (required, Boolean) —

  Whether to create a Public IP for the Recovery Instance by default.

• :data_plane_routing (required, String) —

  The data plane routing mechanism that will be used for replication.

• :default_large_staging_disk_type (required, String) —

  The Staging Disk EBS volume type to be used during replication.

• :ebs_encryption (required, String) —

  The type of EBS encryption to be used during replication.

• :ebs_encryption_key_arn (String) —

  The ARN of the EBS encryption key to be used during replication.

• :pit_policy (required, Array<Types::PITPolicyRule>) —

  The Point in time (PIT) policy to manage snapshots taken during replication.

• :replication_server_instance_type (required, String) —

  The instance type to be used for the replication server.

• :replication_servers_security_groups_i_ds (required, Array<String>) —

  The security group IDs that will be used by the replication server.

• :staging_area_subnet_id (required, String) —

  The subnet to be used by the replication staging area.

• :staging_area_tags (required, Hash<String,String>) —

  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 (Hash<String,String>) —

  A set of tags to be associated with the Replication Configuration Template resource.

• :use_dedicated_replication_server (required, Boolean) —

  Whether to use a dedicated Replication Server in the replication staging area.

Returns:

• (Types::ReplicationConfigurationTemplate) —

  Returns a response object which responds to the following methods:

  • #arn => String

  • #associate_default_security_group => Boolean

  • #auto_replicate_new_disks => Boolean

  • #bandwidth_throttling => Integer

  • #create_public_ip => Boolean

  • #data_plane_routing => String

  • #default_large_staging_disk_type => String

  • #ebs_encryption => String

  • #ebs_encryption_key_arn => String

  • #pit_policy => Array&lt;Types::PITPolicyRule&gt;

  • #replication_configuration_template_id => String

  • #replication_server_instance_type => String

  • #replication_servers_security_groups_i_ds => Array&lt;String&gt;

  • #staging_area_subnet_id => String

  • #staging_area_tags => Hash&lt;String,String&gt;

  • #tags => Hash&lt;String,String&gt;

  • #use_dedicated_replication_server => Boolean

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-drs/client.rb', line 834

def create_replication_configuration_template(params = {}, options = {})
  req = build_request(:create_replication_configuration_template, params)
  req.send_request(options)
end