Interface CfnAutoScalingGroup.InstanceRequirementsProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnAutoScalingGroup.InstanceRequirementsProperty.Jsii$Proxy
- Enclosing class:
CfnAutoScalingGroup
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
VCpuCountandMemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
For an example template, see Configure Amazon EC2 Auto Scaling resources .
For more information, see Creating an Auto Scaling group using attribute-based instance type selection 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 in the Amazon EC2 User Guide for Linux Instances .
InstanceRequirements is a property of the LaunchTemplateOverrides property of the AWS::AutoScaling::AutoScalingGroup LaunchTemplate property type.
Example:
Vpc vpc;
LaunchTemplate launchTemplate1;
AutoScalingGroup.Builder.create(this, "ASG")
.vpc(vpc)
.mixedInstancesPolicy(MixedInstancesPolicy.builder()
.launchTemplate(launchTemplate1)
.launchTemplateOverrides(List.of(LaunchTemplateOverrides.builder()
.instanceRequirements(InstanceRequirementsProperty.builder()
.vCpuCount(VCpuCountRequestProperty.builder().min(4).max(8).build())
.memoryMiB(MemoryMiBRequestProperty.builder().min(16384).build())
.cpuManufacturers(List.of("intel"))
.build())
.build()))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnAutoScalingGroup.InstanceRequirementsPropertystatic final classAn implementation forCfnAutoScalingGroup.InstanceRequirementsProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default ObjectThe minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.Indicates whether instance types must have accelerators by specific manufacturers.Lists the accelerators that must be on an instance type.default ObjectThe minimum and maximum total memory size for the accelerators on an instance type, in MiB.Lists the accelerator types that must be on an instance type.The instance types to apply your specified attributes against.default StringIndicates whether bare metal instance types are included, excluded, or required.default ObjectThe minimum and maximum baseline bandwidth performance for an instance type, in Mbps.default StringIndicates whether burstable performance instance types are included, excluded, or required.Lists which specific CPU manufacturers to include.The instance types to exclude.Indicates whether current or previous generation instance types are included.default StringIndicates whether instance types with instance store volumes are included, excluded, or required.Indicates the type of local storage that is required.default Number[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.default ObjectThe minimum and maximum amount of memory per vCPU for an instance type, in GiB.The minimum and maximum instance memory size for an instance type, in MiB.default ObjectThe minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).default ObjectThe minimum and maximum number of network interfaces for an instance type.default Number[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.default ObjectIndicates whether instance types must provide On-Demand Instance hibernation support.default Number[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.default ObjectThe minimum and maximum total local storage size for an instance type, in GB.The minimum and maximum number of vCPUs for an instance type.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getMemoryMiB
The minimum and maximum instance memory size for an instance type, in MiB.- See Also:
-
getVCpuCount
The minimum and maximum number of vCPUs for an instance type.- See Also:
-
getAcceleratorCount
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
- See Also:
-
getAcceleratorManufacturers
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
- See Also:
- For instance types with NVIDIA devices, specify
-
getAcceleratorNames
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
- See Also:
- For instance types with NVIDIA A100 GPUs, specify
-
getAcceleratorTotalMemoryMiB
The minimum and maximum total memory size for the accelerators on an instance type, in MiB.Default: No minimum or maximum limits
- See Also:
-
getAcceleratorTypes
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
- See Also:
- For instance types with GPU accelerators, specify
-
getAllowedInstanceTypes
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 specify
c5*, 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 specify
AllowedInstanceTypes, you can't specifyExcludedInstanceTypes.Default: All instance types
- See Also:
-
getBareMetal
Indicates whether bare metal instance types are included, excluded, or required.Default:
excluded- See Also:
-
getBaselineEbsBandwidthMbps
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
- See Also:
-
getBurstablePerformance
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- See Also:
-
getCpuManufacturers
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
- See Also:
- For instance types with Intel CPUs, specify
-
getExcludedInstanceTypes
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 specify
c5*, 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 specify
ExcludedInstanceTypes, you can't specifyAllowedInstanceTypes.Default: No excluded instance types
- See Also:
-
getInstanceGenerations
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
- See Also:
- For current generation instance types, specify
-
getLocalStorage
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- See Also:
-
getLocalStorageTypes
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
- See Also:
- For instance types with hard disk drive (HDD) storage, specify
-
getMaxSpotPriceAsPercentageOfOptimalOnDemandPrice
[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.
If you set
DesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.Only one of
SpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as999999.- See Also:
-
getMemoryGiBPerVCpu
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.Default: No minimum or maximum limits
- See Also:
-
getNetworkBandwidthGbps
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).Default: No minimum or maximum limits
- See Also:
-
getNetworkInterfaceCount
The minimum and maximum number of network interfaces for an instance type.Default: No minimum or maximum limits
- See Also:
-
getOnDemandMaxPricePercentageOverLowestPrice
[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 set
DesiredCapacityTypetovcpuormemory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per instance price.Default:
20- See Also:
-
getRequireHibernateSupport
Indicates whether instance types must provide On-Demand Instance hibernation support.Default:
false- See Also:
-
getSpotMaxPricePercentageOverLowestPrice
[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.
If you set
DesiredCapacityTypetovcpuormemory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.Only one of
SpotMaxPricePercentageOverLowestPriceorMaxSpotPriceAsPercentageOfOptimalOnDemandPricecan be specified. If you don't specify either, Amazon EC2 Auto Scaling will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as999999.- See Also:
-
getTotalLocalStorageGb
The minimum and maximum total local storage size for an instance type, in GB.Default: No minimum or maximum limits
- See Also:
-
builder
-