[ aws . sms ]



Creates or updates a replication configuration for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


[--app-id <value>]
[--server-group-replication-configurations <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]


--app-id (string)

ID of the application tassociated with the replication configuration.

--server-group-replication-configurations (list)

Replication configurations for server groups in the application.


Replication configuration for a server group.

serverGroupId -> (string)

Identifier of the server group this replication configuration is associated with.

serverReplicationConfigurations -> (list)

Replication configuration for servers in the server group.


Replication configuration of a server.

server -> (structure)

Identifier of the server this replication configuration is associated with.

serverId -> (string)

The identifier of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

Information about the VM server location.

vmManagerId -> (string)

The identifier of the VM manager.

vmId -> (string)

The identifier of the VM.

vmName -> (string)

The name of the VM.

vmManagerName -> (string)

The name of the VM manager.

vmManagerType -> (string)

The type of VM management product.

vmPath -> (string)

The VM folder path in the vCenter Server virtual machine inventory tree.

replicationJobId -> (string)

The identifier of the replication job.

replicationJobTerminated -> (boolean)

Indicates whether the replication job is deleted or failed.

serverReplicationParameters -> (structure)

Parameters for replicating the server.

seedTime -> (timestamp)

Seed time for creating a replication job for the server.

frequency -> (integer)

Frequency of creating replication jobs for the server.

runOnce -> (boolean)

licenseType -> (string)

License type for creating a replication job for the server.

numberOfRecentAmisToKeep -> (integer)

Number of recent AMIs to keep when creating a replication job for this server.

encrypted -> (boolean)

When true, the replication job produces encrypted AMIs. See also KmsKeyId below.

kmsKeyId -> (string)

KMS key ID for replication jobs that produce encrypted AMIs. Can be any of the following:

  • KMS key ID

  • KMS key alias

  • ARN referring to KMS key ID

  • ARN referring to KMS key alias

If encrypted is true but a KMS key id is not specified, the customer’s default KMS key for EBS is used.

JSON Syntax:

    "serverGroupId": "string",
    "serverReplicationConfigurations": [
        "server": {
          "serverId": "string",
          "serverType": "VIRTUAL_MACHINE",
          "vmServer": {
            "vmServerAddress": {
              "vmManagerId": "string",
              "vmId": "string"
            "vmName": "string",
            "vmManagerName": "string",
            "vmManagerType": "VSPHERE"|"SCVMM"|"HYPERV-MANAGER",
            "vmPath": "string"
          "replicationJobId": "string",
          "replicationJobTerminated": true|false
        "serverReplicationParameters": {
          "seedTime": timestamp,
          "frequency": integer,
          "runOnce": true|false,
          "licenseType": "AWS"|"BYOL",
          "numberOfRecentAmisToKeep": integer,
          "encrypted": true|false,
          "kmsKeyId": "string"

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.