Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . autoscaling ]

describe-launch-configurations

Description

Describes one or more launch configurations.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

describe-launch-configurations is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate argument. When using --output text and the --query argument on a paginated response, the --query argument must extract data from the results of the following query expressions: LaunchConfigurations

Synopsis

  describe-launch-configurations
[--launch-configuration-names <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]

Options

--launch-configuration-names (list)

The launch configuration names. If you omit this parameter, all launch configurations are described.

Syntax:

"string" "string" ...

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

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

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

See 'aws help' for descriptions of global parameters.

Examples

To describe Auto Scaling launch configurations

This example describes the specified launch configuration:

aws autoscaling describe-launch-configurations --launch-configuration-names my-launch-config

The following is example output:

{
    "LaunchConfigurations": [
        {
            "UserData": null,
            "EbsOptimized": false,
            "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
            "InstanceMonitoring": {
                "Enabled": true
            },
            "ImageId": "ami-043a5034",
            "CreatedTime": "2014-05-07T17:39:28.599Z",
            "BlockDeviceMappings": [],
            "KeyName": null,
            "SecurityGroups": [
                "sg-67ef0308"
            ],
            "LaunchConfigurationName": "my-launch-config",
            "KernelId": null,
            "RamdiskId": null,
            "InstanceType": "t1.micro",
            "AssociatePublicIpAddress": true
        }
    ]
}

To return a specific number of launch configurations, use the max-items parameter:

aws autoscaling describe-launch-configurations --max-items 1

The following is example output:

{
    "NextToken": "Z3M3LMPEXAMPLE",
    "LaunchConfigurations": [
        {
            "UserData": null,
            "EbsOptimized": false,
            "LaunchConfigurationARN": "arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config",
            "InstanceMonitoring": {
                "Enabled": true
            },
            "ImageId": "ami-043a5034",
            "CreatedTime": "2014-05-07T17:39:28.599Z",
            "BlockDeviceMappings": [],
            "KeyName": null,
            "SecurityGroups": [
                "sg-67ef0308"
            ],
            "LaunchConfigurationName": "my-launch-config",
            "KernelId": null,
            "RamdiskId": null,
            "InstanceType": "t1.micro",
            "AssociatePublicIpAddress": true
        }
    ]
}

If the output includes a NextToken field, there are more launch configurations. To get the additional launch configurations, use the value of this field with the starting-token parameter in a subsequent call as follows:

aws autoscaling describe-launch-configurations --starting-token Z3M3LMPEXAMPLE

Output

LaunchConfigurations -> (list)

The launch configurations.

(structure)

Describes a launch configuration.

LaunchConfigurationName -> (string)

The name of the launch configuration.

LaunchConfigurationARN -> (string)

The Amazon Resource Name (ARN) of the launch configuration.

ImageId -> (string)

The ID of the Amazon Machine Image (AMI).

KeyName -> (string)

The name of the key pair.

SecurityGroups -> (list)

The security groups to associate with the instances.

(string)

ClassicLinkVPCId -> (string)

The ID of a ClassicLink-enabled VPC to link your EC2-Classic instances to. This parameter can only be used if you are launching EC2-Classic instances. For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .

ClassicLinkVPCSecurityGroups -> (list)

The IDs of one or more security groups for the VPC specified in ClassicLinkVPCId . For more information, see ClassicLink in the Amazon EC2 User Guide for Linux Instances and Linking EC2-Classic Instances to a VPC in the Amazon EC2 Auto Scaling User Guide .

Conditional: This parameter is required if you specify a ClassicLink-enabled VPC, and cannot be used otherwise.

(string)

UserData -> (string)

The user data available to the instances.

InstanceType -> (string)

The instance type for the instances.

KernelId -> (string)

The ID of the kernel associated with the AMI.

RamdiskId -> (string)

The ID of the RAM disk associated with the AMI.

BlockDeviceMappings -> (list)

A block device mapping, which specifies the block devices for the instance.

(structure)

Describes a block device mapping.

VirtualName -> (string)

The name of the virtual device (for example, ephemeral0 ).

DeviceName -> (string)

The device name exposed to the EC2 instance (for example, /dev/sdh or xvdh ). For more information, see Device Naming on Linux Instances in the Amazon EC2 User Guide for Linux Instances .

Ebs -> (structure)

The information about the Amazon EBS volume.

SnapshotId -> (string)

The snapshot ID of the volume to use.

Conditional: This parameter is optional if you specify a volume size. If you specify both SnapshotId and VolumeSize , VolumeSize must be equal or greater than the size of the snapshot.

VolumeSize -> (integer)

The volume size, in Gibibytes (GiB).

This can be a number from 1-1,024 for standard , 4-16,384 for io1 , 1-16,384 for gp2 , and 500-16,384 for st1 and sc1 . If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.

Default: If you create a volume from a snapshot and you don't specify a volume size, the default is the snapshot size.

Note

At least one of VolumeSize or SnapshotId is required.

VolumeType -> (string)

The volume type, which can be standard for Magnetic, io1 for Provisioned IOPS SSD, gp2 for General Purpose SSD, st1 for Throughput Optimized HDD, or sc1 for Cold HDD. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .

Valid values: standard | io1 | gp2 | st1 | sc1

DeleteOnTermination -> (boolean)

Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is true .

Iops -> (integer)

The number of I/O operations per second (IOPS) to provision for the volume. The maximum ratio of IOPS to volume size (in GiB) is 50:1. For more information, see Amazon EBS Volume Types in the Amazon EC2 User Guide for Linux Instances .

Conditional: This parameter is required when the volume type is io1 . (Not used with standard , gp2 , st1 , or sc1 volumes.)

Encrypted -> (boolean)

Specifies whether the volume should be encrypted. Encrypted EBS volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported Instance Types . If your AMI uses encrypted volumes, you can also only launch it on supported instance types.

Note

If you are creating a volume from a snapshot, you cannot specify an encryption value. Volumes that are created from encrypted snapshots are automatically encrypted, and volumes that are created from unencrypted snapshots are automatically unencrypted. By default, encrypted snapshots use the AWS managed CMK that is used for EBS encryption, but you can specify a custom CMK when you create the snapshot. The ability to encrypt a snapshot during copying also allows you to apply a new CMK to an already-encrypted snapshot. Volumes restored from the resulting copy are only accessible using the new CMK.

Enabling encryption by default results in all EBS volumes being encrypted with the AWS managed CMK or a customer managed CMK, whether or not the snapshot was encrypted.

For more information, see Using Encryption with EBS-Backed AMIs in the Amazon EC2 User Guide for Linux Instances and Required CMK Key Policy for Use with Encrypted Volumes in the Amazon EC2 Auto Scaling User Guide .

NoDevice -> (boolean)

Suppresses a device mapping.

If this parameter is true for the root device, the instance might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches a replacement instance.

InstanceMonitoring -> (structure)

Controls whether instances in this group are launched with detailed (true ) or basic (false ) monitoring.

Enabled -> (boolean)

If true , detailed monitoring is enabled. Otherwise, basic monitoring is enabled.

SpotPrice -> (string)

The price to bid when launching Spot Instances.

IamInstanceProfile -> (string)

The name or Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance.

CreatedTime -> (timestamp)

The creation date and time for the launch configuration.

EbsOptimized -> (boolean)

Controls whether the instance is optimized for EBS I/O (true ) or not (false ).

AssociatePublicIpAddress -> (boolean)

[EC2-VPC] Indicates whether to assign a public IP address to each instance.

PlacementTenancy -> (string)

The tenancy of the instance, either default or dedicated . An instance with dedicated tenancy runs in an isolated, single-tenant hardware and can only be launched into a VPC.

NextToken -> (string)

A string that indicates that the response contains more items than can be returned in a single response. To receive additional items, specify this string for the NextToken value when requesting the next set of items. This value is null when there are no more items to return.