openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeLaunchConfigurations 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=DescribeLaunchConfigurations'
paths:
/#Action=DescribeLaunchConfigurations:
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: DescribeLaunchConfigurations
operationId: GET_DescribeLaunchConfigurations
description: Gets information about the launch configurations in the account and Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/LaunchConfigurationsType'
examples:
GET_DescribeLaunchConfigurations200Example:
summary: Default GET_DescribeLaunchConfigurations 200 response
x-microcks-default: true
value:
LaunchConfigurations: example-string
NextToken: example-string
'480':
description: InvalidNextToken
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidNextToken'
examples:
GET_DescribeLaunchConfigurations480Example:
summary: Default GET_DescribeLaunchConfigurations 480 response
x-microcks-default: true
value: {}
'481':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
GET_DescribeLaunchConfigurations481Example:
summary: Default GET_DescribeLaunchConfigurations 481 response
x-microcks-default: true
value: {}
parameters:
- name: LaunchConfigurationNames
in: query
required: false
description: '<p>The launch configuration names. If you omit this property, all launch configurations are described.</p> <p>Array Members: Maximum number of 50 items.</p>'
schema:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
- name: NextToken
in: query
required: false
description: The token for the next set of items to return. (You received this token from a previous call.)
schema:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
- name: MaxRecords
in: query
required: false
description: The maximum number of items to return with this call. The default value is <code>50</code> and the maximum value is <code>100</code>.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLaunchConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Launch Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeLaunchConfigurations'
post:
x-aws-operation-name: DescribeLaunchConfigurations
operationId: POST_DescribeLaunchConfigurations
description: Gets information about the launch configurations in the account and Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/LaunchConfigurationsType'
examples:
POST_DescribeLaunchConfigurations200Example:
summary: Default POST_DescribeLaunchConfigurations 200 response
x-microcks-default: true
value:
LaunchConfigurations: example-string
NextToken: example-string
'480':
description: InvalidNextToken
content:
text/xml:
schema:
$ref: '#/components/schemas/InvalidNextToken'
examples:
POST_DescribeLaunchConfigurations480Example:
summary: Default POST_DescribeLaunchConfigurations 480 response
x-microcks-default: true
value: {}
'481':
description: ResourceContentionFault
content:
text/xml:
schema:
$ref: '#/components/schemas/ResourceContentionFault'
examples:
POST_DescribeLaunchConfigurations481Example:
summary: Default POST_DescribeLaunchConfigurations 481 response
x-microcks-default: true
value: {}
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/LaunchConfigurationNamesType'
parameters:
- name: MaxRecords
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLaunchConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling POST_ Describe Launch Configurations
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeLaunchConfigurations'
components:
schemas:
XmlString:
type: string
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
LaunchConfigurations:
type: array
items:
$ref: '#/components/schemas/LaunchConfiguration'
LaunchConfigurationNames:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
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.
TimestampType:
type: string
format: date-time
ClassicLinkVPCSecurityGroups:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
NoDevice:
type: boolean
MaxRecords:
type: integer
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
LaunchConfigurationsType:
type: object
required:
- LaunchConfigurations
example:
LaunchConfigurations:
- AssociatePublicIpAddress: true
BlockDeviceMappings: []
CreatedTime: 2014-05-07 17:39:28.599000+00:00
EbsOptimized: false
ImageId: ami-043a5034
InstanceMonitoring:
Enabled: true
InstanceType: t1.micro
LaunchConfigurationARN: arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config
LaunchConfigurationName: my-launch-config
SecurityGroups:
- sg-67ef0308
properties:
LaunchConfigurations:
allOf:
- $ref: '#/components/schemas/LaunchConfigurations'
- description: The launch configurations.
example: example-string
NextToken:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: 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 <code>NextToken</code> value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
EbsOptimized:
type: boolean
BlockDeviceEbsVolumeType:
type: string
minLength: 1
maxLength: 255
BlockDeviceEbsEncrypted:
type: boolean
BlockDeviceEbsDeleteOnTermination:
type: boolean
InstanceMetadataEndpointState:
type: string
enum:
- disabled
- enabled
LaunchConfiguration:
type: object
required:
- LaunchConfigurationName
- ImageId
- InstanceType
- CreatedTime
properties:
LaunchConfigurationName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the launch configuration.
LaunchConfigurationARN:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The Amazon Resource Name (ARN) of the launch configuration.
ImageId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The ID of the Amazon Machine Image (AMI) to use to launch your EC2 instances. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/finding-an-ami.html">Find a Linux AMI</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.
KeyName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: <p>The name of the key pair.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html">Amazon EC2 Key Pairs</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p>
SecurityGroups:
allOf:
- $ref: '#/components/schemas/SecurityGroups'
- description: A list that contains the security groups 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">Security Groups for Your VPC</a> in the <i>Amazon Virtual Private Cloud User Guide</i>.
ClassicLinkVPCId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: Available for backward compatibility.
ClassicLinkVPCSecurityGroups:
allOf:
- $ref: '#/components/schemas/ClassicLinkVPCSecurityGroups'
- description: Available for backward compatibility.
UserData:
allOf:
- $ref: '#/components/schemas/XmlStringUserData'
- 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.
InstanceType:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The instance type for the instances. 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>.
KernelId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The ID of the kernel associated with the AMI.
RamdiskId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The ID of the RAM disk associated with the AMI.
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/BlockDeviceMappings'
- 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 Mapping</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.
InstanceMonitoring:
allOf:
- $ref: '#/components/schemas/InstanceMonitoring'
- description: <p>Controls whether instances in this group are launched with detailed (<code>true</code>) or basic (<code>false</code>) monitoring.</p> <p>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>
SpotPrice:
allOf:
- $ref: '#/components/schemas/SpotPrice'
- description: 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/asg-launch-spot-instances.html">Requesting Spot Instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen1600'
- 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>.
CreatedTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: The creation date and time for the launch configuration.
EbsOptimized:
allOf:
- $ref: '#/components/schemas/EbsOptimized'
- description: Specifies whether the launch configuration is optimized for EBS I/O (<code>true</code>) or not (<code>false</code>). 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>.
AssociatePublicIpAddress:
allOf:
- $ref: '#/components/schemas/AssociatePublicIpAddress'
- description: 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. 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>.
PlacementTenancy:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen64'
- 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.</p> <p>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>
MetadataOptions:
allOf:
- $ref: '#/components/schemas/InstanceMetadataOptions'
- 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>.
description: Describes a launch configuration.
BlockDeviceEbsThroughput:
type: integer
minimum: 125
maximum: 1000
LaunchConfigurationNamesType:
type: object
title: LaunchConfigurationNamesType
properties:
LaunchConfigurationNames:
allOf:
- $ref: '#/components/schemas/LaunchConfigurationNames'
- description: '<p>The launch configuration names. If you omit this property, all launch configurations are described.</p> <p>Array Members: Maximum number of 50 items.</p>'
NextToken:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The token for the next set of items to return. (You received this token from a previous call.)
MaxRecords:
allOf:
- $ref: '#/components/schemas/MaxRecords'
- description: The maximum number of items to return with this call. The default value is <code>50</code> and the maximum value is <code>100</code>.
InvalidNextToken: {}
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
ResourceName:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
Ebs:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: <p>The snapshot ID of the volume to use.</p> <p>You must specify either a <code>VolumeSize</code> or a <code>SnapshotId</code>.</p>
VolumeSize:
allOf:
- $ref: '#/components/schemas/BlockDeviceEbsVolumeSize'
- description: '<p>The volume size, in GiBs. The following are the supported volumes sizes for each volume type: </p> <ul> <li> <p> <code>gp2</code> and <code>gp3</code>: 1-16,384</p> </li> <li> <p> <code>io1</code>: 4-16,384</p> </li> <li> <p> <code>st1</code> and <code>sc1</code>: 125-16,384</p> </li> <li> <p> <code>standard</code>: 1-1,024</p> </li> </ul> <p>You must specify either a <code>SnapshotId</code> or a <code>VolumeSize</code>. If you specify both <code>SnapshotId</code> and <code>VolumeSize</code>, the volume size must be equal or greater than the size of the snapshot.</p>'
VolumeType:
allOf:
- $ref: '#/components/schemas/BlockDeviceEbsVolumeType'
- description: '<p>The volume type. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSVolumeTypes.html">Amazon EBS volume types</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> <p>Valid values: <code>standard</code> | <code>io1</code> | <code>gp2</code> | <code>st1</code> | <code>sc1</code> | <code>gp3</code> </p>'
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/BlockDeviceEbsDeleteOnTermination'
- description: Indicates whether the volume is deleted on instance termination. For Amazon EC2 Auto Scaling, the default value is <code>true</code>.
Iops:
allOf:
- $ref: '#/components/schemas/BlockDeviceEbsIops'
- description: '<p>The number of input/output (I/O) operations per second (IOPS) to provision for the volume. For <code>gp3</code> and <code>io1</code> volumes, this represents the number of IOPS that are provisioned for the volume. For <code>gp2</code> volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. </p> <p>The following are the supported values for each volume type: </p> <ul> <li> <p> <code>gp3</code>: 3,000-16,000 IOPS</p> </li> <li> <p> <code>io1</code>: 100-64,000 IOPS</p> </li> </ul> <p>For <code>io1</code> volumes, we guarantee 64,000 IOPS only for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances">Instances built on the Nitro System</a>. Other instance families guarantee performance up to 32,000 IOPS. </p> <p> <code>Iops</code> is supported when the volume type is <code>gp3</code> or <code>io1</code> and required only when the volume type is <code>io1</code>. (Not used with <code>standard</code>, <code>gp2</code>, <code>st1</code>, or <code>sc1</code> volumes.) </p>'
Encrypted:
allOf:
- $ref: '#/components/schemas/BlockDeviceEbsEncrypted'
- description: <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#EBSEncryption_supported_instances">Supported instance types</a>. If your AMI uses encrypted volumes, you can also only launch it on supported instance types.</p> <note> <p>If you are creating a volume from a snapshot, you cannot create an unencrypted volume from an encrypted snapshot. Also, you cannot specify a KMS key ID when using a launch configuration.</p> <p>If you enable encryption by default, the EBS volumes that you create are always encrypted, either using the Amazon Web Services managed KMS key or a customer-managed KMS key, regardless of whether the snapshot was encrypted. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-data-protection.html#encryption">Use Amazon Web Services KMS keys to encrypt Amazon EBS volumes</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p> </note>
Throughput:
allOf:
- $ref: '#/components/schemas/BlockDeviceEbsThroughput'
- description: The throughput (MiBps) to provision for a <code>gp3</code> volume.
description: Describes information used to set up an Amazon EBS volume specified in a block device mapping.
SecurityGroups:
type: array
items:
$ref: '#/components/schemas/XmlString'
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/autoscaling/
x-hasEquivalentPaths: true