Method: Aws::Drs::Client#update_replication_configuration_template

Defined in:
lib/aws-sdk-drs/client.rb

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

Updates a ReplicationConfigurationTemplate by ID.

Examples:

Request syntax with placeholder values


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

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):

  • :arn (String)

    The Replication Configuration Template ARN.

  • :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)

    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.

  • :default_large_staging_disk_type (String)

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

  • :ebs_encryption (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 (Array<Types::PITPolicyRule>)

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

  • :replication_configuration_template_id (required, String)

    The Replication Configuration Template ID.

  • :replication_server_instance_type (String)

    The instance type to be used for the replication server.

  • :replication_servers_security_groups_i_ds (Array<String>)

    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.

  • :staging_area_tags (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.

  • :use_dedicated_replication_server (Boolean)

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

Returns:

See Also:



3549
3550
3551
3552
# File 'lib/aws-sdk-drs/client.rb', line 3549

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