[ aws . sms ]



Creates a launch configuration for an application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


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


--app-id (string)

ID of the application associated with the launch configuration.

--role-name (string)

Name of service role in the customer’s account that Amazon CloudFormation uses to launch the application.

--server-group-launch-configurations (list)

Launch configurations for server groups in the application.


Launch configuration for a server group.

serverGroupId -> (string)

Identifier of the server group the launch configuration is associated with.

launchOrder -> (integer)

Launch order of servers in the server group.

serverLaunchConfigurations -> (list)

Launch configuration for servers in the server group.


Launch configuration for a server.

server -> (structure)

Identifier of the server the launch 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.

logicalId -> (string)

Logical ID of the server in the Amazon CloudFormation template.

vpc -> (string)

Identifier of the VPC the server should be launched into.

subnet -> (string)

Identifier of the subnet the server should be launched into.

securityGroup -> (string)

Identifier of the security group that applies to the launched server.

ec2KeyName -> (string)

Name of the EC2 SSH Key to be used for connecting to the launched server.

userData -> (structure)

Location of the user-data script to be executed when launching the server.

s3Location -> (structure)

Amazon S3 location of the user-data script.

bucket -> (string)

Amazon S3 bucket name.

key -> (string)

Amazon S3 bucket key.

instanceType -> (string)

Instance type to be used for launching the server.

associatePublicIpAddress -> (boolean)

If true, a publicly accessible IP address is created when launching the server.

JSON Syntax:

    "serverGroupId": "string",
    "launchOrder": integer,
    "serverLaunchConfigurations": [
        "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
        "logicalId": "string",
        "vpc": "string",
        "subnet": "string",
        "securityGroup": "string",
        "ec2KeyName": "string",
        "userData": {
          "s3Location": {
            "bucket": "string",
            "key": "string"
        "instanceType": "string",
        "associatePublicIpAddress": true|false

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