[ aws . drs ]

get-replication-configuration

Description

Gets a ReplicationConfiguration, filtered by Source Server ID.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-replication-configuration
--source-server-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--source-server-id (string)

The ID of the Source Serve for this Replication Configuration.r

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

associateDefaultSecurityGroup -> (boolean)

Whether to associate the default Elastic Disaster Recovery Security group with the Replication Configuration.

bandwidthThrottling -> (long)

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

createPublicIP -> (boolean)

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

dataPlaneRouting -> (string)

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

defaultLargeStagingDiskType -> (string)

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

ebsEncryption -> (string)

The type of EBS encryption to be used during replication.

ebsEncryptionKeyArn -> (string)

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

name -> (string)

The name of the Replication Configuration.

pitPolicy -> (list)

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

(structure)

A rule in the Point in Time (PIT) policy representing when to take snapshots and how long to retain them for.

enabled -> (boolean)

Whether this rule is enabled or not.

interval -> (integer)

How often, in the chosen units, a snapshot should be taken.

retentionDuration -> (integer)

The duration to retain a snapshot for, in the chosen units.

ruleID -> (long)

The ID of the rule.

units -> (string)

The units used to measure the interval and retentionDuration.

replicatedDisks -> (list)

The configuration of the disks of the Source Server to be replicated.

(structure)

The configuration of a disk of the Source Server to be replicated.

deviceName -> (string)

The name of the device.

iops -> (long)

The requested number of I/O operations per second (IOPS).

isBootDisk -> (boolean)

Whether to boot from this disk or not.

stagingDiskType -> (string)

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

throughput -> (long)

The throughput to use for the EBS volume in MiB/s. This parameter is valid only for gp3 volumes.

replicationServerInstanceType -> (string)

The instance type to be used for the replication server.

replicationServersSecurityGroupsIDs -> (list)

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

(string)

sourceServerID -> (string)

The ID of the Source Server for this Replication Configuration.

stagingAreaSubnetId -> (string)

The subnet to be used by the replication staging area.

stagingAreaTags -> (map)

A set of tags to be associated with all resources created in the replication staging area: EC2 replication server, EBS volumes, EBS snapshots, etc.

key -> (string)

value -> (string)

useDedicatedReplicationServer -> (boolean)

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