AWS Autoscaling

オートスケーリンググループの記述

アカウントおよびリージョン内のオートスケーリンググループに関する情報を取得します。

Inputs

フィールド

種類

説明

region [required]

enum

default: us-east-1

autoScalingGroupName [required]

string

The name of the Auto Scaling group.

Outputs

Expand All

フィールド

種類

説明

autoScalingGroup [required]

object

AutoScalingGroupName [required]

string

The name of the Auto Scaling group.

AutoScalingGroupARN

string

The Amazon Resource Name (ARN) of the Auto Scaling group.

LaunchConfigurationName

string

The name of the associated launch configuration.

LaunchTemplate

object

The launch template for the group.

LaunchTemplateId

string

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.

LaunchTemplateName

string

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.

Version

string

The version number, $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.

MixedInstancesPolicy

object

The mixed instances policy for the group.

LaunchTemplate

object

Specifies the launch template to use and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities. Required when creating a mixed instances policy.

LaunchTemplateSpecification

object

The launch template to use.

LaunchTemplateId

string

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.

LaunchTemplateName

string

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.

Version

string

The version number, $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.

Overrides

[object]

Any properties that you specify override the same properties in the launch template. If not provided, Amazon EC2 Auto Scaling uses the instance type or instance type requirements specified in the launch template when it launches an instance. The overrides can include either one or more instance types or a set of instance requirements, but not both.

InstanceType

string

The instance type, such as m3.xlarge. You must use 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.

WeightedCapacity

string

The number of capacity units provided by the instance type specified in InstanceType 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. Value must be in the range of 1 – 999.
For more information, see Configure instance weighting for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.

LaunchTemplateSpecification

object

Provides a launch template for the specified instance type or 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 defined for your mixed instances policy.
For more information, see Specifying a different launch template for an instance type in the Amazon EC2 Auto Scaling User Guide.

LaunchTemplateId

string

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.

LaunchTemplateName

string

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.

Version

string

The version number, $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.

InstanceRequirements

object

The instance requirements. When you specify instance requirements, Amazon EC2 Auto Scaling finds instance types that satisfy your requirements, and then uses your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of specific instance types.

VCpuCount [required]

object

The minimum and maximum number of vCPUs for an instance type.

Min [required]

number

The minimum number of vCPUs.

Max

number

The maximum number of vCPUs.

MemoryMiB [required]

object

The minimum and maximum instance memory size for an instance type, in MiB.

Min [required]

number

The memory minimum in MiB.

Max

number

The memory maximum in MiB.

CpuManufacturers

[string]

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

object

The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum

Min

number

The memory minimum in GiB.

Max

number

The memory maximum in GiB.

ExcludedInstanceTypes

[string]

Lists which instance types to exclude. You can use strings with one or more wild cards, represented by an asterisk (*). The following are examples: 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.*, you are excluding all the M5a instance types, but not the M5n instance types.
Default: No excluded instance types

InstanceGenerations

[string]

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

number

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 cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, it excludes 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

OnDemandMaxPricePercentageOverLowestPrice

number

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 cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, it excludes 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

BareMetal

string

Indicates whether bare metal instance types are included, excluded, or required.
Default: excluded

BurstablePerformance

string

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

RequireHibernateSupport

boolean

Indicates whether instance types must provide On-Demand Instance hibernation support.
Default: false

NetworkInterfaceCount

object

The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum

Min

number

The minimum number of network interfaces.

Max

number

The maximum number of network interfaces.

LocalStorage

string

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

LocalStorageTypes

[string]

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 sdd.
Default: Any local storage type

TotalLocalStorageGB

object

The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum

Min

number

The storage minimum in GB.

Max

number

The storage maximum in GB.

BaselineEbsBandwidthMbps

object

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

Min

number

The minimum value in Mbps.

Max

number

The maximum value in Mbps.

AcceleratorTypes

[string]

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

object

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

Min

number

The minimum value.

Max

number

The maximum value.

AcceleratorManufacturers

[string]

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

[string]

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

object

The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum

Min

number

The memory minimum in MiB.

Max

number

The memory maximum in MiB.

InstancesDistribution

object

Specifies the instances distribution.

OnDemandAllocationStrategy

string

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, Amazon EC2 Auto Scaling uses price to determine the order, launching the lowest price first. If you specify prioritized, Amazon EC2 Auto Scaling uses the priority that you assigned to each launch template override, launching the highest priority first. If all your On-Demand capacity cannot be fulfilled using your highest priority instance, then Amazon EC2 Auto Scaling launches the remaining capacity using the second priority instance type, and so on.
Default: lowest-price for Auto Scaling groups that specify InstanceRequirements in the overrides and prioritized for Auto Scaling groups that don't.

OnDemandBaseCapacity

number

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. If you specify weights for the instance types in the overrides, the base capacity is measured in the same unit of measurement as the instance types. If you specify InstanceRequirements in the overrides, the base capacity is measured in the same unit of measurement as your group's desired capacity.
Default: 0

OnDemandPercentageAboveBaseCapacity

number

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

SpotAllocationStrategy

string

Indicates how to allocate instances across Spot Instance pools. If the allocation strategy is lowest-price, the Auto Scaling group launches instances using the Spot pools with the lowest price, and evenly allocates your instances across the number of Spot pools that you specify. If the allocation strategy is capacity-optimized (recommended), the Auto Scaling group launches instances using Spot pools that are optimally chosen based on the available Spot capacity. Alternatively, you can use capacity-optimized-prioritized and set the order of instance types in the list of 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.
Default: lowest-price

SpotInstancePools

number

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 Spot allocation strategy is lowest-price. Value must be in the range of 1–20.
Default: 2

SpotMaxPrice

string

The maximum price per unit hour that you are willing to pay for a Spot Instance. If you keep the value at its default (unspecified), Amazon EC2 Auto Scaling uses the On-Demand price as the maximum Spot price. To remove a value that you previously set, include the property but specify an empty string ("") for the value.

MinSize [required]

number

The minimum size of the group.

MaxSize [required]

number

The maximum size of the group.

DesiredCapacity [required]

number

The desired size of the group.

PredictedCapacity

number

The predicted capacity of the group when it has a predictive scaling policy.

DefaultCooldown [required]

number

The duration of the default cooldown period, in seconds.

AvailabilityZones [required]

[string]

One or more Availability Zones for the group.

LoadBalancerNames

[string]

One or more load balancers associated with the group.

TargetGroupARNs

[string]

The Amazon Resource Names (ARN) of the target groups for your load balancer.

HealthCheckType [required]

string

The service to use for the health checks. The valid values are EC2 and ELB. If you configure an Auto Scaling group to use ELB health checks, it considers the instance unhealthy if it fails either the EC2 status checks or the load balancer health checks.

HealthCheckGracePeriod

number

The duration of the health check grace period, in seconds.

Instances

[object]

The EC2 instances associated with the group.

InstanceId [required]

string

The ID of the instance.

InstanceType

string

The instance type, such as m3.xlarge. You must use 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.

AvailabilityZone [required]

string

The Availability Zone in which the instance is running.

LifecycleState [required]

string

The lifecycle state for the instance. The Quarantined state is not used. For information about lifecycle states, see Instance lifecycle in the Amazon EC2 Auto Scaling User Guide.
Valid Values: 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

HealthStatus [required]

string

The last reported health status of this instance. Healthy means that the instance is healthy and should remain in service. Unhealthy means that the instance is unhealthy and Amazon EC2 Auto Scaling should terminate and replace it.

LaunchConfigurationName

string

The launch configuration associated with the instance.

LaunchTemplate

object

The launch template for the instance.

LaunchTemplateId

string

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.

LaunchTemplateName

string

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.

Version

string

The version number, $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.

ProtectedFromScaleIn [required]

boolean

Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in.

WeightedCapacity

string

The number of capacity units contributed by the instance based on its instance type. Valid Range: Minimum value of 1. Maximum value of 999.

CreatedTime [required]

date-time

The date and time the group was created.

SuspendedProcesses

[object]

The suspended processes associated with the group.

ProcessName

string

The name of the suspended process.

SuspensionReason

string

The reason that the process was suspended.

PlacementGroup

string

The name of the placement group into which to launch your instances, if any.

VPCZoneIdentifier

string

One or more subnet IDs, if applicable, separated by commas.

EnabledMetrics

[object]

The metrics enabled for the group.

Metric

string

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

Granularity

string

The granularity of the metric. The only valid value is 1Minute.

Status

string

The current state of the group when the DeleteAutoScalingGroup operation is in progress.

Tags

[object]

The tags for the group.

ResourceId

string

The name of the group.

ResourceType

string

The type of resource. The only supported value is auto-scaling-group.

Key

string

The tag key.

Value

string

The tag value.

PropagateAtLaunch

boolean

Determines whether the tag is added to new instances as they are launched in the group.

TerminationPolicies

[string]

The termination policies for the group.

NewInstancesProtectedFromScaleIn

boolean

Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in.

ServiceLinkedRoleARN

string

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

number

The maximum amount of time, in seconds, that an instance can be in service. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day).

CapacityRebalance

boolean

Indicates whether Capacity Rebalancing is enabled.

WarmPoolConfiguration

object

The warm pool for the group.

MaxGroupPreparedCapacity

number

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

number

The minimum number of instances to maintain in the warm pool.

PoolState

string

The instance state to transition to after the lifecycle actions are complete.

Status

string

The status of a warm pool that is marked for deletion.

InstanceReusePolicy

object

The instance reuse policy.

ReuseOnScaleIn

boolean

Specifies whether instances in the Auto Scaling group can be returned to the warm pool on scale in.

WarmPoolSize

number

The current size of the warm pool.

Context

string

Reserved.

DesiredCapacityType

string

The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only.

DefaultInstanceWarmup

number

The duration of the default instance warmup, in seconds.