openapi: 3.0.0
info:
version: 2011-01-01
x-release: v4
title: 'Auto Scaling #Action=AttachInstances #Action=AttachInstances #Action=DescribeAutoScalingGroups 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=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: <p>Gets information about the Auto Scaling groups in the account and Region.</p> <p>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. </p> <p>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 <a>DescribeWarmPool</a> API. </p>
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: <p>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 <code>MaxRecords</code> property.</p> <p>If you omit this property, all Auto Scaling groups are described.</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: 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: <p>Gets information about the Auto Scaling groups in the account and Region.</p> <p>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. </p> <p>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 <a>DescribeWarmPool</a> API. </p>
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: '<p>The name of the filter.</p> <p>The valid values for <code>Name</code> depend on which API operation you''re using with the filter (<a>DescribeAutoScalingGroups</a> or <a>DescribeTags</a>).</p> <p> <b>DescribeAutoScalingGroups</b> </p> <p>Valid values for <code>Name</code> include the following: </p> <ul> <li> <p> <code>tag-key</code> - Accepts tag keys. The results only include information about the Auto Scaling groups associated with these tag keys. </p> </li> <li> <p> <code>tag-value</code> - Accepts tag values. The results only include information about the Auto Scaling groups associated with these tag values. </p> </li> <li> <p> <code>tag:<key></code> - 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. </p> </li> </ul> <p> <b>DescribeTags</b> </p> <p>Valid values for <code>Name</code> include the following: </p> <ul> <li> <p> <code>auto-scaling-group</code> - Accepts the names of Auto Scaling groups. The results only include information about the tags associated with these Auto Scaling groups. </p> </li> <li> <p> <code>key</code> - Accepts tag keys. The results only include information about the tags associated with these tag keys. </p> </li> <li> <p> <code>value</code> - Accepts tag values. The results only include information about the tags associated with these tag values. </p> </li> <li> <p> <code>propagate-at-launch</code> - 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. </p> </li> </ul>'
example: example-resource-name
Values:
allOf:
- $ref: '#/components/schemas/Values'
- description: <p>One or more filter values. Filter values are case-sensitive. </p> <p>If you specify multiple values for a filter, the values are automatically logically joined with an <code>OR</code>, 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".</p>
example: example-string
description: <p>Describes a filter that is used to return a more specific list of results from a describe operation.</p> <p>If you specify multiple filters, the filters are automatically logically joined with an <code>AND</code>, and the request returns only the results that match all of the specified filters. </p> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html">Tag Auto Scaling groups and instances</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
WarmPoolStatus:
type: string
enum:
- PendingDelete
LaunchTemplateOverrides:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: <p>The instance type, such as <code>m3.xlarge</code>. You must specify an instance type that is supported in your requested Region and Availability Zones. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">Instance types</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> <p>You can specify up to 40 instance types per Auto Scaling group.</p>
WeightedCapacity:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen32'
- description: <p>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 <code>WeightedCapacity</code> of five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-instance-weighting.html">Configuring instance weighting for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. Value must be in the range of 1–999.</p> <p>If you specify a value for <code>WeightedCapacity</code> for one instance type, you must specify a value for <code>WeightedCapacity</code> for all of them.</p> <important> <p>Every Auto Scaling group has three size parameters (<code>DesiredCapacity</code>, <code>MaxSize</code>, and <code>MinSize</code>). 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. </p> </important>
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: <p>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 <code>LaunchTemplate</code> definition. For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups-launch-template-overrides.html">Specifying a different launch template for an instance type</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>. </p> <p>You can specify up to 20 launch templates per Auto Scaling group. The launch templates specified in the overrides and in the <code>LaunchTemplate</code> definition count towards this limit.</p>
InstanceRequirements:
allOf:
- $ref: '#/components/schemas/InstanceRequirements'
- description: <p>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.</p> <p>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. </p> <note> <p>If you specify <code>InstanceRequirements</code>, you can't specify <code>InstanceType</code>.</p> </note>
description: <p>Use this structure to let Amazon EC2 Auto Scaling do the following when the Auto Scaling group has a mixed instances policy:</p> <ul> <li> <p>Override the instance type that is specified in the launch template.</p> </li> <li> <p>Use multiple instance types.</p> </li> </ul> <p>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.</p> <p>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.</p>
EnabledMetric:
type: object
properties:
Metric:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: <p>One of the following metrics:</p> <ul> <li> <p> <code>GroupMinSize</code> </p> </li> <li> <p> <code>GroupMaxSize</code> </p> </li> <li> <p> <code>GroupDesiredCapacity</code> </p> </li> <li> <p> <code>GroupInServiceInstances</code> </p> </li> <li> <p> <code>GroupPendingInstances</code> </p> </li> <li> <p> <code>GroupStandbyInstances</code> </p> </li> <li> <p> <code>GroupTerminatingInstances</code> </p> </li> <li> <p> <code>GroupTotalInstances</code> </p> </li> <li> <p> <code>GroupInServiceCapacity</code> </p> </li> <li> <p> <code>GroupPendingCapacity</code> </p> </li> <li> <p> <code>GroupStandbyCapacity</code> </p> </li> <li> <p> <code>GroupTerminatingCapacity</code> </p> </li> <li> <p> <code>GroupTotalCapacity</code> </p> </li> <li> <p> <code>WarmPoolDesiredCapacity</code> </p> </li> <li> <p> <code>WarmPoolWarmedCapacity</code> </p> </li> <li> <p> <code>WarmPoolPendingCapacity</code> </p> </li> <li> <p> <code>WarmPoolTerminatingCapacity</code> </p> </li> <li> <p> <code>WarmPoolTotalCapacity</code> </p> </li> <li> <p> <code>GroupAndWarmPoolDesiredCapacity</code> </p> </li> <li> <p> <code>GroupAndWarmPoolTotalCapacity</code> </p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-cloudwatch-monitoring.html#as-group-metrics">Auto Scaling group metrics</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>
Granularity:
allOf:
- $ref: '#/components/schemas/XmlStringMaxLen255'
- description: The granularity of the metric. The only valid value is <code>1Minute</code>.
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: <p>Specifies the minimum and maximum for the <code>NetworkBandwidthGbps</code> object when you specify <a>InstanceRequirements</a> for an Auto Scaling group.</p> <note> <p>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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth">Available instance bandwidth</a> in the <i>Amazon EC2 User Guide for Linux Instances</i>.</p> </note>
AvailabilityZones:
type: array
items:
$ref: '#/components/schemas/XmlStringMaxLen255'
TotalLocalStorageGBRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/NullablePositiveDouble'
- description: The storage minimum in GB.
Max:
allOf:
- $ref: '#/components/schemas/NullablePositiveDouble'
- description: The storage maximum in GB.
description: Specifies the minimum and maximum for the <code>TotalLocalStorageGB</code> object when you specify <a>InstanceRequirements</a> 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 <a>DeleteAutoScalingGroup</a> 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: '<p>The maximum amount of time, in seconds, that an instance can be in service.</p> <p>Valid Range: Minimum value of 0.</p>'
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 supports <code>DesiredCapacityType</code> 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: '<p>Lists which specific CPU manufacturers to include.</p> <ul> <li> <p>For instance types with Intel CPUs, specify <code>intel</code>.</p> </li> <li> <p>For instance types with AMD CPUs, specify <code>amd</code>.</p> </li> <li> <p>For instance types with Amazon Web Services CPUs, specify <code>amazon-web-services</code>.</p> </li> </ul> <note> <p>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. </p> </note> <p>Default: Any manufacturer</p>'
MemoryGiBPerVCpu:
allOf:
- $ref: '#/components/schemas/MemoryGiBPerVCpuRequest'
- description: '<p>The minimum and maximum amount of memory per vCPU for an instance type, in GiB.</p> <p>Default: No minimum or maximum limits</p>'
ExcludedInstanceTypes:
allOf:
- $ref: '#/components/schemas/ExcludedInstanceTypes'
- description: '<p>The instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (<code>*</code>), to exclude an instance family, type, size, or generation. The following are examples: <code>m5.8xlarge</code>, <code>c5*.*</code>, <code>m5a.*</code>, <code>
# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/openapi/amazon-ec2-auto-scaling-action-describeautoscalinggroups-api-openapi.yml