AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . drs ]

update-launch-configuration

Description

Updates a LaunchConfiguration by Source Server ID.

See also: AWS API Documentation

Synopsis

  update-launch-configuration
[--copy-private-ip | --no-copy-private-ip]
[--copy-tags | --no-copy-tags]
[--launch-disposition <value>]
[--launch-into-instance-properties <value>]
[--licensing <value>]
[--name <value>]
[--post-launch-enabled | --no-post-launch-enabled]
--source-server-id <value>
[--target-instance-type-right-sizing-method <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--copy-private-ip | --no-copy-private-ip (boolean)

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

--copy-tags | --no-copy-tags (boolean)

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

--launch-disposition (string)

The state of the Recovery Instance in EC2 after the recovery operation.

Possible values:

  • STOPPED
  • STARTED

--launch-into-instance-properties (structure)

Launch into existing instance properties.

launchIntoEC2InstanceID -> (string)

Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.

Shorthand Syntax:

launchIntoEC2InstanceID=string

JSON Syntax:

{
  "launchIntoEC2InstanceID": "string"
}

--licensing (structure)

The licensing configuration to be used for this launch configuration.

osByol -> (boolean)

Whether to enable "Bring your own license" or not.

Shorthand Syntax:

osByol=boolean

JSON Syntax:

{
  "osByol": true|false
}

--name (string)

The name of the launch configuration.

--post-launch-enabled | --no-post-launch-enabled (boolean)

Whether we want to enable post-launch actions for the Source Server.

--source-server-id (string)

The ID of the Source Server that we want to retrieve a Launch Configuration for.

--target-instance-type-right-sizing-method (string)

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.

Possible values:

  • NONE
  • BASIC
  • IN_AWS

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

copyPrivateIp -> (boolean)

Whether we should copy the Private IP of the Source Server to the Recovery Instance.

copyTags -> (boolean)

Whether we want to copy the tags of the Source Server to the EC2 machine of the Recovery Instance.

ec2LaunchTemplateID -> (string)

The EC2 launch template ID of this launch configuration.

launchDisposition -> (string)

The state of the Recovery Instance in EC2 after the recovery operation.

launchIntoInstanceProperties -> (structure)

Launch into existing instance properties.

launchIntoEC2InstanceID -> (string)

Optionally holds EC2 instance ID of an instance to launch into, instead of launching a new instance during drill, recovery or failback.

licensing -> (structure)

The licensing configuration to be used for this launch configuration.

osByol -> (boolean)

Whether to enable "Bring your own license" or not.

name -> (string)

The name of the launch configuration.

postLaunchEnabled -> (boolean)

Whether we want to activate post-launch actions for the Source Server.

sourceServerID -> (string)

The ID of the Source Server for this launch configuration.

targetInstanceTypeRightSizingMethod -> (string)

Whether Elastic Disaster Recovery should try to automatically choose the instance type that best matches the OS, CPU, and RAM of your Source Server.