Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . sms ]

create-replication-job

Description

Creates a replication job. The replication job schedules periodic replication runs to replicate your server to AWS. Each replication run creates an Amazon Machine Image (AMI).

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-replication-job
--server-id <value>
--seed-replication-time <value>
[--frequency <value>]
[--run-once | --no-run-once]
[--license-type <value>]
[--role-name <value>]
[--description <value>]
[--number-of-recent-amis-to-keep <value>]
[--encrypted | --no-encrypted]
[--kms-key-id <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--server-id (string)

The identifier of the server.

--seed-replication-time (timestamp)

The seed replication time.

--frequency (integer)

The time between consecutive replication runs, in hours.

--run-once | --no-run-once (boolean)

--license-type (string)

The license type to be used for the AMI created by a successful replication run.

Possible values:

  • AWS
  • BYOL

--role-name (string)

The name of the IAM role to be used by the AWS SMS.

--description (string)

The description of the replication job.

--number-of-recent-amis-to-keep (integer)

The maximum number of SMS-created AMIs to retain. The oldest will be deleted once the maximum number is reached and a new AMI is created.

--encrypted | --no-encrypted (boolean)

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

--kms-key-id (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.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

replicationJobId -> (string)

The unique identifier of the replication job.