InstanceRequirements
¶
Source code in docs_src/capo_auto_scaling/types/instance_requirements.py
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 | |
accelerator_count
instance-attribute
¶
accelerator_count: NotRequired[AcceleratorCountRequest]
The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) for an instance type.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
accelerator_manufacturers
instance-attribute
¶
accelerator_manufacturers: NotRequired[AcceleratorManufacturers]
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 Amazon Web Services devices, specify
amazon-web-services. -
For instance types with Xilinx devices, specify
xilinx.
Default: Any manufacturer
accelerator_names
instance-attribute
¶
accelerator_names: NotRequired[AcceleratorNames]
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
accelerator_total_memory_mi_b
instance-attribute
¶
accelerator_total_memory_mi_b: NotRequired[AcceleratorTotalMemoryMiBRequest]
The minimum and maximum total memory size for the accelerators on an instance type, in MiB.
Default: No minimum or maximum limits
accelerator_types
instance-attribute
¶
accelerator_types: NotRequired[AcceleratorTypes]
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
allowed_instance_types
instance-attribute
¶
allowed_instance_types: NotRequired[AllowedInstanceTypes]
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
bare_metal
instance-attribute
¶
bare_metal: NotRequired[BareMetal]
Indicates whether bare metal instance types are included, excluded, or required.
Default: excluded
baseline_ebs_bandwidth_mbps
instance-attribute
¶
baseline_ebs_bandwidth_mbps: NotRequired[BaselineEbsBandwidthMbpsRequest]
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.
Default: No minimum or maximum limits
baseline_performance_factors
instance-attribute
¶
baseline_performance_factors: NotRequired[BaselinePerformanceFactorsRequest]
The baseline performance factors for the instance requirements.
burstable_performance
instance-attribute
¶
burstable_performance: NotRequired[BurstablePerformance]
Indicates whether burstable performance instance types are included, excluded, or required. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: excluded
cpu_manufacturers
instance-attribute
¶
cpu_manufacturers: NotRequired[CpuManufacturers]
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 Amazon Web Services CPUs, specify
amazon-web-services. -
For instance types with Apple CPUs, specify
apple.
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
excluded_instance_types
instance-attribute
¶
excluded_instance_types: NotRequired[ExcludedInstanceTypes]
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
instance_generations
instance-attribute
¶
instance_generations: NotRequired[InstanceGenerations]
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 previous generation instance types, specify
previous.
Default: Any current or previous generation
local_storage
instance-attribute
¶
local_storage: NotRequired[LocalStorage]
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.
Default: included
local_storage_types
instance-attribute
¶
local_storage_types: NotRequired[LocalStorageTypes]
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
max_spot_price_as_percentage_of_optimal_on_demand_price
instance-attribute
¶
max_spot_price_as_percentage_of_optimal_on_demand_price: NotRequired[
NullablePositiveInteger
]
[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 DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can 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 as 999999.
memory_gi_b_per_v_cpu
instance-attribute
¶
memory_gi_b_per_v_cpu: NotRequired[MemoryGiBPerVCpuRequest]
The minimum and maximum amount of memory per vCPU for an instance type, in GiB.
Default: No minimum or maximum limits
memory_mi_b
instance-attribute
¶
memory_mi_b: NotRequired[MemoryMiBRequest]
The minimum and maximum instance memory size for an instance type, in MiB.
network_bandwidth_gbps
instance-attribute
¶
network_bandwidth_gbps: NotRequired[NetworkBandwidthGbpsRequest]
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
network_interface_count
instance-attribute
¶
network_interface_count: NotRequired[NetworkInterfaceCountRequest]
The minimum and maximum number of network interfaces for an instance type.
Default: No minimum or maximum limits
on_demand_max_price_percentage_over_lowest_price
instance-attribute
¶
on_demand_max_price_percentage_over_lowest_price: NotRequired[NullablePositiveInteger]
[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 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
require_hibernate_support
instance-attribute
¶
require_hibernate_support: NotRequired[NullableBoolean]
Indicates whether instance types must provide On-Demand Instance hibernation support.
Default: false
spot_max_price_percentage_over_lowest_price
instance-attribute
¶
spot_max_price_percentage_over_lowest_price: NotRequired[NullablePositiveInteger]
[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 DesiredCapacityType to vcpu or memory-mib, the price protection threshold is based on the per-vCPU or per-memory price instead of the per instance price.
Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can 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 as 999999.
total_local_storage_gb
instance-attribute
¶
total_local_storage_gb: NotRequired[TotalLocalStorageGBRequest]
The minimum and maximum total local storage size for an instance type, in GB.
Default: No minimum or maximum limits
v_cpu_count
instance-attribute
¶
v_cpu_count: NotRequired[VCpuCountRequest]
The minimum and maximum number of vCPUs for an instance type.