AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . mgn ]

update-launch-configuration-template

Description

Updates an existing Launch Configuration Template by ID.

See also: AWS API Documentation

Synopsis

  update-launch-configuration-template
--launch-configuration-template-id <value>
[--post-launch-actions <value>]
[--enable-map-auto-tagging | --no-enable-map-auto-tagging]
[--map-auto-tagging-mpe-id <value>]
[--launch-disposition <value>]
[--target-instance-type-right-sizing-method <value>]
[--copy-private-ip | --no-copy-private-ip]
[--associate-public-ip-address | --no-associate-public-ip-address]
[--copy-tags | --no-copy-tags]
[--licensing <value>]
[--boot-mode <value>]
[--small-volume-max-size <value>]
[--small-volume-conf <value>]
[--large-volume-conf <value>]
[--enable-parameters-encryption | --no-enable-parameters-encryption]
[--parameters-encryption-key <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>]
[--v2-debug]

Options

--launch-configuration-template-id (string)

Launch Configuration Template ID.

--post-launch-actions (structure)

Post Launch Action to execute on the Test or Cutover instance.

deployment -> (string)

Deployment type in which AWS Systems Manager Documents will be executed.

s3LogBucket -> (string)

AWS Systems Manager Command’s logs S3 log bucket.

s3OutputKeyPrefix -> (string)

AWS Systems Manager Command’s logs S3 output key prefix.

cloudWatchLogGroupName -> (string)

AWS Systems Manager Command’s CloudWatch log group name.

ssmDocuments -> (list)

AWS Systems Manager Documents.

(structure)

AWS Systems Manager Document.

actionName -> (string)

User-friendly name for the AWS Systems Manager Document.

ssmDocumentName -> (string)

AWS Systems Manager Document name or full ARN.

timeoutSeconds -> (integer)

AWS Systems Manager Document timeout seconds.

mustSucceedForCutover -> (boolean)

If true, Cutover will not be enabled if the document has failed.

parameters -> (map)

AWS Systems Manager Document parameters.

key -> (string)

value -> (list)

(structure)

AWS Systems Manager Parameter Store parameter.

parameterType -> (string)

AWS Systems Manager Parameter Store parameter type.

parameterName -> (string)

AWS Systems Manager Parameter Store parameter name.

externalParameters -> (map)

AWS Systems Manager Document external parameters.

key -> (string)

value -> (tagged union structure)

AWS Systems Manager Document external parameter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.

dynamicPath -> (string)

AWS Systems Manager Document external parameters dynamic path.

JSON Syntax:

{
  "deployment": "TEST_AND_CUTOVER"|"CUTOVER_ONLY"|"TEST_ONLY",
  "s3LogBucket": "string",
  "s3OutputKeyPrefix": "string",
  "cloudWatchLogGroupName": "string",
  "ssmDocuments": [
    {
      "actionName": "string",
      "ssmDocumentName": "string",
      "timeoutSeconds": integer,
      "mustSucceedForCutover": true|false,
      "parameters": {"string": [
            {
              "parameterType": "STRING"|"SECURE_STRING",
              "parameterName": "string"
            }
            ...
          ]
        ...},
      "externalParameters": {"string": {
            "dynamicPath": "string"
          }
        ...}
    }
    ...
  ]
}

--enable-map-auto-tagging | --no-enable-map-auto-tagging (boolean)

Enable map auto tagging.

--map-auto-tagging-mpe-id (string)

Launch configuration template map auto tagging MPE ID.

--launch-disposition (string)

Launch disposition.

Possible values:

  • STOPPED
  • STARTED

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

Target instance type right-sizing method.

Possible values:

  • NONE
  • BASIC

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

Copy private Ip.

--associate-public-ip-address | --no-associate-public-ip-address (boolean)

Associate public Ip address.

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

Copy tags.

--licensing (structure)

Configure Licensing.

osByol -> (boolean)

Configure BYOL OS licensing.

Shorthand Syntax:

osByol=boolean

JSON Syntax:

{
  "osByol": true|false
}

--boot-mode (string)

Launch configuration template boot mode.

Possible values:

  • LEGACY_BIOS
  • UEFI
  • USE_SOURCE

--small-volume-max-size (long)

Small volume maximum size.

--small-volume-conf (structure)

Small volume config.

volumeType -> (string)

Launch template disk volume type configuration.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

Shorthand Syntax:

volumeType=string,iops=long,throughput=long

JSON Syntax:

{
  "volumeType": "io1"|"io2"|"gp3"|"gp2"|"st1"|"sc1"|"standard",
  "iops": long,
  "throughput": long
}

--large-volume-conf (structure)

Large volume config.

volumeType -> (string)

Launch template disk volume type configuration.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

Shorthand Syntax:

volumeType=string,iops=long,throughput=long

JSON Syntax:

{
  "volumeType": "io1"|"io2"|"gp3"|"gp2"|"st1"|"sc1"|"standard",
  "iops": long,
  "throughput": long
}

--enable-parameters-encryption | --no-enable-parameters-encryption (boolean)

Enable parameters encryption.

--parameters-encryption-key (string)

Parameters encryption key.

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

launchConfigurationTemplateID -> (string)

ID of the Launch Configuration Template.

arn -> (string)

ARN of the Launch Configuration Template.

postLaunchActions -> (structure)

Post Launch Actions of the Launch Configuration Template.

deployment -> (string)

Deployment type in which AWS Systems Manager Documents will be executed.

s3LogBucket -> (string)

AWS Systems Manager Command’s logs S3 log bucket.

s3OutputKeyPrefix -> (string)

AWS Systems Manager Command’s logs S3 output key prefix.

cloudWatchLogGroupName -> (string)

AWS Systems Manager Command’s CloudWatch log group name.

ssmDocuments -> (list)

AWS Systems Manager Documents.

(structure)

AWS Systems Manager Document.

actionName -> (string)

User-friendly name for the AWS Systems Manager Document.

ssmDocumentName -> (string)

AWS Systems Manager Document name or full ARN.

timeoutSeconds -> (integer)

AWS Systems Manager Document timeout seconds.

mustSucceedForCutover -> (boolean)

If true, Cutover will not be enabled if the document has failed.

parameters -> (map)

AWS Systems Manager Document parameters.

key -> (string)

value -> (list)

(structure)

AWS Systems Manager Parameter Store parameter.

parameterType -> (string)

AWS Systems Manager Parameter Store parameter type.

parameterName -> (string)

AWS Systems Manager Parameter Store parameter name.

externalParameters -> (map)

AWS Systems Manager Document external parameters.

key -> (string)

value -> (tagged union structure)

AWS Systems Manager Document external parameter.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.

dynamicPath -> (string)

AWS Systems Manager Document external parameters dynamic path.

enableMapAutoTagging -> (boolean)

Enable map auto tagging.

mapAutoTaggingMpeID -> (string)

Launch configuration template map auto tagging MPE ID.

tags -> (map)

Tags of the Launch Configuration Template.

key -> (string)

value -> (string)

ec2LaunchTemplateID -> (string)

EC2 launch template ID.

launchDisposition -> (string)

Launch disposition.

targetInstanceTypeRightSizingMethod -> (string)

Target instance type right-sizing method.

copyPrivateIp -> (boolean)

Copy private Ip.

associatePublicIpAddress -> (boolean)

Associate public Ip address.

copyTags -> (boolean)

Copy tags.

licensing -> (structure)

Configure Licensing.

osByol -> (boolean)

Configure BYOL OS licensing.

bootMode -> (string)

Launch configuration template boot mode.

smallVolumeMaxSize -> (long)

Small volume maximum size.

smallVolumeConf -> (structure)

Small volume config.

volumeType -> (string)

Launch template disk volume type configuration.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

largeVolumeConf -> (structure)

Large volume config.

volumeType -> (string)

Launch template disk volume type configuration.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

enableParametersEncryption -> (boolean)

Enable parameters encryption.

parametersEncryptionKey -> (string)

Parameters encryption key.