[ aws . sms ]

put-app-launch-configuration

Description

Creates or updates the launch configuration for the specified application.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

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

Options

--app-id (string)

The ID of the application.

--role-name (string)

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

--auto-launch | --no-auto-launch (boolean)

Indicates whether the application is configured to launch automatically after replication is complete.

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

Information about the launch configurations for server groups in the application.

(structure)

Launch configuration for a server group.

serverGroupId -> (string)

The ID of the server group with which the launch configuration is associated.

launchOrder -> (integer)

The launch order of servers in the server group.

serverLaunchConfigurations -> (list)

The launch configuration for servers in the server group.

(structure)

Launch configuration for a server.

server -> (structure)

The ID of the server with which the launch configuration is associated.

serverId -> (string)

The ID of the server.

serverType -> (string)

The type of server.

vmServer -> (structure)

Information about the VM server.

vmServerAddress -> (structure)

The VM server location.

vmManagerId -> (string)

The ID of the VM manager.

vmId -> (string)

The ID 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 ID of the replication job.

replicationJobTerminated -> (boolean)

Indicates whether the replication job is deleted or failed.

logicalId -> (string)

The logical ID of the server in the CloudFormation template.

vpc -> (string)

The ID of the VPC into which the server should be launched.

subnet -> (string)

The ID of the subnet the server should be launched into.

securityGroup -> (string)

The ID of the security group that applies to the launched server.

ec2KeyName -> (string)

The name of the Amazon 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)

The Amazon S3 bucket name.

key -> (string)

The Amazon S3 bucket key.

instanceType -> (string)

The instance type to use when launching the server.

associatePublicIpAddress -> (boolean)

Indicates whether a publicly accessible IP address is created when launching the server.

iamInstanceProfileName -> (string)

The name of the IAM instance profile.

configureScript -> (structure)

Location of an Amazon S3 object.

bucket -> (string)

The Amazon S3 bucket name.

key -> (string)

The Amazon S3 bucket key.

configureScriptType -> (string)

The type of configuration script.

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,
        "iamInstanceProfileName": "string",
        "configureScript": {
          "bucket": "string",
          "key": "string"
        },
        "configureScriptType": "SHELL_SCRIPT"|"POWERSHELL_SCRIPT"
      }
      ...
    ]
  }
  ...
]

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

See ‘aws help’ for descriptions of global parameters.

Output

None