Skip to content

EC2  >  Dictionaries  >  InstanceRequirementsRequestDict

InstanceRequirementsRequestDict

Dictionary Type

InstanceRequirementsRequestDict

Bases: TypedDict

Dictionary form of InstanceRequirementsRequest.

Attributes

accelerator_count instance-attribute

The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.

To exclude accelerator-enabled instance types, set Max to 0.

Default: No minimum or maximum limits

accelerator_manufacturers instance-attribute
accelerator_manufacturers: Sequence[str] | None

Indicates whether instance types must have accelerators by specific manufacturers.

  • For instance types with Amazon Web Services devices, specify amazon-web-services.

  • For instance types with AMD devices, specify amd.

  • For instance types with Habana devices, specify habana.

  • For instance types with NVIDIA devices, specify nvidia.

  • For instance types with Xilinx devices, specify xilinx.

Default: Any manufacturer

accelerator_names instance-attribute
accelerator_names: Sequence[str] | None

The accelerators that must be on the instance type.

  • For instance types with NVIDIA A10G GPUs, specify a10g.

  • For instance types with NVIDIA A100 GPUs, specify a100.

  • For instance types with NVIDIA H100 GPUs, specify h100.

  • For instance types with Amazon Web Services Inferentia chips, specify inferentia.

  • For instance types with Amazon Web Services Inferentia2 chips, specify inferentia2.

  • For instance types with Habana Gaudi HL-205 GPUs, specify gaudi-hl-205.

  • For instance types with NVIDIA GRID K520 GPUs, specify k520.

  • For instance types with NVIDIA K80 GPUs, specify k80.

  • For instance types with NVIDIA L4 GPUs, specify l4.

  • For instance types with NVIDIA L40S GPUs, specify l40s.

  • 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 Amazon Web Services Trainium chips, specify trainium.

  • For instance types with Amazon Web Services Trainium2 chips, specify trainium2.

  • For instance types with NVIDIA T4 GPUs, specify t4.

  • For instance types with NVIDIA T4G GPUs, specify t4g.

  • For instance types with Xilinx U30 cards, specify u30.

  • For instance types with Xilinx VU9P FPGAs, specify vu9p.

  • For instance types with NVIDIA V100 GPUs, specify v100.

Default: Any accelerator

accelerator_total_memory_mi_b instance-attribute

The minimum and maximum amount of total accelerator memory, in MiB.

Default: No minimum or maximum limits

accelerator_types instance-attribute
accelerator_types: Sequence[str] | None

The accelerator types that must be on the instance type.

  • For instance types with FPGA accelerators, specify fpga.

  • For instance types with GPU accelerators, specify gpu.

  • For instance types with Inference accelerators, specify inference.

  • For instance types with Media accelerators, specify media.

Default: Any accelerator type

allowed_instance_types instance-attribute
allowed_instance_types: Sequence[str] | None

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 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.

Note

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

Default: All instance types

bare_metal instance-attribute
bare_metal: str | None

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

  • To include bare metal instance types, specify included.

  • To require only bare metal instance types, specify required.

  • To exclude bare metal instance types, specify excluded.

Default: excluded

baseline_ebs_bandwidth_mbps instance-attribute

The minimum and maximum baseline bandwidth to Amazon EBS, 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

The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 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 more information, see Performance protection in the Amazon EC2 User Guide.

burstable_performance instance-attribute
burstable_performance: str | None

Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.

  • To include burstable performance instance types, specify included.

  • To require only burstable performance instance types, specify required.

  • To exclude burstable performance instance types, specify excluded.

Default: excluded

cpu_manufacturers instance-attribute
cpu_manufacturers: Sequence[str] | None

The 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.

Note

Don't confuse the CPU manufacturer with the CPU 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: Sequence[str] | None

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*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.

Note

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

Default: No excluded instance types

instance_generations instance-attribute
instance_generations: Sequence[str] | None

Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.

For current generation instance types, specify current.

For previous generation instance types, specify previous.

Default: Current and previous generation instance types

local_storage instance-attribute
local_storage: str | None

Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.

  • To include instance types with instance store volumes, specify included.

  • To require only instance types with instance store volumes, specify required.

  • To exclude instance types with instance store volumes, specify excluded.

Default: included

local_storage_types instance-attribute
local_storage_types: Sequence[str] | None

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: hdd and ssd

max_spot_price_as_percentage_of_optimal_on_demand_price instance-attribute
max_spot_price_as_percentage_of_optimal_on_demand_price: int | None

[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 the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

If you set TargetCapacityUnitType 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.

Note

Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 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: MemoryGiBPerVCpuRequest | MemoryGiBPerVCpuRequestDict | None

The minimum and maximum amount of memory per vCPU, in GiB.

Default: No minimum or maximum limits

memory_mi_b instance-attribute

The minimum and maximum amount of memory, in MiB.

network_bandwidth_gbps instance-attribute

The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide.

Default: No minimum or maximum limits

network_interface_count instance-attribute

The minimum and maximum number of network interfaces.

Default: No minimum or maximum limits

on_demand_max_price_percentage_over_lowest_price instance-attribute
on_demand_max_price_percentage_over_lowest_price: int | None

[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. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

To indicate no price protection threshold, specify a high value, such as 999999.

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

Note

If you set TargetCapacityUnitType 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_encryption_in_transit instance-attribute
require_encryption_in_transit: bool | None

Specifies whether instance types must support encrypting in-transit traffic between instances. For more information, including the supported instance types, see Encryption in transit in the Amazon EC2 User Guide.

Default: false

require_hibernate_support instance-attribute
require_hibernate_support: bool | None

Indicates whether instance types must support hibernation for On-Demand Instances.

This parameter is not supported for GetSpotPlacementScores.

Default: false

spot_max_price_percentage_over_lowest_price instance-attribute
spot_max_price_percentage_over_lowest_price: int | None

[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot 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 Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.

The parameter accepts an integer, which Amazon EC2 interprets as a percentage.

If you set TargetCapacityUnitType 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.

This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.

Note

Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don't specify either, Amazon EC2 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.

Default: 100

total_local_storage_gb instance-attribute

The minimum and maximum amount of total local storage, in GB.

Default: No minimum or maximum limits

v_cpu_count instance-attribute

The minimum and maximum number of vCPUs.