openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeAutoScalingGroups API'
description:
Amazon EC2 Auto Scaling is designed to automatically launch and terminate EC2 instances based on user-defined scaling policies, scheduled actions, and health checks.
For more information, see the Amazon EC2 Auto Scaling User Guide and the Amazon EC2 Auto Scaling API Reference.
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=DescribeAutoScalingGroups' paths: /#Action=DescribeAutoScalingGroups: 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: DescribeAutoScalingGroups operationId: GET_DescribeAutoScalingGroups description:Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AutoScalingGroupsType' examples: GET_DescribeAutoScalingGroups200Example: summary: Default GET_DescribeAutoScalingGroups 200 response x-microcks-default: true value: AutoScalingGroups: example-string NextToken: example-string '480': description: InvalidNextToken content: text/xml: schema: $ref: '#/components/schemas/InvalidNextToken' examples: GET_DescribeAutoScalingGroups480Example: summary: Default GET_DescribeAutoScalingGroups 480 response x-microcks-default: true value: {} '481': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: GET_DescribeAutoScalingGroups481Example: summary: Default GET_DescribeAutoScalingGroups 481 response x-microcks-default: true value: {} parameters: - name: AutoScalingGroupNames in: query required: false description:The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords property.
If you omit this property, all Auto Scaling groups are described.
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 is50 and the maximum value is 100.
schema:
type: integer
- name: Filters
in: query
required: false
description: 'One or more filters to limit the results based on specific tags. '
schema:
type: array
items:
$ref: '#/components/schemas/Filter'
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAutoScalingGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- 2011-01-01
summary: Amazon EC2 Auto Scaling GET_ Describe Auto Scaling Groups
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
tags:
- '#Action=DescribeAutoScalingGroups'
post:
x-aws-operation-name: DescribeAutoScalingGroups
operationId: POST_DescribeAutoScalingGroups
description: Gets information about the Auto Scaling groups in the account and Region.
If you specify Auto Scaling group names, the output includes information for only the specified Auto Scaling groups. If you specify filters, the output includes information for only those Auto Scaling groups that meet the filter criteria. If you do not specify group names or filters, the output includes information for all Auto Scaling groups.
This operation also returns information about instances in Auto Scaling groups. To retrieve information about the instances in a warm pool, you must call the DescribeWarmPool API.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AutoScalingGroupsType' examples: POST_DescribeAutoScalingGroups200Example: summary: Default POST_DescribeAutoScalingGroups 200 response x-microcks-default: true value: AutoScalingGroups: example-string NextToken: example-string '480': description: InvalidNextToken content: text/xml: schema: $ref: '#/components/schemas/InvalidNextToken' examples: POST_DescribeAutoScalingGroups480Example: summary: Default POST_DescribeAutoScalingGroups 480 response x-microcks-default: true value: {} '481': description: ResourceContentionFault content: text/xml: schema: $ref: '#/components/schemas/ResourceContentionFault' examples: POST_DescribeAutoScalingGroups481Example: summary: Default POST_DescribeAutoScalingGroups 481 response x-microcks-default: true value: {} requestBody: content: text/xml: schema: $ref: '#/components/schemas/AutoScalingGroupNamesType' 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: - DescribeAutoScalingGroups - name: Version in: query required: true schema: type: string enum: - 2011-01-01 summary: Amazon EC2 Auto Scaling POST_ Describe Auto Scaling Groups x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#Action=DescribeAutoScalingGroups' components: schemas: XmlString: type: string x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' AcceleratorType: type: string enum: - gpu - fpga - inference AutoScalingGroupMaxSize: type: integer Filters: type: array items: $ref: '#/components/schemas/Filter' SuspendedProcesses: type: array items: $ref: '#/components/schemas/SuspendedProcess' Filter: type: object properties: Name: allOf: - $ref: '#/components/schemas/XmlString' - description: 'The name of the filter.
The valid values for Name depend on which API operation you''re using with the filter (DescribeAutoScalingGroups or DescribeTags).
DescribeAutoScalingGroups
Valid values for Name include the following:
tag-key - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys.
tag-value - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values.
tag:<key> - Accepts the key/value combination of the tag. Use the tag key in the filter name and the tag value as the filter value. The results only include information about the Auto Scaling groups associated with the specified key/value combination.
DescribeTags
Valid values for Name include the following:
auto-scaling-group - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups.
key - Accepts tag keys. The results only include information about the tags associated with these tag keys.
value - Accepts tag values. The results only include information about the tags associated with these tag values.
propagate-at-launch - Accepts a Boolean value, which specifies whether tags propagate to instances at launch. The results only include information about the tags associated with the specified Boolean value.
One or more filter values. Filter values are case-sensitive.
If you specify multiple values for a filter, the values are automatically logically joined with an OR, and the request returns all results that match any of the specified values. For example, specify "tag:environment" for the filter name and "production,development" for the filter values to find Auto Scaling groups with the tag "environment=production" or "environment=development".
Describes a filter that is used to return a more specific list of results from a describe operation.
If you specify multiple filters, the filters are automatically logically joined with an AND, and the request returns only the results that match all of the specified filters.
For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
WarmPoolStatus: type: string enum: - PendingDelete LaunchTemplateOverrides: type: object properties: InstanceType: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description:The instance type, such as m3.xlarge. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
You can specify up to 40 instance types per Auto Scaling group.
WeightedCapacity: allOf: - $ref: '#/components/schemas/XmlStringMaxLen32' - description:If you provide a list of instance types to use, you can specify the number of capacity units provided by each instance type in terms of virtual CPUs, memory, storage, throughput, or other relative performance characteristic. When a Spot or On-Demand Instance is launched, the capacity units count toward the desired capacity. Amazon EC2 Auto Scaling launches instances until the desired capacity is totally fulfilled, even if this results in an overage. For example, if there are two units remaining to fulfill capacity, and Amazon EC2 Auto Scaling can only launch an instance with a WeightedCapacity of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configuring instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide. Value must be in the range of 1–999.
If you specify a value for WeightedCapacity for one instance type, you must specify a value for WeightedCapacity for all of them.
Every Auto Scaling group has three size parameters (DesiredCapacity, MaxSize, and MinSize). Usually, you set these sizes based on a specific number of instances. However, if you configure a mixed instances policy that defines weights for the instance types, you must specify these sizes with the same units that you use for weighting instances.
Provides a launch template for the specified instance type or set of instance requirements. For example, some instance types might require a launch template with a different AMI. If not provided, Amazon EC2 Auto Scaling uses the launch template that's specified in the LaunchTemplate definition. For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.
You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the LaunchTemplate definition count towards this limit.
The instance requirements. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
You can specify up to four separate sets of instance requirements per Auto Scaling group. This is useful for provisioning instances from different Amazon Machine Images (AMIs) in the same Auto Scaling group. To do this, create the AMIs and create a new launch template for each AMI. Then, create a compatible set of instance requirements for each launch template.
If you specify InstanceRequirements, you can't specify InstanceType.
Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:
Override the instance type that is specified in the launch template.
Use multiple instance types.
Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.
After you define your instance requirements, you don't have to keep updating these settings to get new EC2 instance types automatically. Amazon EC2 Auto Scaling uses the instance requirements of the Auto Scaling group to determine whether a new EC2 instance type can be used.
EnabledMetric: type: object properties: Metric: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description:One of the following metrics:
GroupMinSize
GroupMaxSize
GroupDesiredCapacity
GroupInServiceInstances
GroupPendingInstances
GroupStandbyInstances
GroupTerminatingInstances
GroupTotalInstances
GroupInServiceCapacity
GroupPendingCapacity
GroupStandbyCapacity
GroupTerminatingCapacity
GroupTotalCapacity
WarmPoolDesiredCapacity
WarmPoolWarmedCapacity
WarmPoolPendingCapacity
WarmPoolTerminatingCapacity
WarmPoolTotalCapacity
GroupAndWarmPoolDesiredCapacity
GroupAndWarmPoolTotalCapacity
For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
Granularity: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The granularity of the metric. The only valid value is1Minute.
description: Describes an enabled Auto Scaling group metric.
NetworkBandwidthGbpsRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveDouble'
- description: The minimum amount of network bandwidth, in gigabits per second (Gbps).
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveDouble'
- description: The maximum amount of network bandwidth, in gigabits per second (Gbps).
description: Specifies the minimum and maximum for the NetworkBandwidthGbps object when you specify InstanceRequirements for an Auto Scaling group.
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide for Linux Instances.
TotalLocalStorageGB object when you specify InstanceRequirements for an Auto Scaling group.
Instances:
type: array
items:
$ref: '#/components/schemas/Instance'
XmlStringMaxLen1600:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
Context:
type: string
XmlStringMaxLen19:
type: string
minLength: 1
maxLength: 19
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
AutoScalingGroup:
type: object
required:
- AutoScalingGroupName
- MinSize
- MaxSize
- DesiredCapacity
- DefaultCooldown
- AvailabilityZones
- HealthCheckType
- CreatedTime
properties:
AutoScalingGroupName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the Auto Scaling group.
AutoScalingGroupARN:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The Amazon Resource Name (ARN) of the Auto Scaling group.
LaunchConfigurationName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the associated launch configuration.
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: The launch template for the group.
MixedInstancesPolicy:
allOf:
- $ref: '#/components/schemas/MixedInstancesPolicy'
- description: The mixed instances policy for the group.
MinSize:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupMinSize'
- description: The minimum size of the group.
MaxSize:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupMaxSize'
- description: The maximum size of the group.
DesiredCapacity:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupDesiredCapacity'
- description: The desired size of the group.
PredictedCapacity:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupPredictedCapacity'
- description: The predicted capacity of the group when it has a predictive scaling policy.
DefaultCooldown:
allOf:
- $ref: '#/components/schemas/Cooldown'
- description: The duration of the default cooldown period, in seconds.
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/AvailabilityZones'
- description: One or more Availability Zones for the group.
LoadBalancerNames:
allOf:
- $ref: '#/components/schemas/LoadBalancerNames'
- description: One or more load balancers associated with the group.
TargetGroupARNs:
allOf:
- $ref: '#/components/schemas/TargetGroupARNs'
- description: The Amazon Resource Names (ARN) of the target groups for your load balancer.
HealthCheckType:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen32'
- description: A comma-separated value string of one or more health check types.
HealthCheckGracePeriod:
allOf:
- $ref: '#/components/schemas/HealthCheckGracePeriod'
- description: The duration of the health check grace period, in seconds.
Instances:
allOf:
- $ref: '#/components/schemas/Instances'
- description: The EC2 instances associated with the group.
CreatedTime:
allOf:
- $ref: '#/components/schemas/TimestampType'
- description: The date and time the group was created.
SuspendedProcesses:
allOf:
- $ref: '#/components/schemas/SuspendedProcesses'
- description: The suspended processes associated with the group.
PlacementGroup:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The name of the placement group into which to launch your instances, if any.
VPCZoneIdentifier:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen2047'
- description: One or more subnet IDs, if applicable, separated by commas.
EnabledMetrics:
allOf:
- $ref: '#/components/schemas/EnabledMetrics'
- description: The metrics enabled for the group.
Status:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The current state of the group when the DeleteAutoScalingGroup operation is in progress.
Tags:
allOf:
- $ref: '#/components/schemas/TagDescriptionList'
- description: The tags for the group.
TerminationPolicies:
allOf:
- $ref: '#/components/schemas/TerminationPolicies'
- description: The termination policies for the group.
NewInstancesProtectedFromScaleIn:
allOf:
- $ref: '#/components/schemas/InstanceProtected'
- description: Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.
ServiceLinkedRoleARN:
allOf:
- $ref: '#/components/schemas/ResourceName'
- description: The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf.
MaxInstanceLifetime:
allOf:
- $ref: '#/components/schemas/MaxInstanceLifetime'
- description: 'The maximum amount of time, in seconds, that an instance can be in service.
Valid Range: Minimum value of 0.
' CapacityRebalance: allOf: - $ref: '#/components/schemas/CapacityRebalanceEnabled' - description: Indicates whether Capacity Rebalancing is enabled. WarmPoolConfiguration: allOf: - $ref: '#/components/schemas/WarmPoolConfiguration' - description: The warm pool for the group. WarmPoolSize: allOf: - $ref: '#/components/schemas/WarmPoolSize' - description: The current size of the warm pool. Context: allOf: - $ref: '#/components/schemas/Context' - description: Reserved. DesiredCapacityType: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supportsDesiredCapacityType for attribute-based instance type selection only.
DefaultInstanceWarmup:
allOf:
- $ref: '#/components/schemas/DefaultInstanceWarmup'
- description: The duration of the default instance warmup, in seconds.
TrafficSources:
allOf:
- $ref: '#/components/schemas/TrafficSources'
- description: The traffic sources associated with this Auto Scaling group.
description: Describes an Auto Scaling group.
InstanceRequirements:
type: object
required:
- VCpuCount
- MemoryMiB
properties:
VCpuCount:
allOf:
- $ref: '#/components/schemas/VCpuCountRequest'
- description: The minimum and maximum number of vCPUs for an instance type.
MemoryMiB:
allOf:
- $ref: '#/components/schemas/MemoryMiBRequest'
- description: The minimum and maximum instance memory size for an instance type, in MiB.
CpuManufacturers:
allOf:
- $ref: '#/components/schemas/CpuManufacturers'
- description: 'Lists which specific CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don''t confuse the CPU hardware manufacturer with the CPU hardware architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
' MemoryGiBPerVCpu: allOf: - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' - description: 'The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
Default: No minimum or maximum limits
' ExcludedInstanceTypes: allOf: - $ref: '#/components/schemas/ExcludedInstanceTypes' - description: 'The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can''t specify AllowedInstanceTypes.
Default: No excluded instance types
' InstanceGenerations: allOf: - $ref: '#/components/schemas/InstanceGenerations' - description: 'Indicates whether current or previous generation instance types are included.
For current generation instance types, specify current. The current generation includes EC2 instance types currently recommended for use. This typically includes the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide for Linux Instances.
For previous generation instance types, specify previous.
Default: Any current or previous generation
' SpotMaxPricePercentageOverLowestPrice: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: 'The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your threshold. The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage. To turn off price protection, specify a high value, such as 999999.
If you set DesiredCapacityType to vcpu or memory-mib, the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price.
Default: 20
Indicates whether bare metal instance types are included, excluded, or required.
Default: excluded
Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide for Linux Instances.
Default: excluded
Indicates whether instance types must provide On-Demand Instance hibernation support.
Default: false
The minimum and maximum number of network interfaces for an instance type.
Default: No minimum or maximum limits
' LocalStorage: allOf: - $ref: '#/components/schemas/LocalStorage' - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, see Amazon EC2 instance store in the Amazon EC2 User Guide for Linux Instances.
Default: included
Indicates the type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: Any local storage type
' TotalLocalStorageGB: allOf: - $ref: '#/components/schemas/TotalLocalStorageGBRequest' - description: 'The minimum and maximum total local storage size for an instance type, in GB.
Default: No minimum or maximum limits
' BaselineEbsBandwidthMbps: allOf: - $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' - description: 'The minimum and maximum baseline bandwidth performance for an instance type, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide for Linux Instances.
Default: No minimum or maximum limits
' AcceleratorTypes: allOf: - $ref: '#/components/schemas/AcceleratorTypes' - description: 'Lists the accelerator types that must be on an instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
' AcceleratorCount: allOf: - $ref: '#/components/schemas/AcceleratorCountRequest' - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' AcceleratorManufacturers: allOf: - $ref: '#/components/schemas/AcceleratorManufacturers' - description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' AcceleratorNames: allOf: - $ref: '#/components/schemas/AcceleratorNames' - description: 'Lists the accelerators that must be on an instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
Default: Any accelerator
' AcceleratorTotalMemoryMiB: allOf: - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - description: 'The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
Default: No minimum or maximum limits
' NetworkBandwidthGbps: allOf: - $ref: '#/components/schemas/NetworkBandwidthGbpsRequest' - description: 'The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
' AllowedInstanceTypes: allOf: - $ref: '#/components/schemas/AllowedInstanceTypes' - description: 'The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can''t specify ExcludedInstanceTypes.
Default: All instance types
' description:The attributes for the instance types for a mixed instances policy. Amazon EC2 Auto Scaling uses your specified requirements to identify instance types. Then, it uses your On-Demand and Spot allocation strategies to launch instances from these instance types.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 Auto Scaling can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. For help determining which instance types match your attributes before you apply them to your Auto Scaling group, see Preview instance types with specified attributes in the Amazon EC2 User Guide for Linux Instances.
LocalStorageTypes: type: array items: $ref: '#/components/schemas/LocalStorageType' LoadBalancerNames: type: array items: $ref: '#/components/schemas/XmlStringMaxLen255' Instance: type: object required: - InstanceId - AvailabilityZone - LifecycleState - HealthStatus - ProtectedFromScaleIn properties: InstanceId: allOf: - $ref: '#/components/schemas/XmlStringMaxLen19' - description: The ID of the instance. InstanceType: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The instance type of the EC2 instance. AvailabilityZone: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The Availability Zone in which the instance is running. LifecycleState: allOf: - $ref: '#/components/schemas/LifecycleState' - description: 'A description of the current lifecycle state. TheQuarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide. '
HealthStatus:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen32'
- description: The last reported health status of the instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and that Amazon EC2 Auto Scaling should terminate and replace it.
LaunchConfigurationName:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The launch configuration associated with the instance.
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: The launch template for the instance.
ProtectedFromScaleIn:
allOf:
- $ref: '#/components/schemas/InstanceProtected'
- description: Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.
WeightedCapacity:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen32'
- description: 'The number of capacity units contributed by the instance based on its instance type.
Valid Range: Minimum value of 1. Maximum value of 999.
' description: Describes an EC2 instance. TargetGroupARNs: type: array items: $ref: '#/components/schemas/XmlStringMaxLen511' LaunchTemplateSpecification: type: object properties: LaunchTemplateId: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: 'The ID of the launch template. To get the template ID, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
The name of the launch template. To get the template name, use the Amazon EC2 DescribeLaunchTemplates API operation. New launch templates can be created using the Amazon EC2 CreateLaunchTemplate API.
Conditional: You must specify either a LaunchTemplateId or a LaunchTemplateName.
$Latest, or $Default. To get the version number, use the Amazon EC2 DescribeLaunchTemplateVersions API operation. New launch template versions can be created using the Amazon EC2 CreateLaunchTemplateVersion API. If the value is $Latest, Amazon EC2 Auto Scaling selects the latest version of the launch template when launching instances. If the value is $Default, Amazon EC2 Auto Scaling selects the default version of the launch template when launching instances. The default value is $Default.
description: Describes the launch template and the version of the launch template that Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information about launch templates, see Launch templates in the Amazon EC2 Auto Scaling User Guide.
AcceleratorNames:
type: array
items:
$ref: '#/components/schemas/AcceleratorName'
BurstablePerformance:
type: string
enum:
- included
- excluded
- required
SpotInstancePools:
type: integer
TagDescription:
type: object
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The name of the group.
ResourceType:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The type of resource. The only supported value is auto-scaling-group.
Key:
allOf:
- $ref: '#/components/schemas/TagKey'
- description: The tag key.
Value:
allOf:
- $ref: '#/components/schemas/TagValue'
- description: The tag value.
PropagateAtLaunch:
allOf:
- $ref: '#/components/schemas/PropagateAtLaunch'
- description: Determines whether the tag is added to new instances as they are launched in the group.
description: Describes a tag for an Auto Scaling group.
AcceleratorName:
type: string
enum:
- a100
- v100
- k80
- t4
- m60
- radeon-pro-v520
- vu9p
WarmPoolConfiguration:
type: object
properties:
MaxGroupPreparedCapacity:
allOf:
- $ref: '#/components/schemas/MaxGroupPreparedCapacity'
- description: The maximum number of instances that are allowed to be in the warm pool or in any state except Terminated for the Auto Scaling group.
MinSize:
allOf:
- $ref: '#/components/schemas/WarmPoolMinSize'
- description: The minimum number of instances to maintain in the warm pool.
PoolState:
allOf:
- $ref: '#/components/schemas/WarmPoolState'
- description: The instance state to transition to after the lifecycle actions are complete.
Status:
allOf:
- $ref: '#/components/schemas/WarmPoolStatus'
- description: The status of a warm pool that is marked for deletion.
InstanceReusePolicy:
allOf:
- $ref: '#/components/schemas/InstanceReusePolicy'
- description: The instance reuse policy.
description: 'Describes a warm pool configuration. '
LifecycleState:
type: string
enum:
- Pending
- Pending:Wait
- Pending:Proceed
- Quarantined
- InService
- Terminating
- Terminating:Wait
- Terminating:Proceed
- Terminated
- Detaching
- Detached
- EnteringStandby
- Standby
- Warmed:Pending
- Warmed:Pending:Wait
- Warmed:Pending:Proceed
- Warmed:Terminating
- Warmed:Terminating:Wait
- Warmed:Terminating:Proceed
- Warmed:Terminated
- Warmed:Stopped
- Warmed:Running
- Warmed:Hibernated
AcceleratorTypes:
type: array
items:
$ref: '#/components/schemas/AcceleratorType'
MaxGroupPreparedCapacity:
type: integer
minimum: -1
NetworkInterfaceCountRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The minimum number of network interfaces.
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The maximum number of network interfaces.
description: Specifies the minimum and maximum for the NetworkInterfaceCount object when you specify InstanceRequirements for an Auto Scaling group.
OnDemandBaseCapacity:
type: integer
AcceleratorManufacturer:
type: string
enum:
- nvidia
- amd
- amazon-web-services
- xilinx
AllowedInstanceTypes:
type: array
items:
$ref: '#/components/schemas/AllowedInstanceType'
maxItems: 400
ReuseOnScaleIn:
type: boolean
BareMetal:
type: string
enum:
- included
- excluded
- required
TerminationPolicies:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen1600'
WarmPoolState:
type: string
enum:
- Stopped
- Running
- Hibernated
CapacityRebalanceEnabled:
type: boolean
AutoScalingGroupNames:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
Values:
type: array
items:
$ref: '#/components/schemas/XmlString'
XmlStringMaxLen32:
type: string
minLength: 1
maxLength: 32
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
NullablePositiveDouble:
type: number
format: double
minimum: 0
LocalStorageType:
type: string
enum:
- hdd
- ssd
MixedInstancesPolicy:
type: object
properties:
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplate'
- description: One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
InstancesDistribution:
allOf:
- $ref: '#/components/schemas/InstancesDistribution'
- description: The instances distribution.
description: Use this structure to launch multiple instance types and On-Demand Instances and Spot Instances within a single Auto Scaling group.
A mixed instances policy contains information that Amazon EC2 Auto Scaling can use to launch instances and help optimize your costs. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
CpuManufacturer: type: string enum: - intel - amd - amazon-web-services AutoScalingGroupPredictedCapacity: type: integer InstanceGenerations: type: array items: $ref: '#/components/schemas/InstanceGeneration' MemoryMiBRequest: type: object required: - Min properties: Min: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: The memory minimum in MiB. Max: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: The memory maximum in MiB. description: Specifies the minimum and maximum for theMemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
Cooldown:
type: integer
AutoScalingGroupMinSize:
type: integer
NullableBoolean:
type: boolean
XmlStringMaxLen511:
type: string
minLength: 1
maxLength: 511
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
AutoScalingGroupNamesType:
type: object
title: AutoScalingGroupNamesType
properties:
AutoScalingGroupNames:
allOf:
- $ref: '#/components/schemas/AutoScalingGroupNames'
- description: The names of the Auto Scaling groups. By default, you can only specify up to 50 names. You can optionally increase this limit using the MaxRecords property.
If you omit this property, all Auto Scaling groups are described.
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 is50 and the maximum value is 100.
Filters:
allOf:
- $ref: '#/components/schemas/Filters'
- description: 'One or more filters to limit the results based on specific tags. '
TrafficSourceIdentifier:
type: object
required:
- Identifier
properties:
Identifier:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen511'
- description: 'Identifies the traffic source.
For Application Load Balancers, Gateway Load Balancers, Network Load Balancers, and VPC Lattice, this will be the Amazon Resource Name (ARN) for a target group in this account and Region. For Classic Load Balancers, this will be the name of the Classic Load Balancer in this account and Region.
For example:
Application Load Balancer ARN: arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/1234567890123456
Classic Load Balancer name: my-classic-load-balancer
VPC Lattice ARN: arn:aws:vpc-lattice:us-west-2:123456789012:targetgroup/tg-1234567890123456
To get the ARN of a target group for a Application Load Balancer, Gateway Load Balancer, or Network Load Balancer, or the name of a Classic Load Balancer, use the Elastic Load Balancing DescribeTargetGroups and DescribeLoadBalancers API operations.
To get the ARN of a target group for VPC Lattice, use the VPC Lattice GetTargetGroup API operation.
' example: example-id-1234 Type: allOf: - $ref: '#/components/schemas/XmlStringMaxLen511' - description:Provides additional context for the value of Identifier.
The following lists the valid values:
elb if Identifier is the name of a Classic Load Balancer.
elbv2 if Identifier is the ARN of an Application Load Balancer, Gateway Load Balancer, or Network Load Balancer target group.
vpc-lattice if Identifier is the ARN of a VPC Lattice target group.
Required if the identifier is the name of a Classic Load Balancer.
example: example-string description: Identifying information for a traffic source. XmlStringMaxLen2047: type: string minLength: 1 maxLength: 2047 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' CpuManufacturers: type: array items: $ref: '#/components/schemas/CpuManufacturer' LocalStorage: type: string enum: - included - excluded - required TagValue: type: string minLength: 0 maxLength: 256 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' SuspendedProcess: type: object properties: ProcessName: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The name of the suspended process. SuspensionReason: allOf: - $ref: '#/components/schemas/XmlStringMaxLen255' - description: The reason that the process was suspended. description:Describes an auto scaling process that has been suspended.
For more information, see Scaling processes in the Amazon EC2 Auto Scaling User Guide.
AutoScalingGroupsType: type: object required: - AutoScalingGroups example: AutoScalingGroups: - AutoScalingGroupARN: arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group AutoScalingGroupName: my-auto-scaling-group AvailabilityZones: - us-west-2c CreatedTime: 2013-08-19 20:53:25.584000+00:00 DefaultCooldown: 300 DesiredCapacity: 1 EnabledMetrics: [] HealthCheckGracePeriod: 300 HealthCheckType: EC2 Instances: - AvailabilityZone: us-west-2c HealthStatus: Healthy InstanceId: i-4ba0837f LaunchConfigurationName: my-launch-config LifecycleState: InService ProtectedFromScaleIn: false LaunchConfigurationName: my-launch-config LoadBalancerNames: [] MaxSize: 1 MinSize: 0 NewInstancesProtectedFromScaleIn: false SuspendedProcesses: [] Tags: [] TerminationPolicies: - Default VPCZoneIdentifier: subnet-12345678 properties: AutoScalingGroups: allOf: - $ref: '#/components/schemas/AutoScalingGroups' - description: The groups. 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 theNextToken value when requesting the next set of items. This value is null when there are no more items to return.
example: example-string
TagKey:
type: string
minLength: 1
maxLength: 128
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
ExcludedInstance:
type: string
pattern: '[a-zA-Z0-9\.\*]+'
minLength: 1
maxLength: 30
VCpuCountRequest:
type: object
required:
- Min
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The minimum number of vCPUs.
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The maximum number of vCPUs.
description: Specifies the minimum and maximum for the VCpuCount object when you specify InstanceRequirements for an Auto Scaling group.
EnabledMetrics:
type: array
items:
$ref: '#/components/schemas/EnabledMetric'
LaunchTemplate:
type: object
properties:
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: The launch template.
example: example-string
Overrides:
allOf:
- $ref: '#/components/schemas/Overrides'
- description: Any properties that you specify override the same properties in the launch template.
example: example-id-1234
description: Use this structure to specify the launch templates and instance types (overrides) for a mixed instances policy.
WarmPoolSize:
type: integer
AllowedInstanceType:
type: string
pattern: '[a-zA-Z0-9\.\*]+'
minLength: 1
maxLength: 30
AcceleratorManufacturers:
type: array
items:
$ref: '#/components/schemas/AcceleratorManufacturer'
NullablePositiveInteger:
type: integer
minimum: 0
HealthCheckGracePeriod:
type: integer
InstanceReusePolicy:
type: object
properties:
ReuseOnScaleIn:
allOf:
- $ref: '#/components/schemas/ReuseOnScaleIn'
- description: 'Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in. '
description: Describes an instance reuse policy for a warm pool.
For more information, see Warm pools for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
ExcludedInstanceTypes: type: array items: $ref: '#/components/schemas/ExcludedInstance' maxItems: 400 MixedInstanceSpotPrice: type: string minLength: 0 maxLength: 255 XmlStringMaxLen255: type: string minLength: 1 maxLength: 255 x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*' TagDescriptionList: type: array items: $ref: '#/components/schemas/TagDescription' InvalidNextToken: {} BaselineEbsBandwidthMbpsRequest: type: object properties: Min: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: The minimum value in Mbps. Max: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: The maximum value in Mbps. description: Specifies the minimum and maximum for theBaselineEbsBandwidthMbps object when you specify InstanceRequirements for an Auto Scaling group.
ResourceName:
type: string
minLength: 1
maxLength: 1600
x-pattern: '[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*'
DefaultInstanceWarmup:
type: integer
AcceleratorCountRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The minimum value.
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveInteger'
- description: The maximum value.
description: Specifies the minimum and maximum for the AcceleratorCount object when you specify InstanceRequirements for an Auto Scaling group.
Overrides:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateOverrides'
WarmPoolMinSize:
type: integer
minimum: 0
ResourceContentionFault: {}
TimestampType:
type: string
format: date-time
AutoScalingGroups:
type: array
items:
$ref: '#/components/schemas/AutoScalingGroup'
InstanceGeneration:
type: string
enum:
- current
- previous
MaxInstanceLifetime:
type: integer
LaunchTemplateName:
type: string
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
minLength: 3
maxLength: 128
InstancesDistribution:
type: object
properties:
OnDemandAllocationStrategy:
allOf:
- $ref: '#/components/schemas/XmlString'
- description: The allocation strategy to apply to your On-Demand Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
Uses price to determine which instance types are the highest priority, launching the lowest priced instance types within an Availability Zone first. This is the default value for Auto Scaling groups that specify InstanceRequirements.
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling launches your highest priority instance types first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance type, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on. This is the default value for Auto Scaling groups that don't specify InstanceRequirements and cannot be used for groups that do.
The minimum amount of the Auto Scaling group''s capacity that must be fulfilled by On-Demand Instances. This base portion is launched first as your group scales.
This number has the same unit of measurement as the group''s desired capacity. If you change the default unit of measurement (number of instances) by specifying weighted capacity values in your launch template overrides list, or by changing the default desired capacity type setting of the group, you must specify this number using the same unit of measurement.
Default: 0
' example: example-string OnDemandPercentageAboveBaseCapacity: allOf: - $ref: '#/components/schemas/OnDemandPercentageAboveBaseCapacity' - description: 'Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Expressed as a number (for example, 20 specifies 20% On-Demand Instances, 80% Spot Instances). If set to 100, only On-Demand Instances are used.
Default: 100
' example: example-string SpotAllocationStrategy: allOf: - $ref: '#/components/schemas/XmlString' - description:The allocation strategy to apply to your Spot Instances when they are launched. Possible instance types are determined by the launch template overrides that you specify.
The following lists the valid values:
Requests Spot Instances using pools that are optimally chosen based on the available Spot capacity. This strategy has the lowest risk of interruption. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized.
You set the order of instance types for the launch template overrides from highest to lowest priority (from first to last in the list). Amazon EC2 Auto Scaling honors the instance type priorities on a best effort basis but optimizes for capacity first. Note that if the On-Demand allocation strategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity. This is not a valid value for Auto Scaling groups that specify InstanceRequirements.
Requests Spot Instances using the lowest priced pools within an Availability Zone, across the number of Spot pools that you specify for the SpotInstancePools property. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. This is the default value, but it might lead to high interruption rates because this strategy only considers instance price and not available capacity.
The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price.
The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the overrides. Valid only when the SpotAllocationStrategy is lowest-price. Value must be in the range of 1–20.
Default: 2
' example: example-string SpotMaxPrice: allOf: - $ref: '#/components/schemas/MixedInstanceSpotPrice' - description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. If your maximum price is lower than the Spot price for the instance types that you selected, your Spot Instances are not launched. We do not recommend specifying a maximum price because it can lead to increased interruptions. When Spot Instances launch, you pay the current Spot price. To remove a maximum price that you previously set, include the property but specify an empty string ("") for the value.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify one.
Valid Range: Minimum value of 0.001
' example: example-string description: Use this structure to specify the distribution of On-Demand Instances and Spot Instances and the allocation strategies used to fulfill On-Demand and Spot capacities for a mixed instances policy. MaxRecords: type: integer AutoScalingGroupDesiredCapacity: type: integer TrafficSources: type: array items: $ref: '#/components/schemas/TrafficSourceIdentifier' InstanceProtected: type: boolean OnDemandPercentageAboveBaseCapacity: type: integer AcceleratorTotalMemoryMiBRequest: type: object properties: Min: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: The memory minimum in MiB. Max: allOf: - $ref: '#/components/schemas/NullablePositiveInteger' - description: The memory maximum in MiB. description: Specifies the minimum and maximum for theAcceleratorTotalMemoryMiB object when you specify InstanceRequirements for an Auto Scaling group.
PropagateAtLaunch:
type: boolean
MemoryGiBPerVCpuRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveDouble'
- description: The memory minimum in GiB.
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveDouble'
- description: The memory maximum in GiB.
description: Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you specify InstanceRequirements for an Auto Scaling group.
parameters:
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
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-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
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