AWSEC2InstanceRequirementsRequest

Objective-C

@interface AWSEC2InstanceRequirementsRequest

Swift

class AWSEC2InstanceRequirementsRequest

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.

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

If you specify InstanceRequirements, you can’t specify InstanceType.

Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can’t specify InstanceRequirements.

For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.

Required parameters: [VCpuCount, MemoryMiB]

  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2AcceleratorCountRequest *_Nullable acceleratorCount;

    Swift

    var acceleratorCount: AWSEC2AcceleratorCountRequest? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable acceleratorManufacturers;

    Swift

    var acceleratorManufacturers: [String]? { get set }
  • 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 NVIDIA GRID K520 GPUs, specify k520.

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

    • 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 NVIDIA T4 GPUs, specify t4.

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

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

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

    Default: Any accelerator

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable acceleratorNames;

    Swift

    var acceleratorNames: [String]? { get set }
  • The minimum and maximum amount of total accelerator memory, in MiB.

    Default: No minimum or maximum limits

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2AcceleratorTotalMemoryMiBRequest *_Nullable acceleratorTotalMemoryMiB;

    Swift

    var acceleratorTotalMemoryMiB: AWSEC2AcceleratorTotalMemoryMiBRequest? { get set }
  • The accelerator types that must be on the instance type.

    • To include instance types with GPU hardware, specify gpu.

    • To include instance types with FPGA hardware, specify fpga.

    • To include instance types with inference hardware, specify inference.

    Default: Any accelerator type

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable acceleratorTypes;

    Swift

    var acceleratorTypes: [String]? { get set }
  • 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.

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

    Default: All instance types

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable allowedInstanceTypes;

    Swift

    var allowedInstanceTypes: [String]? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2BareMetal bareMetal;

    Swift

    var bareMetal: AWSEC2BareMetal { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2BaselineEbsBandwidthMbpsRequest *_Nullable baselineEbsBandwidthMbps;

    Swift

    var baselineEbsBandwidthMbps: AWSEC2BaselineEbsBandwidthMbpsRequest? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2BurstablePerformance burstablePerformance;

    Swift

    var burstablePerformance: AWSEC2BurstablePerformance { get set }
  • 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.

    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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable cpuManufacturers;

    Swift

    var cpuManufacturers: [String]? { get set }
  • 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.

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

    Default: No excluded instance types

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable excludedInstanceTypes;

    Swift

    var excludedInstanceTypes: [String]? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable instanceGenerations;

    Swift

    var instanceGenerations: [String]? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic) AWSEC2LocalStorage localStorage;

    Swift

    var localStorage: AWSEC2LocalStorage { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<NSString *> *_Nullable localStorageTypes;

    Swift

    var localStorageTypes: [String]? { get set }
  • [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.

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

    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, then SpotMaxPricePercentageOverLowestPrice is used and the value for that parameter defaults to 100.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable maxSpotPriceAsPercentageOfOptimalOnDemandPrice;

    Swift

    var maxSpotPriceAsPercentageOfOptimalOnDemandPrice: NSNumber? { get set }
  • The minimum and maximum amount of memory per vCPU, in GiB.

    Default: No minimum or maximum limits

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2MemoryGiBPerVCpuRequest *_Nullable memoryGiBPerVCpu;

    Swift

    var memoryGiBPerVCpu: AWSEC2MemoryGiBPerVCpuRequest? { get set }
  • The minimum and maximum amount of memory, in MiB.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2MemoryMiBRequest *_Nullable memoryMiB;

    Swift

    var memoryMiB: AWSEC2MemoryMiBRequest? { get set }
  • 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

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2NetworkBandwidthGbpsRequest *_Nullable networkBandwidthGbps;

    Swift

    var networkBandwidthGbps: AWSEC2NetworkBandwidthGbpsRequest? { get set }
  • The minimum and maximum number of network interfaces.

    Default: No minimum or maximum limits

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2NetworkInterfaceCountRequest *_Nullable networkInterfaceCount;

    Swift

    var networkInterfaceCount: AWSEC2NetworkInterfaceCountRequest? { get set }
  • [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.

    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

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable onDemandMaxPricePercentageOverLowestPrice;

    Swift

    var onDemandMaxPricePercentageOverLowestPrice: NSNumber? { get set }
  • Indicates whether instance types must support hibernation for On-Demand Instances.

    This parameter is not supported for GetSpotPlacementScores.

    Default: false

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable requireHibernateSupport;

    Swift

    var requireHibernateSupport: NSNumber? { get set }
  • [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.

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

    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.

    Only one of SpotMaxPricePercentageOverLowestPrice or MaxSpotPriceAsPercentageOfOptimalOnDemandPrice can be specified. If you don’t specify either, then SpotMaxPricePercentageOverLowestPrice is used and the value for that parameter defaults to 100.

    Default: 100

    Declaration

    Objective-C

    @property (nonatomic, strong) NSNumber *_Nullable spotMaxPricePercentageOverLowestPrice;

    Swift

    var spotMaxPricePercentageOverLowestPrice: NSNumber? { get set }
  • The minimum and maximum amount of total local storage, in GB.

    Default: No minimum or maximum limits

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2TotalLocalStorageGBRequest *_Nullable totalLocalStorageGB;

    Swift

    var totalLocalStorageGB: AWSEC2TotalLocalStorageGBRequest? { get set }
  • The minimum and maximum number of vCPUs.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSEC2VCpuCountRangeRequest *_Nullable VCpuCount;

    Swift

    var vCpuCount: AWSEC2VCpuCountRangeRequest? { get set }