LaunchTemplateInstanceRequirements

data class LaunchTemplateInstanceRequirements(val acceleratorCount: LaunchTemplateAcceleratorCount? = null, val acceleratorManufacturers: List<String>? = null, val acceleratorNames: List<String>? = null, val acceleratorTotalMemoryMiB: LaunchTemplateAcceleratorTotalMemoryMiB? = null, val acceleratorTypes: List<String>? = null, val allowedInstanceTypes: List<String>? = null, val bareMetal: String? = null, val baselineEbsBandwidthMbps: LaunchTemplateBaselineEbsBandwidthMbps? = null, val baselinePerformanceFactors: LaunchTemplateBaselinePerformanceFactors? = null, val burstablePerformance: String? = null, val cpuManufacturers: List<String>? = null, val excludedInstanceTypes: List<String>? = null, val instanceGenerations: List<String>? = null, val localStorage: String? = null, val localStorageTypes: List<String>? = null, val maxSpotPriceAsPercentageOfOptimalOnDemandPrice: Int? = null, val memoryGiBPerVCpu: LaunchTemplateMemoryGiBPerVCpu? = null, val memoryMiB: LaunchTemplateMemoryMiB? = null, val networkBandwidthGbps: LaunchTemplateNetworkBandwidthGbps? = null, val networkInterfaceCount: LaunchTemplateNetworkInterfaceCount? = null, val onDemandMaxPricePercentageOverLowestPrice: Int? = null, val requireHibernateSupport: Boolean? = null, val spotMaxPricePercentageOverLowestPrice: Int? = null, val totalLocalStorageGb: LaunchTemplateTotalLocalStorageGb? = null, val vCpuCount: LaunchTemplateVCpuCount? = null)

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::InstanceAWS CloudFormation resource, you can't specify `InstanceRequirements`. For more information, see Specify attributes for instance type selection for EC2 Fleet or Spot Fleet and Spot placement score in the Amazon EC2 User Guide.

Constructors

Link copied to clipboard
constructor(acceleratorCount: LaunchTemplateAcceleratorCount? = null, acceleratorManufacturers: List<String>? = null, acceleratorNames: List<String>? = null, acceleratorTotalMemoryMiB: LaunchTemplateAcceleratorTotalMemoryMiB? = null, acceleratorTypes: List<String>? = null, allowedInstanceTypes: List<String>? = null, bareMetal: String? = null, baselineEbsBandwidthMbps: LaunchTemplateBaselineEbsBandwidthMbps? = null, baselinePerformanceFactors: LaunchTemplateBaselinePerformanceFactors? = null, burstablePerformance: String? = null, cpuManufacturers: List<String>? = null, excludedInstanceTypes: List<String>? = null, instanceGenerations: List<String>? = null, localStorage: String? = null, localStorageTypes: List<String>? = null, maxSpotPriceAsPercentageOfOptimalOnDemandPrice: Int? = null, memoryGiBPerVCpu: LaunchTemplateMemoryGiBPerVCpu? = null, memoryMiB: LaunchTemplateMemoryMiB? = null, networkBandwidthGbps: LaunchTemplateNetworkBandwidthGbps? = null, networkInterfaceCount: LaunchTemplateNetworkInterfaceCount? = null, onDemandMaxPricePercentageOverLowestPrice: Int? = null, requireHibernateSupport: Boolean? = null, spotMaxPricePercentageOverLowestPrice: Int? = null, totalLocalStorageGb: LaunchTemplateTotalLocalStorageGb? = null, vCpuCount: LaunchTemplateVCpuCount? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set `Max` to `0`. Default: No minimum or maximum limits

Link copied to clipboard

Indicates whether instance types must have accelerators by specific manufacturers.

Link copied to clipboard

The accelerators that must be on the instance type.

Link copied to clipboard

The minimum and maximum amount of total accelerator memory, in MiB. Default: No minimum or maximum limits

Link copied to clipboard

The accelerator types that must be on the instance type.

Link copied to clipboard

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

Link copied to clipboard
val bareMetal: String? = null

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The CPU manufacturers to include.

Link copied to clipboard

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. If you specify `ExcludedInstanceTypes`, you can't specify `AllowedInstanceTypes`. Default: No excluded instance types

Link copied to clipboard

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

Link copied to clipboard
val localStorage: String? = null

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.

Link copied to clipboard

The type of local storage that is required.

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

Link copied to clipboard

The minimum and maximum amount of memory per vCPU, in GiB. Default: No minimum or maximum limits

Link copied to clipboard

The minimum and maximum amount of memory, in MiB.

Link copied to clipboard

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps). Default: No minimum or maximum limits

Link copied to clipboard

The minimum and maximum number of network interfaces. Default: No minimum or maximum limits

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

Link copied to clipboard

Indicates whether instance types must support hibernation for On-Demand Instances. This parameter is not supported for GetSpotPlacementScores. Default: `false`

Link copied to clipboard

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

Link copied to clipboard

The minimum and maximum amount of total local storage, in GB. Default: No minimum or maximum limits

Link copied to clipboard

The minimum and maximum number of vCPUs.