software.amazon.awscdk.services.autoscaling

Interface CfnAutoScalingGroup.InstanceRequirementsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAutoScalingGroup.InstanceRequirementsProperty.Jsii$Proxy

Enclosing class:

CfnAutoScalingGroup

@Stability(value=Stable)
public static interface CfnAutoScalingGroup.InstanceRequirementsProperty
extends software.amazon.jsii.JsiiSerializable

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 an example template, see Auto scaling template snippets .

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:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.autoscaling.*;
 InstanceRequirementsProperty instanceRequirementsProperty = InstanceRequirementsProperty.builder()
         .acceleratorCount(AcceleratorCountRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .acceleratorManufacturers(List.of("acceleratorManufacturers"))
         .acceleratorNames(List.of("acceleratorNames"))
         .acceleratorTotalMemoryMiB(AcceleratorTotalMemoryMiBRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .acceleratorTypes(List.of("acceleratorTypes"))
         .allowedInstanceTypes(List.of("allowedInstanceTypes"))
         .bareMetal("bareMetal")
         .baselineEbsBandwidthMbps(BaselineEbsBandwidthMbpsRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .burstablePerformance("burstablePerformance")
         .cpuManufacturers(List.of("cpuManufacturers"))
         .excludedInstanceTypes(List.of("excludedInstanceTypes"))
         .instanceGenerations(List.of("instanceGenerations"))
         .localStorage("localStorage")
         .localStorageTypes(List.of("localStorageTypes"))
         .memoryGiBPerVCpu(MemoryGiBPerVCpuRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .memoryMiB(MemoryMiBRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .networkBandwidthGbps(NetworkBandwidthGbpsRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .networkInterfaceCount(NetworkInterfaceCountRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .onDemandMaxPricePercentageOverLowestPrice(123)
         .requireHibernateSupport(false)
         .spotMaxPricePercentageOverLowestPrice(123)
         .totalLocalStorageGb(TotalLocalStorageGBRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .vCpuCount(VCpuCountRequestProperty.builder()
                 .max(123)
                 .min(123)
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnAutoScalingGroup.InstanceRequirementsProperty.Builder A builder for CfnAutoScalingGroup.InstanceRequirementsProperty
static class	CfnAutoScalingGroup.InstanceRequirementsProperty.Jsii$Proxy An implementation for CfnAutoScalingGroup.InstanceRequirementsProperty

Method Summary

Modifier and Type	Method and Description
static CfnAutoScalingGroup.InstanceRequirementsProperty.Builder	builder()
default Object	getAcceleratorCount() The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) for an instance type.
default List<String>	getAcceleratorManufacturers() Indicates whether instance types must have accelerators by specific manufacturers.
default List<String>	getAcceleratorNames() Lists the accelerators that must be on an instance type.
default Object	getAcceleratorTotalMemoryMiB() The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
default List<String>	getAcceleratorTypes() Lists the accelerator types that must be on an instance type.
default List<String>	getAllowedInstanceTypes() The instance types to apply your specified attributes against.
default String	getBareMetal() Indicates whether bare metal instance types are included, excluded, or required.
default Object	getBaselineEbsBandwidthMbps() The minimum and maximum baseline bandwidth performance for an instance type, in Mbps.
default String	getBurstablePerformance() Indicates whether burstable performance instance types are included, excluded, or required.
default List<String>	getCpuManufacturers() Lists which specific CPU manufacturers to include.
default List<String>	getExcludedInstanceTypes() The instance types to exclude.
default List<String>	getInstanceGenerations() Indicates whether current or previous generation instance types are included.
default String	getLocalStorage() Indicates whether instance types with instance store volumes are included, excluded, or required.
default List<String>	getLocalStorageTypes() Indicates the type of local storage that is required.
default Object	getMemoryGiBPerVCpu() The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
default Object	getMemoryMiB() The minimum and maximum instance memory size for an instance type, in MiB.
default Object	getNetworkBandwidthGbps() The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
default Object	getNetworkInterfaceCount() The minimum and maximum number of network interfaces for an instance type.
default Number	getOnDemandMaxPricePercentageOverLowestPrice() The price protection threshold for On-Demand Instances.
default Object	getRequireHibernateSupport() Indicates whether instance types must provide On-Demand Instance hibernation support.
default Number	getSpotMaxPricePercentageOverLowestPrice() The price protection threshold for Spot Instances.
default Object	getTotalLocalStorageGb() The minimum and maximum total local storage size for an instance type, in GB.
default Object	getVCpuCount() The minimum and maximum number of vCPUs for an instance type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAcceleratorCount

@Stability(value=Stable)
 @Nullable
default Object 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 Max to 0 .

Default: No minimum or maximum limits

getAcceleratorManufacturers

@Stability(value=Stable)
 @Nullable
default List<String> 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

getAcceleratorNames

@Stability(value=Stable)
 @Nullable
default List<String> 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

getAcceleratorTotalMemoryMiB

@Stability(value=Stable)
 @Nullable
default Object getAcceleratorTotalMemoryMiB()

The minimum and maximum total memory size for the accelerators on an instance type, in MiB.

Default: No minimum or maximum limits

getAcceleratorTypes

@Stability(value=Stable)
 @Nullable
default List<String> 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

getAllowedInstanceTypes

@Stability(value=Stable)
 @Nullable
default List<String> 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 specify m5a.* , Amazon EC2 Auto Scaling will allow all the M5a instance types, but not the M5n instance types.

If you specify AllowedInstanceTypes , you can't specify ExcludedInstanceTypes .

Default: All instance types

getBareMetal

@Stability(value=Stable)
 @Nullable
default String getBareMetal()

Indicates whether bare metal instance types are included, excluded, or required.

Default: excluded

getBaselineEbsBandwidthMbps

@Stability(value=Stable)
 @Nullable
default Object 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

getBurstablePerformance

@Stability(value=Stable)
 @Nullable
default String 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

getCpuManufacturers

@Stability(value=Stable)
 @Nullable
default List<String> 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

getExcludedInstanceTypes

@Stability(value=Stable)
 @Nullable
default List<String> 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 specify m5a.* , Amazon EC2 Auto Scaling will exclude all the M5a instance types, but not the M5n instance types.

If you specify ExcludedInstanceTypes , you can't specify AllowedInstanceTypes .

Default: No excluded instance types

getInstanceGenerations

@Stability(value=Stable)
 @Nullable
default List<String> 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

getLocalStorage

@Stability(value=Stable)
 @Nullable
default String 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

getLocalStorageTypes

@Stability(value=Stable)
 @Nullable
default List<String> 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

getMemoryGiBPerVCpu

@Stability(value=Stable)
 @Nullable
default Object getMemoryGiBPerVCpu()

The minimum and maximum amount of memory per vCPU for an instance type, in GiB.

Default: No minimum or maximum limits

getMemoryMiB

@Stability(value=Stable)
 @Nullable
default Object getMemoryMiB()

The minimum and maximum instance memory size for an instance type, in MiB.

getNetworkBandwidthGbps

@Stability(value=Stable)
 @Nullable
default Object getNetworkBandwidthGbps()

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

Default: No minimum or maximum limits

getNetworkInterfaceCount

@Stability(value=Stable)
 @Nullable
default Object getNetworkInterfaceCount()

The minimum and maximum number of network interfaces for an instance type.

Default: No minimum or maximum limits

getOnDemandMaxPricePercentageOverLowestPrice

@Stability(value=Stable)
 @Nullable
default Number getOnDemandMaxPricePercentageOverLowestPrice()

The price protection threshold for On-Demand Instances.

This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage higher than the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your 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 DesiredCapacityType to vcpu or memory-mib , the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price.

Default: 20

getRequireHibernateSupport

@Stability(value=Stable)
 @Nullable
default Object getRequireHibernateSupport()

Indicates whether instance types must provide On-Demand Instance hibernation support.

Default: false

getSpotMaxPricePercentageOverLowestPrice

@Stability(value=Stable)
 @Nullable
default Number getSpotMaxPricePercentageOverLowestPrice()

The price protection threshold for Spot Instances.

This is the maximum you’ll pay for a Spot Instance, expressed as a percentage higher than the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 Auto Scaling selects instance types with your attributes, we will exclude instance types whose price is higher than your 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 DesiredCapacityType to vcpu or memory-mib , the price protection threshold is applied based on the per vCPU or per memory price instead of the per instance price.

Default: 100

getTotalLocalStorageGb

@Stability(value=Stable)
 @Nullable
default Object getTotalLocalStorageGb()

The minimum and maximum total local storage size for an instance type, in GB.

Default: No minimum or maximum limits

getVCpuCount

@Stability(value=Stable)
 @Nullable
default Object getVCpuCount()

The minimum and maximum number of vCPUs for an instance type.

builder

@Stability(value=Stable)
static CfnAutoScalingGroup.InstanceRequirementsProperty.Builder builder()

Returns:

a CfnAutoScalingGroup.InstanceRequirementsProperty.Builder of CfnAutoScalingGroup.InstanceRequirementsProperty