AWSEC2InstanceRequirements

Objective-C

@interface AWSEC2InstanceRequirements

Swift

class AWSEC2InstanceRequirements

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

When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values.

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

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.

  • 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) AWSEC2AcceleratorCount *_Nullable acceleratorCount;

    Swift

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

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

    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) AWSEC2AcceleratorTotalMemoryMiB *_Nullable acceleratorTotalMemoryMiB;

    Swift

    var acceleratorTotalMemoryMiB: AWSEC2AcceleratorTotalMemoryMiB? { get set }
  • The accelerator types that must be on the 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

    Declaration

    Objective-C

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

    Swift

    var acceleratorTypes: [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) AWSEC2BaselineEbsBandwidthMbps *_Nullable baselineEbsBandwidthMbps;

    Swift

    var baselineEbsBandwidthMbps: AWSEC2BaselineEbsBandwidthMbps? { 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 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.

    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 (SDD) storage, specify sdd.

    Default: hdd and sdd

    Declaration

    Objective-C

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

    Swift

    var localStorageTypes: [String]? { 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) AWSEC2MemoryGiBPerVCpu *_Nullable memoryGiBPerVCpu;

    Swift

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

    Declaration

    Objective-C

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

    Swift

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

    Default: No minimum or maximum limits

    Declaration

    Objective-C

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

    Swift

    var networkInterfaceCount: AWSEC2NetworkInterfaceCount? { get set }
  • The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

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

    To turn off price protection, 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 }
  • The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the cheapest M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.

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

    To turn off price protection, 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: 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) AWSEC2TotalLocalStorageGB *_Nullable totalLocalStorageGB;

    Swift

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

    Declaration

    Objective-C

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

    Swift

    var vCpuCount: AWSEC2VCpuCountRange? { get set }