Create Auto Scaling Group
autoscaling_create_auto_scaling_group | R Documentation |
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2¶
Description¶
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2.
Creates an Auto Scaling group with the specified name and attributes.
If you exceed your maximum limit of Auto Scaling groups, the call fails.
To query this limit, call the describe_account_limits
API. For
information about updating this limit, see Quotas for Amazon EC2 Auto
Scaling
in the Amazon EC2 Auto Scaling User Guide.
If you're new to Amazon EC2 Auto Scaling, see the introductory tutorials in Get started with Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Every Auto Scaling group has three size properties (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.
Usage¶
autoscaling_create_auto_scaling_group(AutoScalingGroupName,
LaunchConfigurationName, LaunchTemplate, MixedInstancesPolicy,
InstanceId, MinSize, MaxSize, DesiredCapacity, DefaultCooldown,
AvailabilityZones, LoadBalancerNames, TargetGroupARNs, HealthCheckType,
HealthCheckGracePeriod, PlacementGroup, VPCZoneIdentifier,
TerminationPolicies, NewInstancesProtectedFromScaleIn,
CapacityRebalance, LifecycleHookSpecificationList, Tags,
ServiceLinkedRoleARN, MaxInstanceLifetime, Context, DesiredCapacityType,
DefaultInstanceWarmup, TrafficSources, InstanceMaintenancePolicy)
Arguments¶
AutoScalingGroupName
[required] The name of the Auto Scaling group. This name must be unique per Region per account.
The name can contain any ASCII character 33 to 126 including most punctuation characters, digits, and upper and lowercased letters.
You cannot use a colon (:) in the name.
LaunchConfigurationName
The name of the launch configuration to use to launch instances.
Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).LaunchTemplate
Information used to specify the launch template and version to use to launch instances.
Conditional: You must specify either a launch template (
LaunchTemplate
orMixedInstancesPolicy
) or a launch configuration (LaunchConfigurationName
orInstanceId
).The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
MixedInstancesPolicy
The mixed instances policy. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
InstanceId
The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance in the Amazon EC2 Auto Scaling User Guide.
MinSize
[required] The minimum size of the group.
MaxSize
[required] The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSize
to meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSize
by more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group).DesiredCapacity
The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group.
DefaultCooldown
Only needed if you use simple scaling policies.
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Default:
300
secondsAvailabilityZones
A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the
VPCZoneIdentifier
property, or for attaching a network interface when an existing network interface ID is specified in a launch template.LoadBalancerNames
A list of Classic Load Balancers associated with this Auto Scaling group. For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the
TargetGroupARNs
property instead.TargetGroupARNs
The Amazon Resource Names (ARN) of the Elastic Load Balancing target groups to associate with the Auto Scaling group. Instances are registered as targets with the target groups. The target groups receive incoming traffic and route requests to one or more registered targets. For more information, see Use Elastic Load Balancing to distribute traffic across the instances in your Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
HealthCheckType
A comma-separated value string of one or more health check types.
The valid values are
EC2
,EBS
,ELB
, andVPC_LATTICE
.EC2
is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.Only specify
EC2
if you must clear a value that was previously set.HealthCheckGracePeriod
The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the
InService
state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.Default:
0
secondsPlacementGroup
The name of the placement group into which to launch your instances. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.
A cluster placement group is a logical grouping of instances within a single Availability Zone. You cannot specify multiple Availability Zones and a cluster placement group.
VPCZoneIdentifier
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created. If you specify
VPCZoneIdentifier
withAvailabilityZones
, the subnets that you specify must reside in those Availability Zones.TerminationPolicies
A policy or a list of policies that are used to select the instance to terminate. These policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide.
Valid values:
Default
|AllocationStrategy
|ClosestToNextInstanceHour
|NewestInstance
|OldestInstance
|OldestLaunchConfiguration
|OldestLaunchTemplate
|arn:aws:lambda:region:account-id:function:my-function:my-alias
NewInstancesProtectedFromScaleIn
Indicates whether newly launched instances are protected from termination by Amazon EC2 Auto Scaling when scaling in. For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
CapacityRebalance
Indicates whether Capacity Rebalancing is enabled. Otherwise, Capacity Rebalancing is disabled. When you turn on Capacity Rebalancing, Amazon EC2 Auto Scaling attempts to launch a Spot Instance whenever Amazon EC2 notifies that a Spot Instance is at an elevated risk of interruption. After launching a new instance, it then terminates an old instance. For more information, see Use Capacity Rebalancing to handle Amazon EC2 Spot Interruptions in the in the Amazon EC2 Auto Scaling User Guide.
LifecycleHookSpecificationList
One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
Tags
One or more tags. You can tag your Auto Scaling group and propagate the tags to the Amazon EC2 instances it launches. Tags are not propagated to Amazon EBS volumes. To add tags to Amazon EBS volumes, specify the tags in a launch template but use caution. If the launch template specifies an instance tag with a key that is also specified for the Auto Scaling group, Amazon EC2 Auto Scaling overrides the value of that instance tag with the value specified by the Auto Scaling group. For more information, see Tag Auto Scaling groups and instances in the Amazon EC2 Auto Scaling User Guide.
ServiceLinkedRoleARN
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services service on your behalf. By default, Amazon EC2 Auto Scaling uses a service-linked role named
AWSServiceRoleForAutoScaling
, which it creates if it does not exist. For more information, see Service-linked roles in the Amazon EC2 Auto Scaling User Guide.MaxInstanceLifetime
The maximum amount of time, in seconds, that an instance can be in service. The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
Context
Reserved.
DesiredCapacityType
The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityType
for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide.By default, Amazon EC2 Auto Scaling specifies
units
, which translates into number of instances.Valid values:
units
|vcpu
|memory-mib
DefaultInstanceWarmup
The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the
InService
state.During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide.
To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify
-1
for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0
or other nominal value.Default: None
TrafficSources
The list of traffic sources to attach to this Auto Scaling group. You can use any of the following as traffic sources for an Auto Scaling group: Classic Load Balancer, Application Load Balancer, Gateway Load Balancer, Network Load Balancer, and VPC Lattice.
InstanceMaintenancePolicy
An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
Value¶
An empty list.
Request syntax¶
svc$create_auto_scaling_group(
AutoScalingGroupName = "string",
LaunchConfigurationName = "string",
LaunchTemplate = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
MixedInstancesPolicy = list(
LaunchTemplate = list(
LaunchTemplateSpecification = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
Overrides = list(
list(
InstanceType = "string",
WeightedCapacity = "string",
LaunchTemplateSpecification = list(
LaunchTemplateId = "string",
LaunchTemplateName = "string",
Version = "string"
),
InstanceRequirements = list(
VCpuCount = list(
Min = 123,
Max = 123
),
MemoryMiB = list(
Min = 123,
Max = 123
),
CpuManufacturers = list(
"intel"|"amd"|"amazon-web-services"
),
MemoryGiBPerVCpu = list(
Min = 123.0,
Max = 123.0
),
ExcludedInstanceTypes = list(
"string"
),
InstanceGenerations = list(
"current"|"previous"
),
SpotMaxPricePercentageOverLowestPrice = 123,
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123,
OnDemandMaxPricePercentageOverLowestPrice = 123,
BareMetal = "included"|"excluded"|"required",
BurstablePerformance = "included"|"excluded"|"required",
RequireHibernateSupport = TRUE|FALSE,
NetworkInterfaceCount = list(
Min = 123,
Max = 123
),
LocalStorage = "included"|"excluded"|"required",
LocalStorageTypes = list(
"hdd"|"ssd"
),
TotalLocalStorageGB = list(
Min = 123.0,
Max = 123.0
),
BaselineEbsBandwidthMbps = list(
Min = 123,
Max = 123
),
AcceleratorTypes = list(
"gpu"|"fpga"|"inference"
),
AcceleratorCount = list(
Min = 123,
Max = 123
),
AcceleratorManufacturers = list(
"nvidia"|"amd"|"amazon-web-services"|"xilinx"
),
AcceleratorNames = list(
"a100"|"v100"|"k80"|"t4"|"m60"|"radeon-pro-v520"|"vu9p"
),
AcceleratorTotalMemoryMiB = list(
Min = 123,
Max = 123
),
NetworkBandwidthGbps = list(
Min = 123.0,
Max = 123.0
),
AllowedInstanceTypes = list(
"string"
)
)
)
)
),
InstancesDistribution = list(
OnDemandAllocationStrategy = "string",
OnDemandBaseCapacity = 123,
OnDemandPercentageAboveBaseCapacity = 123,
SpotAllocationStrategy = "string",
SpotInstancePools = 123,
SpotMaxPrice = "string"
)
),
InstanceId = "string",
MinSize = 123,
MaxSize = 123,
DesiredCapacity = 123,
DefaultCooldown = 123,
AvailabilityZones = list(
"string"
),
LoadBalancerNames = list(
"string"
),
TargetGroupARNs = list(
"string"
),
HealthCheckType = "string",
HealthCheckGracePeriod = 123,
PlacementGroup = "string",
VPCZoneIdentifier = "string",
TerminationPolicies = list(
"string"
),
NewInstancesProtectedFromScaleIn = TRUE|FALSE,
CapacityRebalance = TRUE|FALSE,
LifecycleHookSpecificationList = list(
list(
LifecycleHookName = "string",
LifecycleTransition = "string",
NotificationMetadata = "string",
HeartbeatTimeout = 123,
DefaultResult = "string",
NotificationTargetARN = "string",
RoleARN = "string"
)
),
Tags = list(
list(
ResourceId = "string",
ResourceType = "string",
Key = "string",
Value = "string",
PropagateAtLaunch = TRUE|FALSE
)
),
ServiceLinkedRoleARN = "string",
MaxInstanceLifetime = 123,
Context = "string",
DesiredCapacityType = "string",
DefaultInstanceWarmup = 123,
TrafficSources = list(
list(
Identifier = "string",
Type = "string"
)
),
InstanceMaintenancePolicy = list(
MinHealthyPercentage = 123,
MaxHealthyPercentage = 123
)
)
Examples¶
## Not run:
# This example creates an Auto Scaling group.
svc$create_auto_scaling_group(
AutoScalingGroupName = "my-auto-scaling-group",
DefaultInstanceWarmup = 120L,
LaunchTemplate = list(
LaunchTemplateName = "my-template-for-auto-scaling",
Version = "$Default"
),
MaxInstanceLifetime = 2592000L,
MaxSize = 3L,
MinSize = 1L,
VPCZoneIdentifier = "subnet-057fa0918fEXAMPLE"
)
# This example creates an Auto Scaling group and attaches the specified
# target group.
svc$create_auto_scaling_group(
AutoScalingGroupName = "my-auto-scaling-group",
HealthCheckGracePeriod = 300L,
HealthCheckType = "ELB",
LaunchTemplate = list(
LaunchTemplateName = "my-template-for-auto-scaling",
Version = "$Default"
),
MaxSize = 3L,
MinSize = 1L,
TargetGroupARNs = list(
"arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-tar..."
),
VPCZoneIdentifier = "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
)
# This example creates an Auto Scaling group with a mixed instances
# policy. It specifies the c5.large, c5a.large, and c6g.large instance
# types and defines a different launch template for the c6g.large instance
# type.
svc$create_auto_scaling_group(
AutoScalingGroupName = "my-asg",
DesiredCapacity = 3L,
MaxSize = 5L,
MinSize = 1L,
MixedInstancesPolicy = list(
InstancesDistribution = list(
OnDemandBaseCapacity = 1L,
OnDemandPercentageAboveBaseCapacity = 50L,
SpotAllocationStrategy = "price-capacity-optimized"
),
LaunchTemplate = list(
LaunchTemplateSpecification = list(
LaunchTemplateName = "my-launch-template-for-x86",
Version = "$Default"
),
Overrides = list(
list(
InstanceType = "c6g.large",
LaunchTemplateSpecification = list(
LaunchTemplateName = "my-launch-template-for-arm",
Version = "$Default"
)
),
list(
InstanceType = "c5.large"
),
list(
InstanceType = "c5a.large"
)
)
)
),
VPCZoneIdentifier = "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
)
# This example creates an Auto Scaling group using attribute-based
# instance type selection. It requires the instance types to have a
# minimum of four vCPUs and a maximum of eight vCPUs, a minimum of 16,384
# MiB of memory, and an Intel manufactured CPU.
svc$create_auto_scaling_group(
AutoScalingGroupName = "my-asg",
DesiredCapacity = 4L,
DesiredCapacityType = "units",
MaxSize = 100L,
MinSize = 0L,
MixedInstancesPolicy = list(
InstancesDistribution = list(
OnDemandPercentageAboveBaseCapacity = 50L,
SpotAllocationStrategy = "price-capacity-optimized"
),
LaunchTemplate = list(
LaunchTemplateSpecification = list(
LaunchTemplateName = "my-template-for-auto-scaling",
Version = "$Default"
),
Overrides = list(
list(
InstanceRequirements = list(
CpuManufacturers = list(
"intel"
),
MemoryMiB = list(
Min = 16384L
),
VCpuCount = list(
Max = 8L,
Min = 4L
)
)
)
)
)
),
VPCZoneIdentifier = "subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE"
)
## End(Not run)