openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=CreateLaunchConfiguration API'
description: <fullname>Amazon EC2 Auto Scaling</fullname> <p>Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.</p> <p>For more information, see the <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/">Amazon EC2 Auto Scaling User Guide</a> and the <a href="https://docs.aws.amazon.com/autoscaling/ec2/APIReference/Welcome.html">Amazon EC2 Auto Scaling API Reference</a>.</p>
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: autoscaling
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/autoscaling-2011-01-01.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://autoscaling.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Auto Scaling multi-region endpoint
- url: https://autoscaling.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Auto Scaling multi-region endpoint
- url: http://autoscaling.amazonaws.com
variables: {}
description: The general Auto Scaling endpoint for US East (N. Virginia)
- url: https://autoscaling.amazonaws.com
variables: {}
description: The general Auto Scaling endpoint for US East (N. Virginia)
- url: http://autoscaling.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia)
- url: https://autoscaling.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Auto Scaling endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#Action=CreateLaunchConfiguration'
paths:
/#Action=CreateLaunchConfiguration:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
get:
x-aws-operation-name: CreateLaunchConfiguration
operationId: GET_CreateLaunchConfiguration
description: <p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the <a>DescribeAccountLimits</a> API. For information about updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html">Launch configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <note> <p>Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html">Launch templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> </note>
responses:
'200':
description: Success
'480':
description: AlreadyExistsFault
content:
text/xml:
schema:
$ref: '#/components/schemas/AlreadyExistsFault'
examples:
GET_CreateLaunchConfiguration480Example:
summary: Default GET_CreateLaunchConfiguration 480 response
x-microcks-default: true
value: {}
'481':
description: LimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/LimitExceededFault'
examples:
GET_CreateLaunchConfiguration481Example:
summary: Default GET_CreateLaunchConfiguration 481 response
x-microcks-default: true
value: {}
'482':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
parameters:
- name: LaunchConfigurationName
in: query
required: true
description: The name of the launch configuration. This name must be unique per Region per account.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: ImageId
in: query
required: false
description: <p>The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding a Linux AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>If you specify <code>InstanceId</code>, an <code>ImageId</code> is not required.</p>
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: KeyName
in: query
required: false
description: The name of the key pair. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Linux instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: SecurityGroups
in: query
required: false
description: A list that contains the security group IDs to assign to the instances in the Auto Scaling group. For more information, see <a href="https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html">Control traffic to resources using security groups</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.
schema:
type: array
items:
$ref: '#/components/schemas/XmlString'
- name: ClassicLinkVPCId
in: query
required: false
description: Available for backward compatibility.
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: ClassicLinkVPCSecurityGroups
in: query
required: false
description: Available for backward compatibility.
schema:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
- name: UserData
in: query
required: false
description: The user data to make available to the launched EC2 instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html">Instance metadata and user data</a> (Linux) and <a href="https://docs.aws.amazon.com/AWSEC2/latest/WindowsGuide/ec2-instance-metadata.html">Instance metadata and user data</a> (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.
schema:
type: string
maxLength: 21847
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: InstanceId
in: query
required: false
description: <p>The ID of the instance to use to create the launch configuration. The new launch configuration derives attributes from the instance, except for the block device mapping.</p> <p>To create a launch configuration with a block device mapping or override any other instance attributes, specify them as part of the same request.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-lc-with-instanceID.html">Creating a launch configuration using an EC2 instance</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
schema:
type: string
minLength: 1
maxLength: 19
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: InstanceType
in: query
required: false
description: <p>Specifies the instance type of the EC2 instance. For information about available instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#AvailableInstanceTypes">Available instance types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>If you specify <code>InstanceId</code>, an <code>InstanceType</code> is not required.</p>
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: KernelId
in: query
required: false
description: <p>The ID of the kernel associated with the AMI.</p> <note> <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided kernels</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> </note>
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: RamdiskId
in: query
required: false
description: <p>The ID of the RAM disk to select.</p> <note> <p>We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html">User provided kernels</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> </note>
schema:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: BlockDeviceMappings
in: query
required: false
description: The block device mapping entries that define the block devices to attach to the instances at launch. By default, the block devices specified in the block device mapping for the AMI are used. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html">Block device mappings</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.
schema:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
- name: InstanceMonitoring
in: query
required: false
description: <p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring.</p> <p>The default value is <code>true</code> (enabled).</p> <important> <p>When detailed monitoring is enabled, Amazon CloudWatch generates metrics every minute and your account is charged a fee. When you disable detailed monitoring, CloudWatch generates metrics every 5 minutes. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/latest/userguide/enable-as-instance-metrics.html">Configure Monitoring for Auto Scaling Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> </important>
schema:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/MonitoringEnabled'
- description: If <code>true</code>, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
description: Describes whether detailed monitoring is enabled for the Auto Scaling instances.
- name: SpotPrice
in: query
required: false
description: '<p>The maximum hourly price to be paid for any Spot Instance launched to fulfill the request. Spot Instances are launched when the price you specify exceeds the current Spot price. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-template-spot-instances.html">Request Spot Instances for fault-tolerant and flexible applications</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>Valid Range: Minimum value of 0.001</p> <note> <p>When you change your maximum price by creating a new launch configuration, running instances will continue to run as long as the maximum price for those running instances is higher than the current Spot price.</p> </note>'
schema:
type: string
minLength: 1
maxLength: 255
- name: IamInstanceProfile
in: query
required: false
description: The name or the Amazon Resource Name (ARN) of the instance profile associated with the IAM role for the instance. The instance profile contains the IAM role. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/us-iam-role.html">IAM role for applications that run on Amazon EC2 instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
schema:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: EbsOptimized
in: query
required: false
description: <p>Specifies whether the launch configuration is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). The optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization is not available with all instance types. Additional fees are incurred when you enable EBS optimization for an instance type that is not EBS-optimized by default. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html">Amazon EBS-optimized instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>The default value is <code>false</code>.</p>
schema:
type: boolean
- name: AssociatePublicIpAddress
in: query
required: false
description: <p>Specifies whether to assign a public IPv4 address to the group's instances. If the instance is launched into a default subnet, the default is to assign a public IPv4 address, unless you disabled the option to assign a public IPv4 address on the subnet. If the instance is launched into a nondefault subnet, the default is not to assign a public IPv4 address, unless you enabled the option to assign a public IPv4 address on the subnet.</p> <p>If you specify <code>true</code>, each instance in the Auto Scaling group receives a unique public IPv4 address. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-in-vpc.html">Launching Auto Scaling instances in a VPC</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify this property, you must specify at least one subnet for <code>VPCZoneIdentifier</code> when you create your group.</p>
schema:
type: boolean
- name: PlacementTenancy
in: query
required: false
description: '<p>The tenancy of the instance, either <code>default</code> or <code>dedicated</code>. An instance with <code>dedicated</code> tenancy runs on isolated, single-tenant hardware and can only be launched into a VPC. To launch dedicated instances into a shared tenancy VPC (a VPC with the instance placement tenancy attribute set to <code>default</code>), you must set the value of this property to <code>dedicated</code>. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/auto-scaling-dedicated-instances.html">Configuring instance tenancy with Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>If you specify <code>PlacementTenancy</code>, you must specify at least one subnet for <code>VPCZoneIdentifier</code> when you create your group.</p> <p>Valid values: <code>default</code> | <code>dedicated</code> </p>'
schema:
type: string
minLength: 1
maxLength: 64
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: MetadataOptions
in: query
required: false
description: The metadata options for the instances. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds">Configuring the Instance Metadata Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
schema:
type: object
properties:
HttpTokens:
allOf:
- $ref: '#/components/schemas/InstanceMetadataHttpTokensState'
- description: <p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p> <p>If the state is <code>optional</code>, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.</p> <p>If the state is <code>required</code>, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.</p>
HttpPutResponseHopLimit:
allOf:
- $ref: '#/components/schemas/InstanceMetadataHttpPutResponseHopLimit'
- description: '<p>The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.</p> <p>Default: 1</p>'
HttpEndpoint:
allOf:
- $ref: '#/components/schemas/InstanceMetadataEndpointState'
- description: <p>This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is <code>enabled</code>.</p> <note> <p>If you specify a value of <code>disabled</code>, you will not be able to access your instance metadata. </p> </note>
description: The metadata options for the instances. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds">Configuring the Instance Metadata Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLaunchConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Create Launch Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=CreateLaunchConfiguration'
post:
x-aws-operation-name: CreateLaunchConfiguration
operationId: POST_CreateLaunchConfiguration
description: <p>Creates a launch configuration.</p> <p>If you exceed your maximum limit of launch configurations, the call fails. To query this limit, call the <a>DescribeAccountLimits</a> API. For information about updating this limit, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-quotas.html">Quotas for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/LaunchConfiguration.html">Launch configurations</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> <note> <p>Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For information about using launch templates, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html">Launch templates</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> </note>
responses:
'200':
description: Success
'480':
description: AlreadyExistsFault
content:
text/xml:
schema:
$ref: '#/components/schemas/AlreadyExistsFault'
examples:
POST_CreateLaunchConfiguration480Example:
summary: Default POST_CreateLaunchConfiguration 480 response
x-microcks-default: true
value: {}
'481':
description: LimitExceededFault
content:
text/xml:
schema:
$ref: '#/components/schemas/LimitExceededFault'
examples:
POST_CreateLaunchConfiguration481Example:
summary: Default POST_CreateLaunchConfiguration 481 response
x-microcks-default: true
value: {}
'482':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLaunchConfigurationType'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLaunchConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Create Launch Configuration
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=CreateLaunchConfiguration'
components:
schemas:
XmlString:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
InstanceMetadataHttpPutResponseHopLimit:
type: integer
minimum: 1
maximum: 64
SpotPrice:
type: string
minLength: 1
maxLength: 255
ResourceContentionFault: {}
XmlStringMaxLen64:
type: string
minLength: 1
maxLength: 64
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
XmlStringUserData:
type: string
maxLength: 21847
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
XmlStringMaxLen1600:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
MonitoringEnabled:
type: boolean
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
BlockDeviceMapping:
type: object
required:
- DeviceName
properties:
VirtualName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the instance store volume (virtual device) to attach to an instance at launch. The name must be in the form ephemeral<i>X</i> where <i>X</i> is a number starting from zero (0), for example, <code>ephemeral0</code>.
example: example-resource-name
DeviceName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: '<p>The device name assigned to the volume (for example, <code>/dev/sdh</code> or <code>xvdh</code>). For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html">Device naming on Linux instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <note> <p>To define a block device mapping, set the device name and exactly one of the following properties: <code>Ebs</code>, <code>NoDevice</code>, or <code>VirtualName</code>.</p> </note>'
example: example-resource-name
Ebs:
allOf:
- $ref: '#/components/schemas/Ebs'
- description: Information to attach an EBS volume to an instance at launch.
example: example-string
NoDevice:
allOf:
- $ref: '#/components/schemas/NoDevice'
- description: <p>Setting this value to <code>true</code> prevents a volume that is included in the block device mapping of the AMI from being mapped to the specified device name at launch.</p> <p>If <code>NoDevice</code> is <code>true</code> for the root device, instances might fail the EC2 health check. In that case, Amazon EC2 Auto Scaling launches replacement instances.</p>
example: example-string
description: Describes a block device mapping.
ClassicLinkVPCSecurityGroups:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
XmlStringMaxLen19:
type: string
minLength: 1
maxLength: 19
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
NoDevice:
type: boolean
InstanceMonitoring:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/MonitoringEnabled'
- description: If <code>true</code>, detailed monitoring is enabled. Otherwise, basic monitoring is enabled.
description: Describes whether detailed monitoring is enabled for the Auto Scaling instances.
XmlStringMaxLen255:
type: string
minLength: 1
maxLength: 255
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
InstanceMetadataHttpTokensState:
type: string
enum:
- optional
- required
EbsOptimized:
type: boolean
BlockDeviceEbsVolumeType:
type: string
minLength: 1
maxLength: 255
BlockDeviceEbsEncrypted:
type: boolean
BlockDeviceEbsDeleteOnTermination:
type: boolean
InstanceMetadataEndpointState:
type: string
enum:
- disabled
- enabled
BlockDeviceEbsThroughput:
type: integer
minimum: 125
maximum: 1000
BlockDeviceEbsVolumeSize:
type: integer
minimum: 1
maximum: 16384
AssociatePublicIpAddress:
type: boolean
InstanceMetadataOptions:
type: object
properties:
HttpTokens:
allOf:
- $ref: '#/components/schemas/InstanceMetadataHttpTokensState'
- description: <p>The state of token usage for your instance metadata requests. If the parameter is not specified in the request, the default state is <code>optional</code>.</p> <p>If the state is <code>optional</code>, you can choose to retrieve instance metadata with or without a signed token header on your request. If you retrieve the IAM role credentials without a token, the version 1.0 role credentials are returned. If you retrieve the IAM role credentials using a valid signed token, the version 2.0 role credentials are returned.</p> <p>If the state is <code>required</code>, you must send a signed token header with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns the version 2.0 credentials; the version 1.0 credentials are not available.</p>
HttpPutResponseHopLimit:
allOf:
- $ref: '#/components/schemas/InstanceMetadataHttpPutResponseHopLimit'
- description: '<p>The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.</p> <p>Default: 1</p>'
HttpEndpoint:
allOf:
- $ref: '#/components/schemas/InstanceMetadataEndpointState'
- description: <p>This parameter enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is <code>enabled</code>.</p> <note> <p>If you specify a value of <code>disabled</code>, you will not be able to access your instance metadata. </p> </note>
description: The metadata options for the instances. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-config.html#launch-configurations-imds">Configuring the Instance Metadata Options</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
BlockDeviceEbsIops:
type: integer
minimum: 100
maximum: 20000
CreateLaunchConfigurationType:
type: object
required:
- LaunchConfigurationName
title: CreateLaunchConfigurationType
properties:
LaunchConfigurationName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the launch configuration. This name must be unique per Region per account.
ImageId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: <p>The ID of the Amazon Machine Image (AMI) that was assigned during registration. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Finding a Linux AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>If you specify <code>InstanceId</code>, an <code>ImageId</code> is not required.</p>
KeyName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the key pair. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 key pairs and Linux instances</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.
SecurityGroups:
allOf:
- $ref: '#/components/schemas/SecurityGroups'
-
# --- truncated at 32 KB (46 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/openapi/amazon-ec2-auto-scaling-action-createlaunchconfiguration-api-openapi.yml