AutoScalingGroup
autoscaling.services.k8s.aws/v1alpha1
| Type | Link |
|---|---|
| GoDoc | autoscaling-controller/apis/v1alpha1#AutoScalingGroup |
Metadata
| Property | Value |
|---|---|
| Scope | Namespaced |
| Kind | AutoScalingGroup |
| ListKind | AutoScalingGroupList |
| Plural | autoscalinggroups |
| Singular | autoscalinggroup |
Spec
availabilityZoneDistribution:
capacityDistributionStrategy: string
availabilityZoneImpairmentPolicy:
impairedZoneHealthCheckBehavior: string
zonalShiftEnabled: boolean
availabilityZones:
- string
capacityRebalance: boolean
capacityReservationSpecification:
capacityReservationPreference: string
capacityReservationTarget:
capacityReservationIDs:
- string
capacityReservationResourceGroupARNs:
- string
defaultCooldown: integer
defaultInstanceWarmup: integer
desiredCapacity: integer
desiredCapacityType: string
healthCheckGracePeriod: integer
healthCheckType: string
instanceID: string
instanceLifecyclePolicy:
retentionTriggers:
terminateHookAbandon: string
instanceMaintenancePolicy:
maxHealthyPercentage: integer
minHealthyPercentage: integer
instanceRef:
from:
name: string
namespace: string
launchConfigurationName: string
launchTemplate:
launchTemplateName: string
version: string
lifecycleHookSpecificationList:
- defaultResult: string
heartbeatTimeout: integer
lifecycleHookName: string
lifecycleTransition: string
notificationMetadata: string
notificationTargetARN: string
roleARN: string
roleRef:
from:
name: string
namespace: string
loadBalancerNames:
- string
maxInstanceLifetime: integer
maxSize: integer
minSize: integer
mixedInstancesPolicy:
instancesDistribution:
onDemandAllocationStrategy: string
onDemandBaseCapacity: integer
onDemandPercentageAboveBaseCapacity: integer
spotAllocationStrategy: string
spotInstancePools: integer
spotMaxPrice: string
launchTemplate:
launchTemplateSpecification:
launchTemplateName: string
version: string
overrides:
- imageID: string
instanceRequirements:
acceleratorCount:
max: integer
min: integer
acceleratorManufacturers:
- string
acceleratorNames:
- string
acceleratorTotalMemoryMiB:
max: integer
min: integer
acceleratorTypes:
- string
allowedInstanceTypes:
- string
bareMetal: string
baselineEBSBandwidthMbps:
max: integer
min: integer
baselinePerformanceFactors:
cpu:
references:
- instanceFamily: string
burstablePerformance: string
cpuManufacturers:
- string
excludedInstanceTypes:
- string
instanceGenerations:
- string
localStorage: string
localStorageTypes:
- string
maxSpotPriceAsPercentageOfOptimalOnDemandPrice: integer
memoryGiBPerVCPU:
max: number
min: number
memoryMiB:
max: integer
min: integer
networkBandwidthGbps:
max: number
min: number
networkInterfaceCount:
max: integer
min: integer
onDemandMaxPricePercentageOverLowestPrice: integer
requireHibernateSupport: boolean
spotMaxPricePercentageOverLowestPrice: integer
totalLocalStorageGB:
max: number
min: number
vCPUCount:
max: integer
min: integer
instanceType: string
launchTemplateSpecification:
launchTemplateName: string
version: string
weightedCapacity: string
name: string
newInstancesProtectedFromScaleIn: boolean
placementGroup: string
serviceLinkedRoleARN: string
serviceLinkedRoleRef:
from:
name: string
namespace: string
skipZonalShiftValidation: boolean
tags:
- key: string
value: string
targetGroupARNs:
- string
targetGroupRefs:
from:
name: string
namespace: string
terminationPolicies:
- string
trafficSources:
- identifier: string
type: string
vpcZoneIdentifier: string
| Field | Description |
|---|---|
| availabilityZoneDistribution Optional | object The instance capacity distribution across Availability Zones. |
| availabilityZoneDistribution.capacityDistributionStrategy Optional | string |
| availabilityZoneImpairmentPolicy Optional | object The policy for Availability Zone impairment. |
| availabilityZoneImpairmentPolicy.impairedZoneHealthCheckBehavior Optional | string |
| availabilityZoneImpairmentPolicy.zonalShiftEnabled Optional | boolean |
| availabilityZones Optional | array A list of Availability Zones where instances in the Auto Scaling group can be created. Used for launching into the default VPC subnet in each Availability Zone when not using the VPCZoneIdentifier property, or for attaching a network interface when an existing network interface ID is specified in a launch template. |
| availabilityZones.[] Required | string |
| capacityReservationSpecification Optional | object The capacity reservation specification for the Auto Scaling group. |
| capacityReservationSpecification.capacityReservationPreference Optional | string |
| capacityReservationSpecification.capacityReservationTarget Optional | object The target for the Capacity Reservation. Specify Capacity Reservations IDs or Capacity Reservation resource group ARNs. |
| capacityReservationSpecification.capacityReservationTarget.capacityReservationIDs Optional | array |
| capacityReservationSpecification.capacityReservationTarget.capacityReservationIDs.[] Required | string |
| capacityReservationSpecification.capacityReservationTarget.capacityReservationResourceGroupARNs.[] Required | string |
| defaultInstanceWarmup Optional | integer The amount of time, in seconds, until a new instance is considered to have finished initializing and resource consumption to become stable after it enters the InService state. During an instance refresh, Amazon EC2 Auto Scaling waits for the warm-up period after it replaces an instance before it moves on to replacing the next instance. Amazon EC2 Auto Scaling also waits for the warm-up period before aggregating the metrics for new instances with existing instances in the Amazon CloudWatch metrics that are used for scaling, resulting in more reliable usage data. For more information, see Set the default instance warmup for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-default-instance-warmup.html) in the Amazon EC2 Auto Scaling User Guide. To manage various warm-up settings at the group level, we recommend that you set the default instance warmup, even if it is set to 0 seconds. To remove a value that you previously set, include the property but specify -1 for the value. However, we strongly recommend keeping the default instance warmup enabled by specifying a value of 0 or other nominal value. Default: None |
| desiredCapacity Optional | integer The desired capacity is the initial capacity of the Auto Scaling group at the time of its creation and the capacity it attempts to maintain. It can scale beyond this capacity if you configure auto scaling. This number must be greater than or equal to the minimum size of the group and less than or equal to the maximum size of the group. If you do not specify a desired capacity, the default is the minimum size of the group. |
| desiredCapacityType Optional | string The unit of measurement for the value specified for desired capacity. Amazon EC2 Auto Scaling supports DesiredCapacityType for attribute-based instance type selection only. For more information, see Create a mixed instances group using attribute-based instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) 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 |
| healthCheckGracePeriod Optional | integer The amount of time, in seconds, that Amazon EC2 Auto Scaling waits before checking the health status of an EC2 instance that has come into service and marking it unhealthy due to a failed health check. This is useful if your instances do not immediately pass their health checks after they enter the InService state. For more information, see Set the health check grace period for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/health-check-grace-period.html) in the Amazon EC2 Auto Scaling User Guide. Default: 0 seconds |
| healthCheckType Optional | string A comma-separated value string of one or more health check types. 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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-health-checks.html) in the Amazon EC2 Auto Scaling User Guide. Only specify EC2 if you must clear a value that was previously set. Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| instanceID Optional | string The ID of the instance used to base the launch configuration on. If specified, Amazon EC2 Auto Scaling uses the configuration values from the specified instance to create a new launch configuration. To get the instance ID, use the Amazon EC2 DescribeInstances (https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html) API operation. For more information, see Create an Auto Scaling group using parameters from an existing instance (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-from-instance.html) in the Amazon EC2 Auto Scaling User Guide. Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| instanceLifecyclePolicy Optional | object The instance lifecycle policy for the Auto Scaling group. This policy controls instance behavior when an instance transitions through its lifecycle states. Configure retention triggers to specify when instances should move to a Retained state for manual intervention instead of automatic termination. Instances in a Retained state will continue to incur standard EC2 charges until terminated. |
| instanceLifecyclePolicy.retentionTriggers Optional | object Defines the specific triggers that cause instances to be retained in a Retained state rather than terminated. Each trigger corresponds to a different failure scenario during the instance lifecycle. This allows fine-grained control over when to preserve instances for manual intervention. |
| instanceLifecyclePolicy.retentionTriggers.terminateHookAbandon Optional | string |
| instanceMaintenancePolicy Optional | object An instance maintenance policy. For more information, see Set instance maintenance policy (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-maintenance-policy.html) in the Amazon EC2 Auto Scaling User Guide. |
| instanceMaintenancePolicy.maxHealthyPercentage Optional | integer |
| instanceMaintenancePolicy.minHealthyPercentage Optional | integer |
| instanceRef Optional | object AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference type to provide more user friendly syntax for references using ‘from’ field Ex: APIIDRef: from: name: my-api |
| instanceRef.from Optional | object AWSResourceReference provides all the values necessary to reference another k8s resource for finding the identifier(Id/ARN/Name) |
| instanceRef.from.name Optional | string |
| instanceRef.from.namespace Optional | string |
| launchConfigurationName Optional | string The name of the launch configuration to use to launch instances. Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId). Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| launchTemplate Optional | object Information used to specify the launch template and version to use to launch instances. Conditional: You must specify either a launch template (LaunchTemplate or MixedInstancesPolicy) or a launch configuration (LaunchConfigurationName or InstanceId). The launch template that is specified must be configured for use with an Auto Scaling group. For more information, see Create a launch template for an Auto Scaling group (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html) in the Amazon EC2 Auto Scaling User Guide. |
| launchTemplate.launchTemplateName Optional | string |
| launchTemplate.version Optional | string |
| lifecycleHookSpecificationList Optional | array One or more lifecycle hooks to add to the Auto Scaling group before instances are launched. |
| lifecycleHookSpecificationList.[] Required | object Describes information used to specify a lifecycle hook for an Auto Scaling |
| group. |
For more information, see Amazon EC2 Auto Scaling lifecycle hooks (https://docs.aws.amazon.com/autoscaling/ec2/userguide/lifecycle-hooks.html)
in the Amazon EC2 Auto Scaling User Guide. || lifecycleHookSpecificationList.[].defaultResult
Optional | string
|
| lifecycleHookSpecificationList.[].heartbeatTimeout
Optional | integer
|
| lifecycleHookSpecificationList.[].lifecycleHookName
Optional | string
|
| lifecycleHookSpecificationList.[].lifecycleTransition
Optional | string
|
| lifecycleHookSpecificationList.[].notificationMetadata
Optional | string
|
| lifecycleHookSpecificationList.[].notificationTargetARN
Optional | string
|
| lifecycleHookSpecificationList.[].roleARN
Optional | string
|
| lifecycleHookSpecificationList.[].roleRef
Optional | object
Reference field for RoleARN |
| lifecycleHookSpecificationList.[].roleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) |
| lifecycleHookSpecificationList.[].roleRef.from.name
Optional | string
|
| lifecycleHookSpecificationList.[].roleRef.from.namespace
Optional | string
|
| loadBalancerNames
Optional | array
A list of Classic Load Balancers associated with this Auto Scaling group.
For Application Load Balancers, Network Load Balancers, and Gateway Load
Balancers, specify the TargetGroupARNs property instead. |
| loadBalancerNames.[]
Required | string
|| maxInstanceLifetime
Optional | integer
The maximum amount of time, in seconds, that an instance can be in service.
The default is null. If specified, the value must be either 0 or a number
equal to or greater than 86,400 seconds (1 day). For more information, see
Replace Auto Scaling instances based on maximum instance lifetime (https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-max-instance-lifetime.html)
in the Amazon EC2 Auto Scaling User Guide. |
| maxSize
Required | integer
The maximum size of the group.
With a mixed instances policy that uses instance weighting, Amazon EC2 Auto
Scaling may need to go above MaxSize to meet your capacity requirements.
In this event, Amazon EC2 Auto Scaling will never go above MaxSize by more
than your largest instance weight (weights that define how many units each
instance contributes to the desired capacity of the group). |
| minSize
Required | integer
The minimum size of the group. |
| mixedInstancesPolicy
Optional | object
The mixed instances policy. For more information, see Auto Scaling groups
with multiple instance types and purchase options (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-mixed-instances-groups.html)
in the Amazon EC2 Auto Scaling User Guide. |
| mixedInstancesPolicy.instancesDistribution
Optional | object
Use this structure to specify the distribution of On-Demand Instances and
Spot Instances and the allocation strategies used to fulfill On-Demand and
Spot capacities for a mixed instances policy. |
| mixedInstancesPolicy.instancesDistribution.onDemandAllocationStrategy
Optional | string
|
| mixedInstancesPolicy.instancesDistribution.onDemandBaseCapacity
Optional | integer
|
| mixedInstancesPolicy.instancesDistribution.onDemandPercentageAboveBaseCapacity
Optional | integer
|
| mixedInstancesPolicy.instancesDistribution.spotAllocationStrategy
Optional | string
|
| mixedInstancesPolicy.instancesDistribution.spotInstancePools
Optional | integer
|
| mixedInstancesPolicy.instancesDistribution.spotMaxPrice
Optional | string
|
| mixedInstancesPolicy.launchTemplate
Optional | object
Use this structure to specify the launch templates and instance types (overrides)
for a mixed instances policy. |
| mixedInstancesPolicy.launchTemplate.launchTemplateSpecification
Optional | object
Describes the launch template and the version of the launch template that
Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information
about launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html)
in the Amazon EC2 Auto Scaling User Guide. |
| mixedInstancesPolicy.launchTemplate.launchTemplateSpecification.launchTemplateName
Optional | string
|
| mixedInstancesPolicy.launchTemplate.launchTemplateSpecification.version
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[]
Required | object
Use this structure to let Amazon EC2 Auto Scaling do the following when the
Auto Scaling group has a mixed instances policy:
Override the instance type that is specified in the launch template.
Use multiple instance types.
Specify the instance types that you want, or define your instance requirements instead and let Amazon EC2 Auto Scaling provision the available instance types that meet your requirements. This can provide Amazon EC2 Auto Scaling with a larger selection of instance types to choose from when fulfilling Spot and On-Demand capacities. You can view which instance types are matched before you apply the instance requirements to your Auto Scaling group.
After you define your instance requirements, you don’t have to keep updating
these settings to get new EC2 instance types automatically. Amazon EC2 Auto
Scaling uses the instance requirements of the Auto Scaling group to determine
whether a new EC2 instance type can be used. || mixedInstancesPolicy.launchTemplate.overrides.[].imageID
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements
Optional | object
The attributes for the instance types for a mixed instances policy. 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.
When you specify multiple attributes, you get instance types that satisfy
all of the specified attributes. If you specify multiple values for an attribute,
you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 Auto Scaling can
identify matching instance types, you can use one of the following parameters,
but not both in the same request:
* AllowedInstanceTypes - The instance types to include in the list. All
other instance types are ignored, even if they match your specified attributes.
* ExcludedInstanceTypes - The instance types to exclude from the list,
even if they match your specified attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional.
Any unspecified optional attribute is set to its default.
For more information, see Create a mixed instances group using attribute-based
instance type selection (https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html)
in the Amazon EC2 Auto Scaling User Guide. For help determining which instance
types match your attributes before you apply them to your Auto Scaling group,
see Preview instance types with specified attributes (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements)
in the Amazon EC2 User Guide. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorCount
Optional | object
Specifies the minimum and maximum for the AcceleratorCount object when you
specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorCount.max
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorCount.min
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorManufacturers
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorManufacturers.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorNames
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorNames.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorTotalMemoryMiB
Optional | object
Specifies the minimum and maximum for the AcceleratorTotalMemoryMiB object
when you specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorTotalMemoryMiB.max
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorTotalMemoryMiB.min
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorTypes
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.acceleratorTypes.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.allowedInstanceTypes
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.allowedInstanceTypes.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.bareMetal
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselineEBSBandwidthMbps
Optional | object
Specifies the minimum and maximum for the BaselineEbsBandwidthMbps object
when you specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselineEBSBandwidthMbps.max
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselineEBSBandwidthMbps.min
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselinePerformanceFactors
Optional | object
The baseline performance to consider, using an instance family as a baseline
reference. The instance family establishes the lowest acceptable level of
performance. Auto Scaling uses this baseline to guide instance type selection,
but there is no guarantee that the selected instance types will always exceed
the baseline for every application.
Currently, this parameter only supports CPU performance as a baseline performance
factor. For example, specifying c6i uses the CPU performance of the c6i family
as the baseline reference. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselinePerformanceFactors.cpu
Optional | object
The CPU performance to consider, using an instance family as the baseline
reference. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselinePerformanceFactors.cpu.references
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselinePerformanceFactors.cpu.references.[]
Required | object
Specify an instance family to use as the baseline reference for CPU performance.
All instance types that All instance types that match your specified attributes
will be compared against the CPU performance of the referenced instance family,
regardless of CPU manufacturer or architecture differences.
Currently only one instance family can be specified in the list. || mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.baselinePerformanceFactors.cpu.references.[].instanceFamily
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.burstablePerformance
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.cpuManufacturers
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.cpuManufacturers.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.excludedInstanceTypes
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.excludedInstanceTypes.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.instanceGenerations
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.instanceGenerations.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.localStorage
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.localStorageTypes
Optional | array
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.localStorageTypes.[]
Required | string
|| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.maxSpotPriceAsPercentageOfOptimalOnDemandPrice
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.memoryGiBPerVCPU
Optional | object
Specifies the minimum and maximum for the MemoryGiBPerVCpu object when you
specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.memoryGiBPerVCPU.max
Optional | number
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.memoryGiBPerVCPU.min
Optional | number
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.memoryMiB
Optional | object
Specifies the minimum and maximum for the MemoryMiB object when you specify
InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.memoryMiB.max
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.memoryMiB.min
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.networkBandwidthGbps
Optional | object
Specifies the minimum and maximum for the NetworkBandwidthGbps object when
you specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group.
Setting the minimum bandwidth does not guarantee that your instance will
achieve the minimum bandwidth. Amazon EC2 will identify instance types that
support the specified minimum bandwidth, but the actual bandwidth of your
instance might go below the specified minimum at times. For more information,
see Available instance bandwidth (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth)
in the Amazon EC2 User Guide. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.networkBandwidthGbps.max
Optional | number
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.networkBandwidthGbps.min
Optional | number
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.networkInterfaceCount
Optional | object
Specifies the minimum and maximum for the NetworkInterfaceCount object when
you specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.networkInterfaceCount.max
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.networkInterfaceCount.min
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.onDemandMaxPricePercentageOverLowestPrice
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.requireHibernateSupport
Optional | boolean
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.spotMaxPricePercentageOverLowestPrice
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.totalLocalStorageGB
Optional | object
Specifies the minimum and maximum for the TotalLocalStorageGB object when
you specify InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.totalLocalStorageGB.max
Optional | number
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.totalLocalStorageGB.min
Optional | number
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.vCPUCount
Optional | object
Specifies the minimum and maximum for the VCpuCount object when you specify
InstanceRequirements (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstanceRequirements.html)
for an Auto Scaling group. |
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.vCPUCount.max
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceRequirements.vCPUCount.min
Optional | integer
|
| mixedInstancesPolicy.launchTemplate.overrides.[].instanceType
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].launchTemplateSpecification
Optional | object
Describes the launch template and the version of the launch template that
Amazon EC2 Auto Scaling uses to launch Amazon EC2 instances. For more information
about launch templates, see Launch templates (https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html)
in the Amazon EC2 Auto Scaling User Guide. |
| mixedInstancesPolicy.launchTemplate.overrides.[].launchTemplateSpecification.launchTemplateName
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].launchTemplateSpecification.version
Optional | string
|
| mixedInstancesPolicy.launchTemplate.overrides.[].weightedCapacity
Optional | string
|
| name
Required | string
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.
Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| newInstancesProtectedFromScaleIn
Optional | boolean
Indicates whether newly launched instances are protected from termination
by Amazon EC2 Auto Scaling when scaling in. For more information about preventing
instances from terminating on scale in, see Use instance scale-in protection
(https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-instance-protection.html)
in the Amazon EC2 Auto Scaling User Guide. |
| placementGroup
Optional | string
The name of the placement group into which to launch your instances. For
more information, see Placement groups (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html)
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.
Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| serviceLinkedRoleARN
Optional | string
The Amazon Resource Name (ARN) of the service-linked role that the Auto Scaling
group uses to call other Amazon Web Services service on your behalf. By default,
Amazon EC2 Auto Scaling uses a service-linked role named AWSServiceRoleForAutoScaling,
which it creates if it does not exist. For more information, see Service-linked
roles (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-service-linked-role.html)
in the Amazon EC2 Auto Scaling User Guide.
Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| serviceLinkedRoleRef
Optional | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:
from:
name: my-api |
| serviceLinkedRoleRef.from
Optional | object
AWSResourceReference provides all the values necessary to reference another
k8s resource for finding the identifier(Id/ARN/Name) |
| serviceLinkedRoleRef.from.name
Optional | string
|
| serviceLinkedRoleRef.from.namespace
Optional | string
|
| skipZonalShiftValidation
Optional | boolean
If you enable zonal shift with cross-zone disabled load balancers, capacity
could become imbalanced across Availability Zones. To skip the validation,
specify true. For more information, see Auto Scaling group zonal shift (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-zonal-shift.html)
in the Amazon EC2 Auto Scaling User Guide. |
| tags
Optional | array
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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-tagging.html)
in the Amazon EC2 Auto Scaling User Guide. |
| tags.[]
Required | object
Describes a tag for an Auto Scaling group. || tags.[].key
Optional | string
|
| tags.[].value
Optional | string
|
| targetGroupARNs
Optional | array
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 (https://docs.aws.amazon.com/autoscaling/ec2/userguide/autoscaling-load-balancer.html)
in the Amazon EC2 Auto Scaling User Guide. |
| targetGroupARNs.[]
Required | string
|| targetGroupRefs
Optional | array
|
| targetGroupRefs.[]
Required | object
AWSResourceReferenceWrapper provides a wrapper around *AWSResourceReference
type to provide more user friendly syntax for references using ‘from’ field
Ex:
APIIDRef:
from:
name: my-api || **targetGroupRefs.[].from**<br/>Optional | **object**<br/>AWSResourceReference provides all the values necessary to reference another<br/>k8s resource for finding the identifier(Id/ARN/Name) |
| targetGroupRefs.[].from.name
Optional | string
|
| targetGroupRefs.[].from.namespace
Optional | string
|
| terminationPolicies
Optional | array
A policy or a list of policies that are used to select the instance to terminate.
These policies are executed in the order that you list them. For more information,
see Configure termination policies for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-termination-policies.html)
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 |
| terminationPolicies.[]
Required | string
|| trafficSources
Optional | array
The list of traffic sources to attach to this Auto Scaling group. You can
use any of the following as traffic sources for an Auto Scaling group: Classic
Load Balancer, Application Load Balancer, Gateway Load Balancer, Network
Load Balancer, and VPC Lattice. |
| trafficSources.[]
Required | object
Identifying information for a traffic source. || trafficSources.[].identifier
Optional | string
|
| trafficSources.[].type
Optional | string
|
| vpcZoneIdentifier
Optional | string
A comma-separated list of subnet IDs for a virtual private cloud (VPC) where
instances in the Auto Scaling group can be created. If you specify VPCZoneIdentifier
with AvailabilityZones, the subnets that you specify must reside in those
Availability Zones.
Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
Status
ackResourceMetadata:
arn: string
ownerAccountID: string
partition: string
region: string
conditions:
- lastTransitionTime: string
message: string
reason: string
status: string
type: string
createdTime: string
enabledMetrics:
- granularity: string
metric: string
predictedCapacity: integer
status: string
suspendedProcesses:
- processName: string
suspensionReason: string
warmPoolConfiguration:
instanceReusePolicy:
reuseOnScaleIn: boolean
maxGroupPreparedCapacity: integer
minSize: integer
poolState: string
status: string
warmPoolSize: integer
| Field | Description |
|---|---|
| ackResourceMetadata Optional | object All CRs managed by ACK have a common Status.ACKResourceMetadata memberthat is used to contain resource sync state, account ownership, constructed ARN for the resource |
| ackResourceMetadata.arn Optional | string ARN is the Amazon Resource Name for the resource. This is a globally-unique identifier and is set only by the ACK service controller once the controller has orchestrated the creation of the resource OR when it has verified that an “adopted” resource (a resource where the ARN annotation was set by the Kubernetes user on the CR) exists and matches the supplied CR’s Spec field values. https://github.com/aws/aws-controllers-k8s/issues/270 |
| ackResourceMetadata.ownerAccountID Required | string OwnerAccountID is the AWS Account ID of the account that owns the backend AWS service API resource. |
| ackResourceMetadata.partition Optional | string Partition is the AWS partition in which the resource exists or will exist |
| ackResourceMetadata.region Required | string Region is the AWS region in which the resource exists or will exist. |
| conditions Optional | array All CRs managed by ACK have a common Status.Conditions member thatcontains a collection of ackv1alpha1.Condition objects that describethe various terminal states of the CR and its backend AWS service API resource |
| conditions.[] Required | object Condition is the common struct used by all CRDs managed by ACK service |
| controllers to indicate terminal states of the CR and its backend AWS | |
| service API resource | |
| conditions.[].message Optional | string A human readable message indicating details about the transition. |
| conditions.[].reason Optional | string The reason for the condition’s last transition. |
| conditions.[].status Optional | string Status of the condition, one of True, False, Unknown. |
| conditions.[].type Optional | string Type is the type of the Condition |
| createdTime Optional | string The date and time the group was created. |
| enabledMetrics Optional | array The metrics enabled for the group. |
| enabledMetrics.[] Required | object Describes an enabled Auto Scaling group metric. |
| enabledMetrics.[].metric Optional | string |
| predictedCapacity Optional | integer The predicted capacity of the group when it has a predictive scaling policy. |
| status Optional | string The current state of the group when the DeleteAutoScalingGroup (https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_DeleteAutoScalingGroup.html) operation is in progress. Regex Pattern: ^[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*$ |
| suspendedProcesses Optional | array The suspended processes associated with the group. |
| suspendedProcesses.[] Required | object Describes an auto scaling process that has been suspended. |
For more information, see Types of processes (https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html#process-types)
in the Amazon EC2 Auto Scaling User Guide. || suspendedProcesses.[].processName
Optional | string
|
| suspendedProcesses.[].suspensionReason
Optional | string
|
| warmPoolConfiguration
Optional | object
The warm pool for the group. |
| warmPoolConfiguration.instanceReusePolicy
Optional | object
Describes an instance reuse policy for a warm pool.
For more information, see Warm pools for Amazon EC2 Auto Scaling (https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-warm-pools.html)
in the Amazon EC2 Auto Scaling User Guide. |
| warmPoolConfiguration.instanceReusePolicy.reuseOnScaleIn
Optional | boolean
|
| warmPoolConfiguration.maxGroupPreparedCapacity
Optional | integer
|
| warmPoolConfiguration.minSize
Optional | integer
|
| warmPoolConfiguration.poolState
Optional | string
|
| warmPoolConfiguration.status
Optional | string
|
| warmPoolSize
Optional | integer
The current size of the warm pool. |