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

create-launch-configuration-template

Description

Creates a new Launch Configuration Template.

See also: AWS API Documentation

Synopsis

  create-launch-configuration-template
[--associate-public-ip-address | --no-associate-public-ip-address]
[--boot-mode <value>]
[--copy-private-ip | --no-copy-private-ip]
[--copy-tags | --no-copy-tags]
[--enable-map-auto-tagging | --no-enable-map-auto-tagging]
[--large-volume-conf <value>]
[--launch-disposition <value>]
[--licensing <value>]
[--map-auto-tagging-mpe-id <value>]
[--post-launch-actions <value>]
[--small-volume-conf <value>]
[--small-volume-max-size <value>]
[--tags <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

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

Associate public Ip address.

--boot-mode (string)

Launch configuration template boot mode.

Possible values:

  • LEGACY_BIOS
  • UEFI
  • USE_SOURCE

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

Copy private Ip.

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

Copy tags.

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

Enable map auto tagging.

--large-volume-conf (structure)

Large volume config.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

volumeType -> (string)

Launch template disk volume type configuration.

Shorthand Syntax:

iops=long,throughput=long,volumeType=string

JSON Syntax:

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

--launch-disposition (string)

Launch disposition.

Possible values:

  • STOPPED
  • STARTED

--licensing (structure)

Configure Licensing.

osByol -> (boolean)

Configure BYOL OS licensing.

Shorthand Syntax:

osByol=boolean

JSON Syntax:

{
  "osByol": true|false
}

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

Launch configuration template map auto tagging MPE ID.

--post-launch-actions (structure)

Launch configuration template post launch actions.

cloudWatchLogGroupName -> (string)

AWS Systems Manager Command's CloudWatch log group name.

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.

ssmDocuments -> (list)

AWS Systems Manager Documents.

(structure)

AWS Systems Manager Document.

actionName -> (string)

User-friendly name for the AWS Systems Manager Document.

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.

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.

parameterName -> (string)

AWS Systems Manager Parameter Store parameter name.

parameterType -> (string)

AWS Systems Manager Parameter Store parameter type.

ssmDocumentName -> (string)

AWS Systems Manager Document name or full ARN.

timeoutSeconds -> (integer)

AWS Systems Manager Document timeout seconds.

JSON Syntax:

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

--small-volume-conf (structure)

Small volume config.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

volumeType -> (string)

Launch template disk volume type configuration.

Shorthand Syntax:

iops=long,throughput=long,volumeType=string

JSON Syntax:

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

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

Small volume maximum size.

--tags (map)

Request to associate tags during creation of a Launch Configuration Template.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

Target instance type right-sizing method.

Possible values:

  • NONE
  • BASIC

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

arn -> (string)

ARN of the Launch Configuration Template.

associatePublicIpAddress -> (boolean)

Associate public Ip address.

bootMode -> (string)

Launch configuration template boot mode.

copyPrivateIp -> (boolean)

Copy private Ip.

copyTags -> (boolean)

Copy tags.

ec2LaunchTemplateID -> (string)

EC2 launch template ID.

enableMapAutoTagging -> (boolean)

Enable map auto tagging.

largeVolumeConf -> (structure)

Large volume config.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

volumeType -> (string)

Launch template disk volume type configuration.

launchConfigurationTemplateID -> (string)

ID of the Launch Configuration Template.

launchDisposition -> (string)

Launch disposition.

licensing -> (structure)

Configure Licensing.

osByol -> (boolean)

Configure BYOL OS licensing.

mapAutoTaggingMpeID -> (string)

Launch configuration template map auto tagging MPE ID.

postLaunchActions -> (structure)

Post Launch Actions of the Launch Configuration Template.

cloudWatchLogGroupName -> (string)

AWS Systems Manager Command's CloudWatch log group name.

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.

ssmDocuments -> (list)

AWS Systems Manager Documents.

(structure)

AWS Systems Manager Document.

actionName -> (string)

User-friendly name for the AWS Systems Manager Document.

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.

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.

parameterName -> (string)

AWS Systems Manager Parameter Store parameter name.

parameterType -> (string)

AWS Systems Manager Parameter Store parameter type.

ssmDocumentName -> (string)

AWS Systems Manager Document name or full ARN.

timeoutSeconds -> (integer)

AWS Systems Manager Document timeout seconds.

smallVolumeConf -> (structure)

Small volume config.

iops -> (long)

Launch template disk iops configuration.

throughput -> (long)

Launch template disk throughput configuration.

volumeType -> (string)

Launch template disk volume type configuration.

smallVolumeMaxSize -> (long)

Small volume maximum size.

tags -> (map)

Tags of the Launch Configuration Template.

key -> (string)

value -> (string)

targetInstanceTypeRightSizingMethod -> (string)

Target instance type right-sizing method.