CfnAutoScalingGroupProps Struct
Properties for defining a CfnAutoScalingGroup.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const cfnAutoScalingGroupProps: autoscaling.CfnAutoScalingGroupProps = {
maxSize: 'maxSize',
minSize: 'minSize',
// the properties below are optional
autoScalingGroupName: 'autoScalingGroupName',
availabilityZoneDistribution: {
capacityDistributionStrategy: 'capacityDistributionStrategy',
},
availabilityZoneIds: ['availabilityZoneIds'],
availabilityZoneImpairmentPolicy: {
impairedZoneHealthCheckBehavior: 'impairedZoneHealthCheckBehavior',
zonalShiftEnabled: false,
},
availabilityZones: ['availabilityZones'],
capacityRebalance: false,
capacityReservationSpecification: {
capacityReservationPreference: 'capacityReservationPreference',
// the properties below are optional
capacityReservationTarget: {
capacityReservationIds: ['capacityReservationIds'],
capacityReservationResourceGroupArns: ['capacityReservationResourceGroupArns'],
},
},
context: 'context',
cooldown: 'cooldown',
defaultInstanceWarmup: 123,
deletionProtection: 'deletionProtection',
desiredCapacity: 'desiredCapacity',
desiredCapacityType: 'desiredCapacityType',
healthCheckGracePeriod: 123,
healthCheckType: 'healthCheckType',
instanceId: 'instanceId',
instanceLifecyclePolicy: {
retentionTriggers: {
terminateHookAbandon: 'terminateHookAbandon',
},
},
instanceMaintenancePolicy: {
maxHealthyPercentage: 123,
minHealthyPercentage: 123,
},
launchConfigurationName: 'launchConfigurationName',
launchTemplate: {
version: 'version',
// the properties below are optional
launchTemplateId: 'launchTemplateId',
launchTemplateName: 'launchTemplateName',
},
lifecycleHookSpecificationList: [{
lifecycleHookName: 'lifecycleHookName',
lifecycleTransition: 'lifecycleTransition',
// the properties below are optional
defaultResult: 'defaultResult',
heartbeatTimeout: 123,
notificationMetadata: 'notificationMetadata',
notificationTargetArn: 'notificationTargetArn',
roleArn: 'roleArn',
}],
loadBalancerNames: ['loadBalancerNames'],
maxInstanceLifetime: 123,
metricsCollection: [{
granularity: 'granularity',
// the properties below are optional
metrics: ['metrics'],
}],
mixedInstancesPolicy: {
launchTemplate: {
launchTemplateSpecification: {
version: 'version',
// the properties below are optional
launchTemplateId: 'launchTemplateId',
launchTemplateName: 'launchTemplateName',
},
// the properties below are optional
overrides: [{
imageId: 'imageId',
instanceRequirements: {
memoryMiB: {
max: 123,
min: 123,
},
vCpuCount: {
max: 123,
min: 123,
},
// the properties below are optional
acceleratorCount: {
max: 123,
min: 123,
},
acceleratorManufacturers: ['acceleratorManufacturers'],
acceleratorNames: ['acceleratorNames'],
acceleratorTotalMemoryMiB: {
max: 123,
min: 123,
},
acceleratorTypes: ['acceleratorTypes'],
allowedInstanceTypes: ['allowedInstanceTypes'],
bareMetal: 'bareMetal',
baselineEbsBandwidthMbps: {
max: 123,
min: 123,
},
baselinePerformanceFactors: {
cpu: {
references: [{
instanceFamily: 'instanceFamily',
}],
},
},
burstablePerformance: 'burstablePerformance',
cpuManufacturers: ['cpuManufacturers'],
excludedInstanceTypes: ['excludedInstanceTypes'],
instanceGenerations: ['instanceGenerations'],
localStorage: 'localStorage',
localStorageTypes: ['localStorageTypes'],
maxSpotPriceAsPercentageOfOptimalOnDemandPrice: 123,
memoryGiBPerVCpu: {
max: 123,
min: 123,
},
networkBandwidthGbps: {
max: 123,
min: 123,
},
networkInterfaceCount: {
max: 123,
min: 123,
},
onDemandMaxPricePercentageOverLowestPrice: 123,
requireHibernateSupport: false,
spotMaxPricePercentageOverLowestPrice: 123,
totalLocalStorageGb: {
max: 123,
min: 123,
},
},
instanceType: 'instanceType',
launchTemplateSpecification: {
version: 'version',
// the properties below are optional
launchTemplateId: 'launchTemplateId',
launchTemplateName: 'launchTemplateName',
},
weightedCapacity: 'weightedCapacity',
}],
},
// the properties below are optional
instancesDistribution: {
distributionSegments: [{
targetCapacityTypes: ['targetCapacityTypes'],
}],
onDemandAllocationStrategy: 'onDemandAllocationStrategy',
onDemandBaseCapacity: 123,
onDemandPercentageAboveBaseCapacity: 123,
spotAllocationStrategy: 'spotAllocationStrategy',
spotInstancePools: 123,
spotMaxPrice: 'spotMaxPrice',
},
},
newInstancesProtectedFromScaleIn: false,
notificationConfiguration: {
topicArn: 'topicArn',
// the properties below are optional
notificationTypes: ['notificationTypes'],
},
notificationConfigurations: [{
topicArn: 'topicArn',
// the properties below are optional
notificationTypes: ['notificationTypes'],
}],
placementGroup: 'placementGroup',
serviceLinkedRoleArn: 'serviceLinkedRoleArn',
skipZonalShiftValidation: false,
tags: [{
key: 'key',
propagateAtLaunch: false,
value: 'value',
}],
targetGroupArns: ['targetGroupArns'],
terminationPolicies: ['terminationPolicies'],
trafficSources: [{
identifier: 'identifier',
type: 'type',
}],
vpcZoneIdentifier: ['vpcZoneIdentifier'],
};
Properties
autoScalingGroupNamestringauto_scaling_group_namestrautoScalingGroupNameStringAutoScalingGroupNamestringAutoScalingGroupName*string#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.
availabilityZoneDistributionIResolvable | CfnAutoScalingGroup.AvailabilityZoneDistributionPropertyavailability_zone_distributiontyping.Union[IResolvable, AvailabilityZoneDistributionProperty]availabilityZoneDistributionIResolvableAvailabilityZoneDistributionIResolvableAvailabilityZoneDistributioninterface{}#availabilityZoneIdsstring[]availability_zone_idstyping.List[str]availabilityZoneIdsList<String>AvailabilityZoneIdsstring[]AvailabilityZoneIds*[]*string#availabilityZoneImpairmentPolicyIResolvable | CfnAutoScalingGroup.AvailabilityZoneImpairmentPolicyPropertyavailability_zone_impairment_policytyping.Union[IResolvable, AvailabilityZoneImpairmentPolicyProperty]availabilityZoneImpairmentPolicyIResolvableAvailabilityZoneImpairmentPolicyIResolvableAvailabilityZoneImpairmentPolicyinterface{}#availabilityZonesstring[]availability_zonestyping.List[str]availabilityZonesList<String>AvailabilityZonesstring[]AvailabilityZones*[]*string#Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template.
capacityRebalanceboolean | IResolvablecapacity_rebalancetyping.Union[bool, IResolvable]capacityRebalanceBooleanCapacityRebalanceboolCapacityRebalanceinterface{}#notes
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 .
capacityReservationSpecificationIResolvable | CfnAutoScalingGroup.CapacityReservationSpecificationPropertycapacity_reservation_specificationtyping.Union[IResolvable, CapacityReservationSpecificationProperty]capacityReservationSpecificationIResolvableCapacityReservationSpecificationIResolvableCapacityReservationSpecificationinterface{}#notes
The amount of time, in seconds, between one scaling activity ending and another one starting due to simple scaling policies. For more information, see Scaling cooldowns for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
Default: 300 seconds
defaultInstanceWarmupnumberdefault_instance_warmupint | floatdefaultInstanceWarmupNumberDefaultInstanceWarmupdoubleDefaultInstanceWarmup*float64#notes
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
deletionProtectionstringdeletion_protectionstrdeletionProtectionStringDeletionProtectionstringDeletionProtection*string#desiredCapacitystringdesired_capacitystrdesiredCapacityStringDesiredCapacitystringDesiredCapacity*string#notes
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.
desiredCapacityTypestringdesired_capacity_typestrdesiredCapacityTypeStringDesiredCapacityTypestringDesiredCapacityType*string#notes
Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection in the Amazon EC2 Auto Scaling User Guide .
By default, Amazon EC2 Auto Scaling specifies units , which translates into number of instances.
Valid values: units | vcpu | memory-mib
healthCheckGracePeriodnumberhealth_check_grace_periodint | floathealthCheckGracePeriodNumberHealthCheckGracePerioddoubleHealthCheckGracePeriod*float64#notes
This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
Default: 0 seconds
healthCheckTypestringhealth_check_typestrhealthCheckTypeStringHealthCheckTypestringHealthCheckType*string#notes
The valid values are EC2 , EBS , ELB , and VPC_LATTICE . EC2 is the default health check and cannot be disabled. For more information, see Health checks for instances in an Auto Scaling group in the Amazon EC2 Auto Scaling User Guide .
Only specify EC2 if you must clear a value that was previously set.
notes
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 , or LaunchConfigurationName , don't specify InstanceId .
instanceLifecyclePolicyIResolvable | CfnAutoScalingGroup.InstanceLifecyclePolicyPropertyinstance_lifecycle_policytyping.Union[IResolvable, InstanceLifecyclePolicyProperty]instanceLifecyclePolicyIResolvableInstanceLifecyclePolicyIResolvableInstanceLifecyclePolicyinterface{}#instanceMaintenancePolicyIResolvable | CfnAutoScalingGroup.InstanceMaintenancePolicyPropertyinstance_maintenance_policytyping.Union[IResolvable, InstanceMaintenancePolicyProperty]instanceMaintenancePolicyIResolvableInstanceMaintenancePolicyIResolvableInstanceMaintenancePolicyinterface{}#For more information, see Set instance maintenance policy in the Amazon EC2 Auto Scaling User Guide .
launchConfigurationNamestring | ILaunchConfigurationReflaunch_configuration_nametyping.Union[str, ILaunchConfigurationRef]launchConfigurationNameStringLaunchConfigurationNamestringLaunchConfigurationNameinterface{}#Required only if you don't specify LaunchTemplate , MixedInstancesPolicy , or InstanceId .
launchTemplateIResolvable | CfnAutoScalingGroup.LaunchTemplateSpecificationPropertylaunch_templatetyping.Union[IResolvable, LaunchTemplateSpecificationProperty]launchTemplateIResolvableLaunchTemplateIResolvableLaunchTemplateinterface{}#notes
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 specify MixedInstancesPolicy , LaunchConfigurationName , or InstanceId .
lifecycleHookSpecificationListIResolvable | IResolvable | CfnAutoScalingGroup.LifecycleHookSpecificationProperty[]lifecycle_hook_specification_listtyping.Union[IResolvable, typing.List[typing.Union[IResolvable, LifecycleHookSpecificationProperty]]]lifecycleHookSpecificationListIResolvableLifecycleHookSpecificationListIResolvableLifecycleHookSpecificationListinterface{}#loadBalancerNamesstring[]load_balancer_namestyping.List[str]loadBalancerNamesList<String>LoadBalancerNamesstring[]LoadBalancerNames*[]*string#For Application Load Balancers, Network Load Balancers, and Gateway Load Balancers, specify the TargetGroupARNs property instead.
maxInstanceLifetimenumbermax_instance_lifetimeint | floatmaxInstanceLifetimeNumberMaxInstanceLifetimedoubleMaxInstanceLifetime*float64#notes
The default is null. If specified, the value must be either 0 or a number equal to or greater than 86,400 seconds (1 day). For more information, see Replace Auto Scaling instances based on maximum instance lifetime in the Amazon EC2 Auto Scaling User Guide .
notes
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).
metricsCollectionIResolvable | IResolvable | CfnAutoScalingGroup.MetricsCollectionProperty[]metrics_collectiontyping.Union[IResolvable, typing.List[typing.Union[IResolvable, MetricsCollectionProperty]]]metricsCollectionIResolvableMetricsCollectionIResolvableMetricsCollectioninterface{}#By default, these metrics are disabled.
mixedInstancesPolicyIResolvable | CfnAutoScalingGroup.MixedInstancesPolicyPropertymixed_instances_policytyping.Union[IResolvable, MixedInstancesPolicyProperty]mixedInstancesPolicyIResolvableMixedInstancesPolicyIResolvableMixedInstancesPolicyinterface{}#notes
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 .
newInstancesProtectedFromScaleInboolean | IResolvablenew_instances_protected_from_scale_intyping.Union[bool, IResolvable]newInstancesProtectedFromScaleInBooleanNewInstancesProtectedFromScaleInboolNewInstancesProtectedFromScaleIninterface{}#notes
For more information about preventing instances from terminating on scale in, see Use instance scale-in protection in the Amazon EC2 Auto Scaling User Guide .
notificationConfigurationIResolvable | CfnAutoScalingGroup.NotificationConfigurationPropertynotification_configurationtyping.Union[IResolvable, NotificationConfigurationProperty]notificationConfigurationIResolvableNotificationConfigurationIResolvableNotificationConfigurationinterface{}deprecated#notificationConfigurationsIResolvable | IResolvable | CfnAutoScalingGroup.NotificationConfigurationProperty[]notification_configurationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, NotificationConfigurationProperty]]]notificationConfigurationsIResolvableNotificationConfigurationsIResolvableNotificationConfigurationsinterface{}#placementGroupstringplacement_groupstrplacementGroupStringPlacementGroupstringPlacementGroup*string#notes
For more information, see Placement groups in the Amazon EC2 User Guide .
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.
serviceLinkedRoleArnstring | IRoleRefservice_linked_role_arntyping.Union[str, IRoleRef]serviceLinkedRoleArnStringServiceLinkedRoleArnstringServiceLinkedRoleArninterface{}#notes
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 .
skipZonalShiftValidationboolean | IResolvableskip_zonal_shift_validationtyping.Union[bool, IResolvable]skipZonalShiftValidationBooleanSkipZonalShiftValidationboolSkipZonalShiftValidationinterface{}#tagsCfnAutoScalingGroup.TagPropertyProperty[]tagstyping.List[TagPropertyProperty]tagsList<TagPropertyProperty>TagsTagPropertyProperty[]Tags*[]TagPropertyProperty#notes
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 .
targetGroupArnsstring | ITargetGroupRef[]target_group_arnstyping.List[typing.Union[str, ITargetGroupRef]]targetGroupArnsList<String>TargetGroupArnsstring[]TargetGroupArns*[]interface{}#notes
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 .
terminationPoliciesstring[]termination_policiestyping.List[str]terminationPoliciesList<String>TerminationPoliciesstring[]TerminationPolicies*[]*string#notes
These policies are executed in the order that you list them. For more information, see Configure termination policies for Amazon EC2 Auto Scaling in the Amazon EC2 Auto Scaling User Guide .
Valid values: Default | AllocationStrategy | ClosestToNextInstanceHour | NewestInstance | OldestInstance | OldestLaunchConfiguration | OldestLaunchTemplate | arn:aws:lambda:region:account-id:function:my-function:my-alias
trafficSourcesIResolvable | IResolvable | CfnAutoScalingGroup.TrafficSourceIdentifierProperty[]traffic_sourcestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TrafficSourceIdentifierProperty]]]trafficSourcesIResolvableTrafficSourcesIResolvableTrafficSourcesinterface{}#vpcZoneIdentifierstring | ISubnetRef[]vpc_zone_identifiertyping.List[typing.Union[str, ISubnetRef]]vpcZoneIdentifierList<String>VpcZoneIdentifierstring[]VpcZoneIdentifier*[]interface{}#notes
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 specify VPCZoneIdentifier with AvailabilityZones , the subnets that you specify for this property must reside in those Availability Zones.