Docs
PackagesAWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
aws-native.autoscaling.AutoScalingGroup
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi
The AWS::AutoScaling::AutoScalingGroup resource defines an Amazon EC2 Auto Scaling group, which is a collection of Amazon EC2 instances that are treated as a logical grouping for the purposes of automatic scaling and management.
For more information about Amazon EC2 Auto Scaling, see the Amazon EC2 Auto Scaling User Guide.
Amazon EC2 Auto Scaling configures instances launched as part of an Auto Scaling group using either a launch template or a launch configuration. We strongly recommend that you do not use launch configurations. They do not provide full functionality for Amazon EC2 Auto Scaling or Amazon EC2. For more information, see Launch configurations and Migrate CloudFormation stacks from launch configurations to launch templates in the Amazon EC2 Auto Scaling User Guide.
Create AutoScalingGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AutoScalingGroup(name: string, args: AutoScalingGroupArgs, opts?: CustomResourceOptions);@overload
def AutoScalingGroup(resource_name: str,
args: AutoScalingGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def AutoScalingGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
max_size: Optional[str] = None,
min_size: Optional[str] = None,
lifecycle_hook_specification_list: Optional[Sequence[AutoScalingGroupLifecycleHookSpecificationArgs]] = None,
target_group_arns: Optional[Sequence[str]] = None,
cooldown: Optional[str] = None,
default_instance_warmup: Optional[int] = None,
desired_capacity: Optional[str] = None,
desired_capacity_type: Optional[str] = None,
health_check_grace_period: Optional[int] = None,
health_check_type: Optional[str] = None,
instance_id: Optional[str] = None,
instance_maintenance_policy: Optional[AutoScalingGroupInstanceMaintenancePolicyArgs] = None,
launch_configuration_name: Optional[str] = None,
launch_template: Optional[AutoScalingGroupLaunchTemplateSpecificationArgs] = None,
vpc_zone_identifier: Optional[Sequence[str]] = None,
context: Optional[str] = None,
mixed_instances_policy: Optional[AutoScalingGroupMixedInstancesPolicyArgs] = None,
capacity_rebalance: Optional[bool] = None,
metrics_collection: Optional[Sequence[AutoScalingGroupMetricsCollectionArgs]] = None,
availability_zones: Optional[Sequence[str]] = None,
max_instance_lifetime: Optional[int] = None,
new_instances_protected_from_scale_in: Optional[bool] = None,
notification_configuration: Optional[AutoScalingGroupNotificationConfigurationArgs] = None,
notification_configurations: Optional[Sequence[AutoScalingGroupNotificationConfigurationArgs]] = None,
placement_group: Optional[str] = None,
service_linked_role_arn: Optional[str] = None,
tags: Optional[Sequence[AutoScalingGroupTagPropertyArgs]] = None,
load_balancer_names: Optional[Sequence[str]] = None,
termination_policies: Optional[Sequence[str]] = None,
auto_scaling_group_name: Optional[str] = None)func NewAutoScalingGroup(ctx *Context, name string, args AutoScalingGroupArgs, opts ...ResourceOption) (*AutoScalingGroup, error)public AutoScalingGroup(string name, AutoScalingGroupArgs args, CustomResourceOptions? opts = null)
public AutoScalingGroup(String name, AutoScalingGroupArgs args)
public AutoScalingGroup(String name, AutoScalingGroupArgs args, CustomResourceOptions options)
type: aws-native:autoscaling:AutoScalingGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AutoScalingGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AutoScalingGroupArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AutoScalingGroupArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AutoScalingGroupArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AutoScalingGroupArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Example
The following reference example uses placeholder values for all input properties.
Coming soon!
Coming soon!
Coming soon!
Coming soon!
const autoScalingGroupResource = new aws_native.autoscaling.AutoScalingGroup("autoScalingGroupResource", {
maxSize: "string",
minSize: "string",
lifecycleHookSpecificationList: [{
lifecycleHookName: "string",
lifecycleTransition: "string",
defaultResult: "string",
heartbeatTimeout: 0,
notificationMetadata: "string",
notificationTargetArn: "string",
roleArn: "string",
}],
targetGroupArns: ["string"],
cooldown: "string",
defaultInstanceWarmup: 0,
desiredCapacity: "string",
desiredCapacityType: "string",
healthCheckGracePeriod: 0,
healthCheckType: "string",
instanceId: "string",
instanceMaintenancePolicy: {
maxHealthyPercentage: 0,
minHealthyPercentage: 0,
},
launchConfigurationName: "string",
launchTemplate: {
version: "string",
launchTemplateId: "string",
launchTemplateName: "string",
},
vpcZoneIdentifier: ["string"],
context: "string",
mixedInstancesPolicy: {
launchTemplate: {
launchTemplateSpecification: {
version: "string",
launchTemplateId: "string",
launchTemplateName: "string",
},
overrides: [{
instanceRequirements: {
memoryMiB: {
max: 0,
min: 0,
},
vCpuCount: {
max: 0,
min: 0,
},
localStorage: "string",
acceleratorTypes: ["string"],
localStorageTypes: ["string"],
allowedInstanceTypes: ["string"],
bareMetal: "string",
baselineEbsBandwidthMbps: {
max: 0,
min: 0,
},
burstablePerformance: "string",
cpuManufacturers: ["string"],
maxSpotPriceAsPercentageOfOptimalOnDemandPrice: 0,
instanceGenerations: ["string"],
acceleratorManufacturers: ["string"],
acceleratorTotalMemoryMiB: {
max: 0,
min: 0,
},
excludedInstanceTypes: ["string"],
memoryGiBPerVCpu: {
max: 0,
min: 0,
},
acceleratorNames: ["string"],
networkBandwidthGbps: {
max: 0,
min: 0,
},
networkInterfaceCount: {
max: 0,
min: 0,
},
onDemandMaxPricePercentageOverLowestPrice: 0,
requireHibernateSupport: false,
spotMaxPricePercentageOverLowestPrice: 0,
totalLocalStorageGb: {
max: 0,
min: 0,
},
acceleratorCount: {
max: 0,
min: 0,
},
},
instanceType: "string",
launchTemplateSpecification: {
version: "string",
launchTemplateId: "string",
launchTemplateName: "string",
},
weightedCapacity: "string",
}],
},
instancesDistribution: {
onDemandAllocationStrategy: "string",
onDemandBaseCapacity: 0,
onDemandPercentageAboveBaseCapacity: 0,
spotAllocationStrategy: "string",
spotInstancePools: 0,
spotMaxPrice: "string",
},
},
capacityRebalance: false,
metricsCollection: [{
granularity: "string",
metrics: ["string"],
}],
availabilityZones: ["string"],
maxInstanceLifetime: 0,
newInstancesProtectedFromScaleIn: false,
notificationConfiguration: {
topicArn: ["string"],
notificationTypes: ["string"],
},
notificationConfigurations: [{
topicArn: ["string"],
notificationTypes: ["string"],
}],
placementGroup: "string",
serviceLinkedRoleArn: "string",
tags: [{
key: "string",
propagateAtLaunch: false,
value: "string",
}],
loadBalancerNames: ["string"],
terminationPolicies: ["string"],
autoScalingGroupName: "string",
});
Coming soon!
AutoScalingGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AutoScalingGroup resource accepts the following input properties:
- Max
Size string - The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). - Min
Size string - The minimum size of the group.
- Auto
Scaling stringGroup Name - 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.
- Availability
Zones List<string> - 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
VPCZoneIdentifierproperty, or for attaching a network interface when an existing network interface ID is specified in a launch template. - Capacity
Rebalance bool - 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.
- Context string
- Reserved.
- Cooldown string
- 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:
300seconds - Default
Instance intWarmup - 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
InServicestate. 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-1for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0or other nominal value. Default: None - Desired
Capacity string - 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 automatic scaling. The 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 when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- Desired
Capacity stringType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifiesunits, which translates into number of instances. Valid values:units|vcpu|memory-mib - Health
Check intGrace Period - 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
InServicestate. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default:0seconds - Health
Check stringType - A comma-separated value string of one or more health check types.
The valid values are
EC2,ELB, andVPC_LATTICE.EC2is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. Only specifyEC2if you must clear a value that was previously set. - Instance
Id string - The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you specify
LaunchTemplate,MixedInstancesPolicy, orLaunchConfigurationName, don't specifyInstanceId. - Instance
Maintenance Pulumi.Policy Aws Native. Auto Scaling. Inputs. Auto Scaling Group Instance Maintenance Policy - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- Launch
Configuration stringName - The name of the launch configuration to use to launch instances.
Required only if you don't specify
LaunchTemplate,MixedInstancesPolicy, orInstanceId. - Launch
Template Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Launch Template Specification - Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specifyMixedInstancesPolicy,LaunchConfigurationName, orInstanceId. - Lifecycle
Hook List<Pulumi.Specification List Aws Native. Auto Scaling. Inputs. Auto Scaling Group Lifecycle Hook Specification> - One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- Load
Balancer List<string>Names - 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
TargetGroupARNsproperty instead. - Max
Instance intLifetime - 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
- Metrics
Collection List<Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Metrics Collection> - Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
- Mixed
Instances Pulumi.Policy Aws Native. Auto Scaling. Inputs. Auto Scaling Group Mixed Instances Policy - An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- New
Instances boolProtected From Scale In - 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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
- Notification
Configuration Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Notification Configuration - Notification
Configurations List<Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Notification Configuration> - Configures an Auto Scaling group to send notifications when specified events take place.
- Placement
Group string - 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.
- Service
Linked stringRole Arn - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS 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. -
List<Pulumi.
Aws Native. Auto Scaling. Inputs. Auto Scaling Group Tag Property> - 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.
- Target
Group List<string>Arns - 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.
- Termination
Policies List<string> - 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 Work with Amazon EC2 Auto Scaling termination policies 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 - Vpc
Zone List<string>Identifier - A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
When you update
VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specifyVPCZoneIdentifierwithAvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
- Max
Size string - The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). - Min
Size string - The minimum size of the group.
- Auto
Scaling stringGroup Name - 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.
- Availability
Zones []string - 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
VPCZoneIdentifierproperty, or for attaching a network interface when an existing network interface ID is specified in a launch template. - Capacity
Rebalance bool - 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.
- Context string
- Reserved.
- Cooldown string
- 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:
300seconds - Default
Instance intWarmup - 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
InServicestate. 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-1for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0or other nominal value. Default: None - Desired
Capacity string - 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 automatic scaling. The 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 when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- Desired
Capacity stringType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifiesunits, which translates into number of instances. Valid values:units|vcpu|memory-mib - Health
Check intGrace Period - 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
InServicestate. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default:0seconds - Health
Check stringType - A comma-separated value string of one or more health check types.
The valid values are
EC2,ELB, andVPC_LATTICE.EC2is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. Only specifyEC2if you must clear a value that was previously set. - Instance
Id string - The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you specify
LaunchTemplate,MixedInstancesPolicy, orLaunchConfigurationName, don't specifyInstanceId. - Instance
Maintenance AutoPolicy Scaling Group Instance Maintenance Policy Args - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- Launch
Configuration stringName - The name of the launch configuration to use to launch instances.
Required only if you don't specify
LaunchTemplate,MixedInstancesPolicy, orInstanceId. - Launch
Template AutoScaling Group Launch Template Specification Args - Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specifyMixedInstancesPolicy,LaunchConfigurationName, orInstanceId. - Lifecycle
Hook []AutoSpecification List Scaling Group Lifecycle Hook Specification Args - One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- Load
Balancer []stringNames - 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
TargetGroupARNsproperty instead. - Max
Instance intLifetime - 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
- Metrics
Collection []AutoScaling Group Metrics Collection Args - Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
- Mixed
Instances AutoPolicy Scaling Group Mixed Instances Policy Args - An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- New
Instances boolProtected From Scale In - 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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
- Notification
Configuration AutoScaling Group Notification Configuration Args - Notification
Configurations []AutoScaling Group Notification Configuration Args - Configures an Auto Scaling group to send notifications when specified events take place.
- Placement
Group string - 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.
- Service
Linked stringRole Arn - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS 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. -
[]Auto
Scaling Group Tag Property Args - 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.
- Target
Group []stringArns - 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.
- Termination
Policies []string - 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 Work with Amazon EC2 Auto Scaling termination policies 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 - Vpc
Zone []stringIdentifier - A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
When you update
VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specifyVPCZoneIdentifierwithAvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
- max
Size String - The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). - min
Size String - The minimum size of the group.
- auto
Scaling StringGroup Name - 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.
- availability
Zones List<String> - 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
VPCZoneIdentifierproperty, or for attaching a network interface when an existing network interface ID is specified in a launch template. - capacity
Rebalance Boolean - 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.
- context String
- Reserved.
- cooldown String
- 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:
300seconds - default
Instance IntegerWarmup - 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
InServicestate. 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-1for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0or other nominal value. Default: None - desired
Capacity String - 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 automatic scaling. The 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 when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- desired
Capacity StringType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifiesunits, which translates into number of instances. Valid values:units|vcpu|memory-mib - health
Check IntegerGrace Period - 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
InServicestate. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default:0seconds - health
Check StringType - A comma-separated value string of one or more health check types.
The valid values are
EC2,ELB, andVPC_LATTICE.EC2is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. Only specifyEC2if you must clear a value that was previously set. - instance
Id String - The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you specify
LaunchTemplate,MixedInstancesPolicy, orLaunchConfigurationName, don't specifyInstanceId. - instance
Maintenance AutoPolicy Scaling Group Instance Maintenance Policy - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- launch
Configuration StringName - The name of the launch configuration to use to launch instances.
Required only if you don't specify
LaunchTemplate,MixedInstancesPolicy, orInstanceId. - launch
Template AutoScaling Group Launch Template Specification - Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specifyMixedInstancesPolicy,LaunchConfigurationName, orInstanceId. - lifecycle
Hook List<AutoSpecification List Scaling Group Lifecycle Hook Specification> - One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- load
Balancer List<String>Names - 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
TargetGroupARNsproperty instead. - max
Instance IntegerLifetime - 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
- metrics
Collection List<AutoScaling Group Metrics Collection> - Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
- mixed
Instances AutoPolicy Scaling Group Mixed Instances Policy - An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- new
Instances BooleanProtected From Scale In - 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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
- notification
Configuration AutoScaling Group Notification Configuration - notification
Configurations List<AutoScaling Group Notification Configuration> - Configures an Auto Scaling group to send notifications when specified events take place.
- placement
Group String - 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.
- service
Linked StringRole Arn - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS 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. -
List<Auto
Scaling Group Tag Property> - 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.
- target
Group List<String>Arns - 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.
- termination
Policies List<String> - 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 Work with Amazon EC2 Auto Scaling termination policies 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 - vpc
Zone List<String>Identifier - A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
When you update
VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specifyVPCZoneIdentifierwithAvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
- max
Size string - The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). - min
Size string - The minimum size of the group.
- auto
Scaling stringGroup Name - 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.
- availability
Zones string[] - 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
VPCZoneIdentifierproperty, or for attaching a network interface when an existing network interface ID is specified in a launch template. - capacity
Rebalance boolean - 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.
- context string
- Reserved.
- cooldown string
- 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:
300seconds - default
Instance numberWarmup - 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
InServicestate. 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-1for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0or other nominal value. Default: None - desired
Capacity string - 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 automatic scaling. The 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 when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- desired
Capacity stringType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifiesunits, which translates into number of instances. Valid values:units|vcpu|memory-mib - health
Check numberGrace Period - 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
InServicestate. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default:0seconds - health
Check stringType - A comma-separated value string of one or more health check types.
The valid values are
EC2,ELB, andVPC_LATTICE.EC2is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. Only specifyEC2if you must clear a value that was previously set. - instance
Id string - The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you specify
LaunchTemplate,MixedInstancesPolicy, orLaunchConfigurationName, don't specifyInstanceId. - instance
Maintenance AutoPolicy Scaling Group Instance Maintenance Policy - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- launch
Configuration stringName - The name of the launch configuration to use to launch instances.
Required only if you don't specify
LaunchTemplate,MixedInstancesPolicy, orInstanceId. - launch
Template AutoScaling Group Launch Template Specification - Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specifyMixedInstancesPolicy,LaunchConfigurationName, orInstanceId. - lifecycle
Hook AutoSpecification List Scaling Group Lifecycle Hook Specification[] - One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- load
Balancer string[]Names - 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
TargetGroupARNsproperty instead. - max
Instance numberLifetime - 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
- metrics
Collection AutoScaling Group Metrics Collection[] - Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
- mixed
Instances AutoPolicy Scaling Group Mixed Instances Policy - An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- new
Instances booleanProtected From Scale In - 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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
- notification
Configuration AutoScaling Group Notification Configuration - notification
Configurations AutoScaling Group Notification Configuration[] - Configures an Auto Scaling group to send notifications when specified events take place.
- placement
Group string - 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.
- service
Linked stringRole Arn - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS 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. -
Auto
Scaling Group Tag Property[] - 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.
- target
Group string[]Arns - 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.
- termination
Policies string[] - 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 Work with Amazon EC2 Auto Scaling termination policies 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 - vpc
Zone string[]Identifier - A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
When you update
VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specifyVPCZoneIdentifierwithAvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
- max_
size str - The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). - min_
size str - The minimum size of the group.
- auto_
scaling_ strgroup_ name - 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.
- availability_
zones Sequence[str] - 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
VPCZoneIdentifierproperty, or for attaching a network interface when an existing network interface ID is specified in a launch template. - capacity_
rebalance bool - 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.
- context str
- Reserved.
- cooldown str
- 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:
300seconds - default_
instance_ intwarmup - 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
InServicestate. 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-1for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0or other nominal value. Default: None - desired_
capacity str - 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 automatic scaling. The 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 when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- desired_
capacity_ strtype - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifiesunits, which translates into number of instances. Valid values:units|vcpu|memory-mib - health_
check_ intgrace_ period - 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
InServicestate. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default:0seconds - health_
check_ strtype - A comma-separated value string of one or more health check types.
The valid values are
EC2,ELB, andVPC_LATTICE.EC2is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. Only specifyEC2if you must clear a value that was previously set. - instance_
id str - The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you specify
LaunchTemplate,MixedInstancesPolicy, orLaunchConfigurationName, don't specifyInstanceId. - instance_
maintenance_ Autopolicy Scaling Group Instance Maintenance Policy Args - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- launch_
configuration_ strname - The name of the launch configuration to use to launch instances.
Required only if you don't specify
LaunchTemplate,MixedInstancesPolicy, orInstanceId. - launch_
template AutoScaling Group Launch Template Specification Args - Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specifyMixedInstancesPolicy,LaunchConfigurationName, orInstanceId. - lifecycle_
hook_ Sequence[Autospecification_ list Scaling Group Lifecycle Hook Specification Args] - One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- load_
balancer_ Sequence[str]names - 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
TargetGroupARNsproperty instead. - max_
instance_ intlifetime - 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
- metrics_
collection Sequence[AutoScaling Group Metrics Collection Args] - Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
- mixed_
instances_ Autopolicy Scaling Group Mixed Instances Policy Args - An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- new_
instances_ boolprotected_ from_ scale_ in - 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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
- notification_
configuration AutoScaling Group Notification Configuration Args - notification_
configurations Sequence[AutoScaling Group Notification Configuration Args] - Configures an Auto Scaling group to send notifications when specified events take place.
- placement_
group str - 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.
- service_
linked_ strrole_ arn - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS 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. -
Sequence[Auto
Scaling Group Tag Property Args] - 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.
- target_
group_ Sequence[str]arns - 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.
- termination_
policies Sequence[str] - 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 Work with Amazon EC2 Auto Scaling termination policies 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 - vpc_
zone_ Sequence[str]identifier - A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
When you update
VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specifyVPCZoneIdentifierwithAvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
- max
Size String - The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto Scaling may need to go above
MaxSizeto meet your capacity requirements. In this event, Amazon EC2 Auto Scaling will never go aboveMaxSizeby more than your largest instance weight (weights that define how many units each instance contributes to the desired capacity of the group). - min
Size String - The minimum size of the group.
- auto
Scaling StringGroup Name - 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.
- availability
Zones List<String> - 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
VPCZoneIdentifierproperty, or for attaching a network interface when an existing network interface ID is specified in a launch template. - capacity
Rebalance Boolean - 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.
- context String
- Reserved.
- cooldown String
- 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:
300seconds - default
Instance NumberWarmup - 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
InServicestate. 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-1for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of0or other nominal value. Default: None - desired
Capacity String - 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 automatic scaling. The 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 when creating the stack, the default is the minimum size of the group. CloudFormation marks the Auto Scaling group as successful (by setting its status to CREATE_COMPLETE) when the desired capacity is reached. However, if a maximum Spot price is set in the launch template or launch configuration that you specified, then desired capacity is not used as a criteria for success. Whether your request is fulfilled depends on Spot Instance capacity and your maximum price.
- desired
Capacity StringType - The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports
DesiredCapacityTypefor attribute-based instance type selection only. For more information, see Creating an Auto Scaling group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide. By default, Amazon EC2 Auto Scaling specifiesunits, which translates into number of instances. Valid values:units|vcpu|memory-mib - health
Check NumberGrace Period - 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
InServicestate. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. Default:0seconds - health
Check StringType - A comma-separated value string of one or more health check types.
The valid values are
EC2,ELB, andVPC_LATTICE.EC2is the default health check and cannot be disabled. For more information, see Health checks for Auto Scaling instances in the Amazon EC2 Auto Scaling User Guide. Only specifyEC2if you must clear a value that was previously set. - instance
Id String - The ID of the instance used to base the launch configuration on. For more information, see Create an Auto Scaling group using an EC2 instance in the Amazon EC2 Auto Scaling User Guide.
If you specify
LaunchTemplate,MixedInstancesPolicy, orLaunchConfigurationName, don't specifyInstanceId. - instance
Maintenance Property MapPolicy - An instance maintenance policy. For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide.
- launch
Configuration StringName - The name of the launch configuration to use to launch instances.
Required only if you don't specify
LaunchTemplate,MixedInstancesPolicy, orInstanceId. - launch
Template Property Map - Information used to specify the launch template and version to use to launch instances. You can alternatively associate a launch template to the Auto Scaling group by specifying a
MixedInstancesPolicy. For more information about creating launch templates, see Create a launch template for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide. If you omit this property, you must specifyMixedInstancesPolicy,LaunchConfigurationName, orInstanceId. - lifecycle
Hook List<Property Map>Specification List - One or more lifecycle hooks to add to the Auto Scaling group before instances are launched.
- load
Balancer List<String>Names - 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
TargetGroupARNsproperty instead. - max
Instance NumberLifetime - 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 Replacing Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide.
- metrics
Collection List<Property Map> - Enables the monitoring of group metrics of an Auto Scaling group. By default, these metrics are disabled.
- mixed
Instances Property MapPolicy - An embedded object that specifies a mixed instances policy. The policy includes properties that not only define the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances (optional), and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacities, but also the properties that specify the instance configuration information—the launch template and instance types. The policy can also include a weight for each instance type and different launch templates for individual instance types. For more information, see Auto Scaling groups with multiple instance types and purchase options in the Amazon EC2 Auto Scaling User Guide.
- new
Instances BooleanProtected From Scale In - 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 Using instance scale-in protection in the Amazon EC2 Auto Scaling User Guide.
- notification
Configuration Property Map - notification
Configurations List<Property Map> - Configures an Auto Scaling group to send notifications when specified events take place.
- placement
Group String - 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.
- service
Linked StringRole Arn - The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling group uses to call other AWS 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. - List<Property Map>
- 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.
- target
Group List<String>Arns - 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.
- termination
Policies List<String> - 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 Work with Amazon EC2 Auto Scaling termination policies 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 - vpc
Zone List<String>Identifier - A list of subnet IDs for a virtual private cloud (VPC) where instances in the Auto Scaling group can be created.
If this resource specifies public subnets and is also in a VPC that is defined in the same stack template, you must use the DependsOn attribute to declare a dependency on the VPC-gateway attachment.
When you update
VPCZoneIdentifier, this retains the same Auto Scaling group and replaces old instances with new ones, according to the specified subnets. You can optionally specify how CloudFormation handles these updates by using an UpdatePolicy attribute. Required to launch instances into a nondefault VPC. If you specifyVPCZoneIdentifierwithAvailabilityZones, the subnets that you specify for this property must reside in those Availability Zones.
Outputs
All input properties are implicitly available as output properties. Additionally, the AutoScalingGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
AutoScalingGroupAcceleratorCountRequest, AutoScalingGroupAcceleratorCountRequestArgs
AutoScalingGroupAcceleratorTotalMemoryMiBRequest, AutoScalingGroupAcceleratorTotalMemoryMiBRequestArgs
AutoScalingGroupBaselineEbsBandwidthMbpsRequest, AutoScalingGroupBaselineEbsBandwidthMbpsRequestArgs
AutoScalingGroupInstanceMaintenancePolicy, AutoScalingGroupInstanceMaintenancePolicyArgs
- Max
Healthy intPercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1. BothMinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. - Min
Healthy intPercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.
- Max
Healthy intPercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1. BothMinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. - Min
Healthy intPercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.
- max
Healthy IntegerPercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1. BothMinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. - min
Healthy IntegerPercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.
- max
Healthy numberPercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1. BothMinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. - min
Healthy numberPercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.
- max_
healthy_ intpercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1. BothMinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. - min_
healthy_ intpercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.
- max
Healthy NumberPercentage - Specifies the upper threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the maximum percentage of the group that can be in service and healthy, or pending, to support your workload when replacing instances. Value range is 100 to 200. To clear a previously set value, specify a value of
-1. BothMinHealthyPercentageandMaxHealthyPercentagemust be specified, and the difference between them cannot be greater than 100. A large range increases the number of instances that can be replaced at the same time. - min
Healthy NumberPercentage - Specifies the lower threshold as a percentage of the desired capacity of the Auto Scaling group. It represents the minimum percentage of the group to keep in service, healthy, and ready to use to support your workload when replacing instances. Value range is 0 to 100. To clear a previously set value, specify a value of
-1.
AutoScalingGroupInstanceRequirements, AutoScalingGroupInstanceRequirementsArgs
- Memory
Mi Pulumi.B Aws Native. Auto Scaling. Inputs. Auto Scaling Group Memory Mi BRequest - The minimum and maximum instance memory size for an instance type, in MiB.
- VCpu
Count Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group VCpu Count Request - The minimum and maximum number of vCPUs for an instance type.
- Accelerator
Count Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Accelerator Count Request - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0. Default: No minimum or maximum limits - Accelerator
Manufacturers List<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 AWS devices, specify
amazon-web-services. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
- For instance types with NVIDIA devices, specify
- Accelerator
Names List<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
- For instance types with NVIDIA A100 GPUs, specify
- Accelerator
Total Pulumi.Memory Mi B Aws Native. Auto Scaling. Inputs. Auto Scaling Group Accelerator Total Memory Mi BRequest - The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits
- Accelerator
Types List<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
- For instance types with GPU accelerators, specify
- Allowed
Instance List<string>Types - 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 specifyc5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specifyAllowedInstanceTypes, you can't specifyExcludedInstanceTypes. Default: All instance types - Bare
Metal string - Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded - Baseline
Ebs Pulumi.Bandwidth Mbps Aws Native. Auto Scaling. Inputs. Auto Scaling Group Baseline Ebs Bandwidth Mbps Request - 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
- Burstable
Performance 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 - Cpu
Manufacturers List<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 AWS 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
- For instance types with Intel CPUs, specify
- Excluded
Instance List<string>Types - 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 specifyc5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specifyExcludedInstanceTypes, you can't specifyAllowedInstanceTypes. Default: No excluded instance types - Instance
Generations List<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
- For current generation instance types, specify
- Local
Storage 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 - Local
Storage List<string>Types 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
- For instance types with hard disk drive (HDD) storage, specify
- Max
Spot intPrice As Percentage Of Optimal On Demand Price - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as
999999. If you setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, thenSpotMaxPricePercentageOverLowestPriceis used and the value for that parameter defaults to100. - Memory
Gi Pulumi.BPer VCpu Aws Native. Auto Scaling. Inputs. Auto Scaling Group Memory Gi BPer VCpu Request - The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits
- Network
Bandwidth Pulumi.Gbps Aws Native. Auto Scaling. Inputs. Auto Scaling Group Network Bandwidth Gbps Request - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
- Network
Interface Pulumi.Count Aws Native. Auto Scaling. Inputs. Auto Scaling Group Network Interface Count Request - The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits
- On
Demand intMax Price Percentage Over Lowest Price - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default:20 - Require
Hibernate boolSupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
false - Spot
Max intPrice Percentage Over Lowest Price - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. Default:100 - Total
Local Pulumi.Storage Gb Aws Native. Auto Scaling. Inputs. Auto Scaling Group Total Local Storage Gb Request - The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits
- Memory
Mi AutoB Scaling Group Memory Mi BRequest - The minimum and maximum instance memory size for an instance type, in MiB.
- VCpu
Count AutoScaling Group VCpu Count Request - The minimum and maximum number of vCPUs for an instance type.
- Accelerator
Count AutoScaling Group Accelerator Count Request - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0. Default: No minimum or maximum limits - Accelerator
Manufacturers []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 AWS devices, specify
amazon-web-services. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
- For instance types with NVIDIA devices, specify
- Accelerator
Names []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
- For instance types with NVIDIA A100 GPUs, specify
- Accelerator
Total AutoMemory Mi B Scaling Group Accelerator Total Memory Mi BRequest - The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits
- Accelerator
Types []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
- For instance types with GPU accelerators, specify
- Allowed
Instance []stringTypes - 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 specifyc5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specifyAllowedInstanceTypes, you can't specifyExcludedInstanceTypes. Default: All instance types - Bare
Metal string - Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded - Baseline
Ebs AutoBandwidth Mbps Scaling Group Baseline Ebs Bandwidth Mbps Request - 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
- Burstable
Performance 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 - Cpu
Manufacturers []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 AWS 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
- For instance types with Intel CPUs, specify
- Excluded
Instance []stringTypes - 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 specifyc5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specifyExcludedInstanceTypes, you can't specifyAllowedInstanceTypes. Default: No excluded instance types - Instance
Generations []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
- For current generation instance types, specify
- Local
Storage 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 - Local
Storage []stringTypes 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
- For instance types with hard disk drive (HDD) storage, specify
- Max
Spot intPrice As Percentage Of Optimal On Demand Price - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as
999999. If you setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, thenSpotMaxPricePercentageOverLowestPriceis used and the value for that parameter defaults to100. - Memory
Gi AutoBPer VCpu Scaling Group Memory Gi BPer VCpu Request - The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits
- Network
Bandwidth AutoGbps Scaling Group Network Bandwidth Gbps Request - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
- Network
Interface AutoCount Scaling Group Network Interface Count Request - The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits
- On
Demand intMax Price Percentage Over Lowest Price - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default:20 - Require
Hibernate boolSupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
false - Spot
Max intPrice Percentage Over Lowest Price - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. Default:100 - Total
Local AutoStorage Gb Scaling Group Total Local Storage Gb Request - The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits
- memory
Mi AutoB Scaling Group Memory Mi BRequest - The minimum and maximum instance memory size for an instance type, in MiB.
- v
Cpu AutoCount Scaling Group VCpu Count Request - The minimum and maximum number of vCPUs for an instance type.
- accelerator
Count AutoScaling Group Accelerator Count Request - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0. Default: No minimum or maximum limits - accelerator
Manufacturers List<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 AWS devices, specify
amazon-web-services. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
- For instance types with NVIDIA devices, specify
- accelerator
Names List<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
- For instance types with NVIDIA A100 GPUs, specify
- accelerator
Total AutoMemory Mi B Scaling Group Accelerator Total Memory Mi BRequest - The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits
- accelerator
Types List<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
- For instance types with GPU accelerators, specify
- allowed
Instance List<String>Types - 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 specifyc5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specifyAllowedInstanceTypes, you can't specifyExcludedInstanceTypes. Default: All instance types - bare
Metal String - Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded - baseline
Ebs AutoBandwidth Mbps Scaling Group Baseline Ebs Bandwidth Mbps Request - 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
- burstable
Performance 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 - cpu
Manufacturers List<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 AWS 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
- For instance types with Intel CPUs, specify
- excluded
Instance List<String>Types - 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 specifyc5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specifyExcludedInstanceTypes, you can't specifyAllowedInstanceTypes. Default: No excluded instance types - instance
Generations List<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
- For current generation instance types, specify
- local
Storage 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 - local
Storage List<String>Types 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
- For instance types with hard disk drive (HDD) storage, specify
- max
Spot IntegerPrice As Percentage Of Optimal On Demand Price - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as
999999. If you setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, thenSpotMaxPricePercentageOverLowestPriceis used and the value for that parameter defaults to100. - memory
Gi AutoBPer VCpu Scaling Group Memory Gi BPer VCpu Request - The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits
- network
Bandwidth AutoGbps Scaling Group Network Bandwidth Gbps Request - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
- network
Interface AutoCount Scaling Group Network Interface Count Request - The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits
- on
Demand IntegerMax Price Percentage Over Lowest Price - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default:20 - require
Hibernate BooleanSupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
false - spot
Max IntegerPrice Percentage Over Lowest Price - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. Default:100 - total
Local AutoStorage Gb Scaling Group Total Local Storage Gb Request - The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits
- memory
Mi AutoB Scaling Group Memory Mi BRequest - The minimum and maximum instance memory size for an instance type, in MiB.
- v
Cpu AutoCount Scaling Group VCpu Count Request - The minimum and maximum number of vCPUs for an instance type.
- accelerator
Count AutoScaling Group Accelerator Count Request - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0. Default: No minimum or maximum limits - accelerator
Manufacturers 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 AWS devices, specify
amazon-web-services. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
- For instance types with NVIDIA devices, specify
- accelerator
Names 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
- For instance types with NVIDIA A100 GPUs, specify
- accelerator
Total AutoMemory Mi B Scaling Group Accelerator Total Memory Mi BRequest - The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits
- accelerator
Types 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
- For instance types with GPU accelerators, specify
- allowed
Instance string[]Types - 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 specifyc5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specifyAllowedInstanceTypes, you can't specifyExcludedInstanceTypes. Default: All instance types - bare
Metal string - Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded - baseline
Ebs AutoBandwidth Mbps Scaling Group Baseline Ebs Bandwidth Mbps Request - 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
- burstable
Performance 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 - cpu
Manufacturers 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 AWS 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
- For instance types with Intel CPUs, specify
- excluded
Instance string[]Types - 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 specifyc5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specifyExcludedInstanceTypes, you can't specifyAllowedInstanceTypes. Default: No excluded instance types - instance
Generations 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
- For current generation instance types, specify
- local
Storage 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 - local
Storage string[]Types 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
- For instance types with hard disk drive (HDD) storage, specify
- max
Spot numberPrice As Percentage Of Optimal On Demand Price - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as
999999. If you setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, thenSpotMaxPricePercentageOverLowestPriceis used and the value for that parameter defaults to100. - memory
Gi AutoBPer VCpu Scaling Group Memory Gi BPer VCpu Request - The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits
- network
Bandwidth AutoGbps Scaling Group Network Bandwidth Gbps Request - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
- network
Interface AutoCount Scaling Group Network Interface Count Request - The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits
- on
Demand numberMax Price Percentage Over Lowest Price - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default:20 - require
Hibernate booleanSupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
false - spot
Max numberPrice Percentage Over Lowest Price - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. Default:100 - total
Local AutoStorage Gb Scaling Group Total Local Storage Gb Request - The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits
- memory_
mi_ Autob Scaling Group Memory Mi BRequest - The minimum and maximum instance memory size for an instance type, in MiB.
- v_
cpu_ Autocount Scaling Group VCpu Count Request - The minimum and maximum number of vCPUs for an instance type.
- accelerator_
count AutoScaling Group Accelerator Count Request - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0. Default: No minimum or maximum limits - accelerator_
manufacturers Sequence[str] 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 AWS devices, specify
amazon-web-services. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
- For instance types with NVIDIA devices, specify
- accelerator_
names Sequence[str] 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
- For instance types with NVIDIA A100 GPUs, specify
- accelerator_
total_ Automemory_ mi_ b Scaling Group Accelerator Total Memory Mi BRequest - The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits
- accelerator_
types Sequence[str] 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
- For instance types with GPU accelerators, specify
- allowed_
instance_ Sequence[str]types - 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 specifyc5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specifyAllowedInstanceTypes, you can't specifyExcludedInstanceTypes. Default: All instance types - bare_
metal str - Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded - baseline_
ebs_ Autobandwidth_ mbps Scaling Group Baseline Ebs Bandwidth Mbps Request - 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
- burstable_
performance str - 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 - cpu_
manufacturers Sequence[str] 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 AWS 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
- For instance types with Intel CPUs, specify
- excluded_
instance_ Sequence[str]types - 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 specifyc5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specifyExcludedInstanceTypes, you can't specifyAllowedInstanceTypes. Default: No excluded instance types - instance_
generations Sequence[str] 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
- For current generation instance types, specify
- local_
storage str - 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 - local_
storage_ Sequence[str]types 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
- For instance types with hard disk drive (HDD) storage, specify
- max_
spot_ intprice_ as_ percentage_ of_ optimal_ on_ demand_ price - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as
999999. If you setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, thenSpotMaxPricePercentageOverLowestPriceis used and the value for that parameter defaults to100. - memory_
gi_ Autob_ per_ v_ cpu Scaling Group Memory Gi BPer VCpu Request - The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits
- network_
bandwidth_ Autogbps Scaling Group Network Bandwidth Gbps Request - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
- network_
interface_ Autocount Scaling Group Network Interface Count Request - The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits
- on_
demand_ intmax_ price_ percentage_ over_ lowest_ price - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default:20 - require_
hibernate_ boolsupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
false - spot_
max_ intprice_ percentage_ over_ lowest_ price - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. Default:100 - total_
local_ Autostorage_ gb Scaling Group Total Local Storage Gb Request - The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits
- memory
Mi Property MapB - The minimum and maximum instance memory size for an instance type, in MiB.
- v
Cpu Property MapCount - The minimum and maximum number of vCPUs for an instance type.
- accelerator
Count Property Map - The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set
Maxto0. Default: No minimum or maximum limits - accelerator
Manufacturers List<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 AWS devices, specify
amazon-web-services. - For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
- For instance types with NVIDIA devices, specify
- accelerator
Names List<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
- For instance types with NVIDIA A100 GPUs, specify
- accelerator
Total Property MapMemory Mi B - The minimum and maximum total memory size for the accelerators on an instance type, in MiB. Default: No minimum or maximum limits
- accelerator
Types List<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
- For instance types with GPU accelerators, specify
- allowed
Instance List<String>Types - 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 specifyc5*, Amazon EC2 Auto Scaling will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types. If you specifyAllowedInstanceTypes, you can't specifyExcludedInstanceTypes. Default: All instance types - bare
Metal String - Indicates whether bare metal instance types are included, excluded, or required.
Default:
excluded - baseline
Ebs Property MapBandwidth Mbps - 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
- burstable
Performance 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 - cpu
Manufacturers List<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 AWS 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
- For instance types with Intel CPUs, specify
- excluded
Instance List<String>Types - 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 specifyc5*, you are excluding the entire C5 instance family, which includes all C5a and C5n instance types. If you specifym5a.*, Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types. If you specifyExcludedInstanceTypes, you can't specifyAllowedInstanceTypes. Default: No excluded instance types - instance
Generations List<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
- For current generation instance types, specify
- local
Storage 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 - local
Storage List<String>Types 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
- For instance types with hard disk drive (HDD) storage, specify
- max
Spot NumberPrice As Percentage Of Optimal On Demand Price - [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified threshold.
The parameter accepts an integer, which Amazon EC2 Auto Scaling interprets as a percentage.
To indicate no price protection threshold, specify a high value, such as
999999. If you setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, thenSpotMaxPricePercentageOverLowestPriceis used and the value for that parameter defaults to100. - memory
Gi Property MapBPer VCpu - The minimum and maximum amount of memory per vCPU for an instance type, in GiB. Default: No minimum or maximum limits
- network
Bandwidth Property MapGbps - The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits
- network
Interface Property MapCount - The minimum and maximum number of network interfaces for an instance type. Default: No minimum or maximum limits
- on
Demand NumberMax Price Percentage Over Lowest Price - [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price. Default:20 - require
Hibernate BooleanSupport - Indicates whether instance types must provide On-Demand Instance hibernation support.
Default:
false - spot
Max NumberPrice Percentage Over Lowest Price - [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from either the lowest priced current generation instance types or, failing that, the lowest priced previous generation instance types that match your attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price exceeds your specified 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 setDesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price. Only one ofSpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. Default:100 - total
Local Property MapStorage Gb - The minimum and maximum total local storage size for an instance type, in GB. Default: No minimum or maximum limits
AutoScalingGroupInstancesDistribution, AutoScalingGroupInstancesDistributionArgs
- On
Demand stringAllocation Strategy - 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:
- lowest-price 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. + 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 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.
- On
Demand intBase Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
- On
Demand intPercentage Above Base Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. - Spot
Allocation stringStrategy - 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:
- capacity-optimized 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. + 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. + lowest-price 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. + price-capacity-optimized (recommended) 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.
- Spot
Instance intPools - 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
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20. Default: 2 - Spot
Max stringPrice - 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
- On
Demand stringAllocation Strategy - 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:
- lowest-price 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. + 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 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.
- On
Demand intBase Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
- On
Demand intPercentage Above Base Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. - Spot
Allocation stringStrategy - 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:
- capacity-optimized 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. + 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. + lowest-price 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. + price-capacity-optimized (recommended) 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.
- Spot
Instance intPools - 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
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20. Default: 2 - Spot
Max stringPrice - 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
- on
Demand StringAllocation Strategy - 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:
- lowest-price 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. + 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 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.
- on
Demand IntegerBase Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
- on
Demand IntegerPercentage Above Base Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. - spot
Allocation StringStrategy - 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:
- capacity-optimized 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. + 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. + lowest-price 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. + price-capacity-optimized (recommended) 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.
- spot
Instance IntegerPools - 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
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20. Default: 2 - spot
Max StringPrice - 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
- on
Demand stringAllocation Strategy - 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:
- lowest-price 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. + 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 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.
- on
Demand numberBase Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
- on
Demand numberPercentage Above Base Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. - spot
Allocation stringStrategy - 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:
- capacity-optimized 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. + 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. + lowest-price 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. + price-capacity-optimized (recommended) 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.
- spot
Instance numberPools - 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
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20. Default: 2 - spot
Max stringPrice - 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
- on_
demand_ strallocation_ strategy - 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:
- lowest-price 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. + 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 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.
- on_
demand_ intbase_ capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
- on_
demand_ intpercentage_ above_ base_ capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. - spot_
allocation_ strstrategy - 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:
- capacity-optimized 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. + 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. + lowest-price 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. + price-capacity-optimized (recommended) 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.
- spot_
instance_ intpools - 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
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20. Default: 2 - spot_
max_ strprice - 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
- on
Demand StringAllocation Strategy - 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:
- lowest-price 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. + 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 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.
- on
Demand NumberBase Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand Instance levels. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones.
- on
Demand NumberPercentage Above Base Capacity - 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 An update to this setting means a gradual replacement of instances to adjust the current On-Demand and Spot Instance levels for your additional capacity higher than the base capacity. When replacing instances, Amazon EC2 Auto Scaling launches new instances before terminating the previous ones. - spot
Allocation StringStrategy - 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:
- capacity-optimized 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. + 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. + lowest-price 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. + price-capacity-optimized (recommended) 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.
- spot
Instance NumberPools - 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
SpotAllocationStrategyislowest-price. Value must be in the range of 1–20. Default: 2 - spot
Max StringPrice - 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
AutoScalingGroupLaunchTemplate, AutoScalingGroupLaunchTemplateArgs
- Launch
Template Pulumi.Specification Aws Native. Auto Scaling. Inputs. Auto Scaling Group Launch Template Specification - The launch template.
- Overrides
List<Pulumi.
Aws Native. Auto Scaling. Inputs. Auto Scaling Group Launch Template Overrides> - Any properties that you specify override the same properties in the launch template.
- Launch
Template AutoSpecification Scaling Group Launch Template Specification - The launch template.
- Overrides
[]Auto
Scaling Group Launch Template Overrides - Any properties that you specify override the same properties in the launch template.
- launch
Template AutoSpecification Scaling Group Launch Template Specification - The launch template.
- overrides
List<Auto
Scaling Group Launch Template Overrides> - Any properties that you specify override the same properties in the launch template.
- launch
Template AutoSpecification Scaling Group Launch Template Specification - The launch template.
- overrides
Auto
Scaling Group Launch Template Overrides[] - Any properties that you specify override the same properties in the launch template.
- launch_
template_ Autospecification Scaling Group Launch Template Specification - The launch template.
- overrides
Sequence[Auto
Scaling Group Launch Template Overrides] - Any properties that you specify override the same properties in the launch template.
- launch
Template Property MapSpecification - The launch template.
- overrides List<Property Map>
- Any properties that you specify override the same properties in the launch template.
AutoScalingGroupLaunchTemplateOverrides, AutoScalingGroupLaunchTemplateOverridesArgs
- Instance
Requirements Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Instance Requirements - 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 specifyInstanceType. - Instance
Type string - 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. - Launch
Template Pulumi.Specification Aws Native. Auto Scaling. Inputs. Auto Scaling Group Launch Template Specification - 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
LaunchTemplatedefinition. 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 theLaunchTemplatedefinition count towards this limit. - Weighted
Capacity string - 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
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure 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 forWeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them. Every Auto Scaling group has three size parameters (DesiredCapacity,MaxSize, andMinSize). 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.
- Instance
Requirements AutoScaling Group Instance Requirements - 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 specifyInstanceType. - Instance
Type string - 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. - Launch
Template AutoSpecification Scaling Group Launch Template Specification - 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
LaunchTemplatedefinition. 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 theLaunchTemplatedefinition count towards this limit. - Weighted
Capacity string - 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
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure 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 forWeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them. Every Auto Scaling group has three size parameters (DesiredCapacity,MaxSize, andMinSize). 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.
- instance
Requirements AutoScaling Group Instance Requirements - 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 specifyInstanceType. - instance
Type String - 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. - launch
Template AutoSpecification Scaling Group Launch Template Specification - 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
LaunchTemplatedefinition. 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 theLaunchTemplatedefinition count towards this limit. - weighted
Capacity String - 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
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure 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 forWeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them. Every Auto Scaling group has three size parameters (DesiredCapacity,MaxSize, andMinSize). 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.
- instance
Requirements AutoScaling Group Instance Requirements - 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 specifyInstanceType. - instance
Type string - 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. - launch
Template AutoSpecification Scaling Group Launch Template Specification - 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
LaunchTemplatedefinition. 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 theLaunchTemplatedefinition count towards this limit. - weighted
Capacity string - 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
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure 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 forWeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them. Every Auto Scaling group has three size parameters (DesiredCapacity,MaxSize, andMinSize). 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.
- instance_
requirements AutoScaling Group Instance Requirements - 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 specifyInstanceType. - instance_
type str - 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. - launch_
template_ Autospecification Scaling Group Launch Template Specification - 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
LaunchTemplatedefinition. 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 theLaunchTemplatedefinition count towards this limit. - weighted_
capacity str - 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
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure 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 forWeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them. Every Auto Scaling group has three size parameters (DesiredCapacity,MaxSize, andMinSize). 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.
- instance
Requirements Property Map - 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 specifyInstanceType. - instance
Type String - 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. - launch
Template Property MapSpecification - 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
LaunchTemplatedefinition. 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 theLaunchTemplatedefinition count towards this limit. - weighted
Capacity String - 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
WeightedCapacityof five units, the instance is launched, and the desired capacity is exceeded by three units. For more information, see Configure 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 forWeightedCapacityfor one instance type, you must specify a value forWeightedCapacityfor all of them. Every Auto Scaling group has three size parameters (DesiredCapacity,MaxSize, andMinSize). 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.
AutoScalingGroupLaunchTemplateSpecification, AutoScalingGroupLaunchTemplateSpecificationArgs
- Version string
- The version number of the launch template.
Specifying
$Latestor$Defaultfor the template version number is not supported. However, you can specifyLatestVersionNumberorDefaultVersionNumberusing theFn::GetAttintrinsic function. For more information, see Fn::GetAtt. For an example of using theFn::GetAttfunction, see the Examples section of theAWS::AutoScaling::AutoScalingGroupresource. - Launch
Template stringId - The ID of the launch template.
You must specify the
LaunchTemplateIDor theLaunchTemplateName, but not both. - Launch
Template stringName - The name of the launch template.
You must specify the
LaunchTemplateNameor theLaunchTemplateID, but not both.
- Version string
- The version number of the launch template.
Specifying
$Latestor$Defaultfor the template version number is not supported. However, you can specifyLatestVersionNumberorDefaultVersionNumberusing theFn::GetAttintrinsic function. For more information, see Fn::GetAtt. For an example of using theFn::GetAttfunction, see the Examples section of theAWS::AutoScaling::AutoScalingGroupresource. - Launch
Template stringId - The ID of the launch template.
You must specify the
LaunchTemplateIDor theLaunchTemplateName, but not both. - Launch
Template stringName - The name of the launch template.
You must specify the
LaunchTemplateNameor theLaunchTemplateID, but not both.
- version String
- The version number of the launch template.
Specifying
$Latestor$Defaultfor the template version number is not supported. However, you can specifyLatestVersionNumberorDefaultVersionNumberusing theFn::GetAttintrinsic function. For more information, see Fn::GetAtt. For an example of using theFn::GetAttfunction, see the Examples section of theAWS::AutoScaling::AutoScalingGroupresource. - launch
Template StringId - The ID of the launch template.
You must specify the
LaunchTemplateIDor theLaunchTemplateName, but not both. - launch
Template StringName - The name of the launch template.
You must specify the
LaunchTemplateNameor theLaunchTemplateID, but not both.
- version string
- The version number of the launch template.
Specifying
$Latestor$Defaultfor the template version number is not supported. However, you can specifyLatestVersionNumberorDefaultVersionNumberusing theFn::GetAttintrinsic function. For more information, see Fn::GetAtt. For an example of using theFn::GetAttfunction, see the Examples section of theAWS::AutoScaling::AutoScalingGroupresource. - launch
Template stringId - The ID of the launch template.
You must specify the
LaunchTemplateIDor theLaunchTemplateName, but not both. - launch
Template stringName - The name of the launch template.
You must specify the
LaunchTemplateNameor theLaunchTemplateID, but not both.
- version str
- The version number of the launch template.
Specifying
$Latestor$Defaultfor the template version number is not supported. However, you can specifyLatestVersionNumberorDefaultVersionNumberusing theFn::GetAttintrinsic function. For more information, see Fn::GetAtt. For an example of using theFn::GetAttfunction, see the Examples section of theAWS::AutoScaling::AutoScalingGroupresource. - launch_
template_ strid - The ID of the launch template.
You must specify the
LaunchTemplateIDor theLaunchTemplateName, but not both. - launch_
template_ strname - The name of the launch template.
You must specify the
LaunchTemplateNameor theLaunchTemplateID, but not both.
- version String
- The version number of the launch template.
Specifying
$Latestor$Defaultfor the template version number is not supported. However, you can specifyLatestVersionNumberorDefaultVersionNumberusing theFn::GetAttintrinsic function. For more information, see Fn::GetAtt. For an example of using theFn::GetAttfunction, see the Examples section of theAWS::AutoScaling::AutoScalingGroupresource. - launch
Template StringId - The ID of the launch template.
You must specify the
LaunchTemplateIDor theLaunchTemplateName, but not both. - launch
Template StringName - The name of the launch template.
You must specify the
LaunchTemplateNameor theLaunchTemplateID, but not both.
AutoScalingGroupLifecycleHookSpecification, AutoScalingGroupLifecycleHookSpecificationArgs
- Lifecycle
Hook stringName - The name of the lifecycle hook.
- Lifecycle
Transition string - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING. - To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING.
- To create a lifecycle hook for scale-out events, specify
- Default
Result string - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is
ABANDON. Valid values:CONTINUE|ABANDON - Heartbeat
Timeout int - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30to7200seconds. The default value is3600seconds (1 hour). - Notification
Metadata string - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- Notification
Target stringArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- Role
Arn string - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
- Lifecycle
Hook stringName - The name of the lifecycle hook.
- Lifecycle
Transition string - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING. - To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING.
- To create a lifecycle hook for scale-out events, specify
- Default
Result string - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is
ABANDON. Valid values:CONTINUE|ABANDON - Heartbeat
Timeout int - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30to7200seconds. The default value is3600seconds (1 hour). - Notification
Metadata string - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- Notification
Target stringArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- Role
Arn string - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
- lifecycle
Hook StringName - The name of the lifecycle hook.
- lifecycle
Transition String - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING. - To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING.
- To create a lifecycle hook for scale-out events, specify
- default
Result String - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is
ABANDON. Valid values:CONTINUE|ABANDON - heartbeat
Timeout Integer - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30to7200seconds. The default value is3600seconds (1 hour). - notification
Metadata String - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- notification
Target StringArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- role
Arn String - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
- lifecycle
Hook stringName - The name of the lifecycle hook.
- lifecycle
Transition string - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING. - To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING.
- To create a lifecycle hook for scale-out events, specify
- default
Result string - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is
ABANDON. Valid values:CONTINUE|ABANDON - heartbeat
Timeout number - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30to7200seconds. The default value is3600seconds (1 hour). - notification
Metadata string - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- notification
Target stringArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- role
Arn string - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
- lifecycle_
hook_ strname - The name of the lifecycle hook.
- lifecycle_
transition str - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING. - To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING.
- To create a lifecycle hook for scale-out events, specify
- default_
result str - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is
ABANDON. Valid values:CONTINUE|ABANDON - heartbeat_
timeout int - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30to7200seconds. The default value is3600seconds (1 hour). - notification_
metadata str - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- notification_
target_ strarn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- role_
arn str - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
- lifecycle
Hook StringName - The name of the lifecycle hook.
- lifecycle
Transition String - The lifecycle transition. For Auto Scaling groups, there are two major lifecycle transitions.
- To create a lifecycle hook for scale-out events, specify
autoscaling:EC2_INSTANCE_LAUNCHING. - To create a lifecycle hook for scale-in events, specify
autoscaling:EC2_INSTANCE_TERMINATING.
- To create a lifecycle hook for scale-out events, specify
- default
Result String - The action the Auto Scaling group takes when the lifecycle hook timeout elapses or if an unexpected failure occurs. The default value is
ABANDON. Valid values:CONTINUE|ABANDON - heartbeat
Timeout Number - The maximum time, in seconds, that can elapse before the lifecycle hook times out. The range is from
30to7200seconds. The default value is3600seconds (1 hour). - notification
Metadata String - Additional information that you want to include any time Amazon EC2 Auto Scaling sends a message to the notification target.
- notification
Target StringArn - The Amazon Resource Name (ARN) of the notification target that Amazon EC2 Auto Scaling sends notifications to when an instance is in a wait state for the lifecycle hook. You can specify an Amazon SNS topic or an Amazon SQS queue.
- role
Arn String - The ARN of the IAM role that allows the Auto Scaling group to publish to the specified notification target. For information about creating this role, see Configure a notification target for a lifecycle hook in the Amazon EC2 Auto Scaling User Guide. Valid only if the notification target is an Amazon SNS topic or an Amazon SQS queue.
AutoScalingGroupMemoryGiBPerVCpuRequest, AutoScalingGroupMemoryGiBPerVCpuRequestArgs
AutoScalingGroupMemoryMiBRequest, AutoScalingGroupMemoryMiBRequestArgs
AutoScalingGroupMetricsCollection, AutoScalingGroupMetricsCollectionArgs
- Granularity string
- The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute. - Metrics List<string>
Identifies the metrics to enable. You can specify one or more of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
If you specify
Granularityand don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
- Granularity string
- The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute. - Metrics []string
Identifies the metrics to enable. You can specify one or more of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
If you specify
Granularityand don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
- granularity String
- The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute. - metrics List<String>
Identifies the metrics to enable. You can specify one or more of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
If you specify
Granularityand don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
- granularity string
- The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute. - metrics string[]
Identifies the metrics to enable. You can specify one or more of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
If you specify
Granularityand don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
- granularity str
- The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute. - metrics Sequence[str]
Identifies the metrics to enable. You can specify one or more of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
If you specify
Granularityand don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
- granularity String
- The frequency at which Amazon EC2 Auto Scaling sends aggregated data to CloudWatch. The only valid value is
1Minute. - metrics List<String>
Identifies the metrics to enable. You can specify one or more of the following metrics:
GroupMinSizeGroupMaxSizeGroupDesiredCapacityGroupInServiceInstancesGroupPendingInstancesGroupStandbyInstancesGroupTerminatingInstancesGroupTotalInstancesGroupInServiceCapacityGroupPendingCapacityGroupStandbyCapacityGroupTerminatingCapacityGroupTotalCapacityWarmPoolDesiredCapacityWarmPoolWarmedCapacityWarmPoolPendingCapacityWarmPoolTerminatingCapacityWarmPoolTotalCapacityGroupAndWarmPoolDesiredCapacityGroupAndWarmPoolTotalCapacity
If you specify
Granularityand don't specify any metrics, all metrics are enabled. For more information, see Auto Scaling group metrics in the Amazon EC2 Auto Scaling User Guide.
AutoScalingGroupMixedInstancesPolicy, AutoScalingGroupMixedInstancesPolicyArgs
- Launch
Template Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Launch Template - One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
- Instances
Distribution Pulumi.Aws Native. Auto Scaling. Inputs. Auto Scaling Group Instances Distribution - The instances distribution.
- Launch
Template AutoScaling Group Launch Template - One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
- Instances
Distribution AutoScaling Group Instances Distribution - The instances distribution.
- launch
Template AutoScaling Group Launch Template - One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
- instances
Distribution AutoScaling Group Instances Distribution - The instances distribution.
- launch
Template AutoScaling Group Launch Template - One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
- instances
Distribution AutoScaling Group Instances Distribution - The instances distribution.
- launch_
template AutoScaling Group Launch Template - One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
- instances_
distribution AutoScaling Group Instances Distribution - The instances distribution.
- launch
Template Property Map - One or more launch templates and the instance types (overrides) that are used to launch EC2 instances to fulfill On-Demand and Spot capacities.
- instances
Distribution Property Map - The instances distribution.
AutoScalingGroupNetworkBandwidthGbpsRequest, AutoScalingGroupNetworkBandwidthGbpsRequestArgs
AutoScalingGroupNetworkInterfaceCountRequest, AutoScalingGroupNetworkInterfaceCountRequestArgs
AutoScalingGroupNotificationConfiguration, AutoScalingGroupNotificationConfigurationArgs
- Topic
Arn List<string> - The Amazon Resource Name (ARN) of the Amazon SNS topic.
- Notification
Types List<string> - A list of event types that send a notification. Event types can include any of the following types.
Allowed values:
autoscaling:EC2_INSTANCE_LAUNCHautoscaling:EC2_INSTANCE_LAUNCH_ERRORautoscaling:EC2_INSTANCE_TERMINATEautoscaling:EC2_INSTANCE_TERMINATE_ERRORautoscaling:TEST_NOTIFICATION
- Topic
Arn []string - The Amazon Resource Name (ARN) of the Amazon SNS topic.
- Notification
Types []string - A list of event types that send a notification. Event types can include any of the following types.
Allowed values:
autoscaling:EC2_INSTANCE_LAUNCHautoscaling:EC2_INSTANCE_LAUNCH_ERRORautoscaling:EC2_INSTANCE_TERMINATEautoscaling:EC2_INSTANCE_TERMINATE_ERRORautoscaling:TEST_NOTIFICATION
- topic
Arn List<String> - The Amazon Resource Name (ARN) of the Amazon SNS topic.
- notification
Types List<String> - A list of event types that send a notification. Event types can include any of the following types.
Allowed values:
autoscaling:EC2_INSTANCE_LAUNCHautoscaling:EC2_INSTANCE_LAUNCH_ERRORautoscaling:EC2_INSTANCE_TERMINATEautoscaling:EC2_INSTANCE_TERMINATE_ERRORautoscaling:TEST_NOTIFICATION
- topic
Arn string[] - The Amazon Resource Name (ARN) of the Amazon SNS topic.
- notification
Types string[] - A list of event types that send a notification. Event types can include any of the following types.
Allowed values:
autoscaling:EC2_INSTANCE_LAUNCHautoscaling:EC2_INSTANCE_LAUNCH_ERRORautoscaling:EC2_INSTANCE_TERMINATEautoscaling:EC2_INSTANCE_TERMINATE_ERRORautoscaling:TEST_NOTIFICATION
- topic_
arn Sequence[str] - The Amazon Resource Name (ARN) of the Amazon SNS topic.
- notification_
types Sequence[str] - A list of event types that send a notification. Event types can include any of the following types.
Allowed values:
autoscaling:EC2_INSTANCE_LAUNCHautoscaling:EC2_INSTANCE_LAUNCH_ERRORautoscaling:EC2_INSTANCE_TERMINATEautoscaling:EC2_INSTANCE_TERMINATE_ERRORautoscaling:TEST_NOTIFICATION
- topic
Arn List<String> - The Amazon Resource Name (ARN) of the Amazon SNS topic.
- notification
Types List<String> - A list of event types that send a notification. Event types can include any of the following types.
Allowed values:
autoscaling:EC2_INSTANCE_LAUNCHautoscaling:EC2_INSTANCE_LAUNCH_ERRORautoscaling:EC2_INSTANCE_TERMINATEautoscaling:EC2_INSTANCE_TERMINATE_ERRORautoscaling:TEST_NOTIFICATION
AutoScalingGroupTagProperty, AutoScalingGroupTagPropertyArgs
- Key string
- The tag key.
- Propagate
At boolLaunch - Set to
trueif you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set tofalseif you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. - Value string
- The tag value.
- Key string
- The tag key.
- Propagate
At boolLaunch - Set to
trueif you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set tofalseif you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. - Value string
- The tag value.
- key String
- The tag key.
- propagate
At BooleanLaunch - Set to
trueif you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set tofalseif you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. - value String
- The tag value.
- key string
- The tag key.
- propagate
At booleanLaunch - Set to
trueif you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set tofalseif you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. - value string
- The tag value.
- key str
- The tag key.
- propagate_
at_ boollaunch - Set to
trueif you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set tofalseif you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. - value str
- The tag value.
- key String
- The tag key.
- propagate
At BooleanLaunch - Set to
trueif you want CloudFormation to copy the tag to EC2 instances that are launched as part of the Auto Scaling group. Set tofalseif you want the tag attached only to the Auto Scaling group and not copied to any instances launched as part of the Auto Scaling group. - value String
- The tag value.
AutoScalingGroupTotalLocalStorageGbRequest, AutoScalingGroupTotalLocalStorageGbRequestArgs
AutoScalingGroupVCpuCountRequest, AutoScalingGroupVCpuCountRequestArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.105.0 published on Thursday, May 2, 2024 by Pulumi