Interface CfnEC2Fleet.IInstanceRequirementsRequestProperty
The attributes for the instance types.
Namespace: Amazon.CDK.AWS.EC2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnEC2Fleet.IInstanceRequirementsRequestPropertySyntax (vb)
Public Interface CfnEC2Fleet.IInstanceRequirementsRequestPropertyRemarks
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:
If you specify <code>InstanceRequirements</code> , you can't specify <code>InstanceType</code> .
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 AWS 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 .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.EC2;
var instanceRequirementsRequestProperty = new InstanceRequirementsRequestProperty {
AcceleratorCount = new AcceleratorCountRequestProperty {
Max = 123,
Min = 123
},
AcceleratorManufacturers = new [] { "acceleratorManufacturers" },
AcceleratorNames = new [] { "acceleratorNames" },
AcceleratorTotalMemoryMiB = new AcceleratorTotalMemoryMiBRequestProperty {
Max = 123,
Min = 123
},
AcceleratorTypes = new [] { "acceleratorTypes" },
AllowedInstanceTypes = new [] { "allowedInstanceTypes" },
BareMetal = "bareMetal",
BaselineEbsBandwidthMbps = new BaselineEbsBandwidthMbpsRequestProperty {
Max = 123,
Min = 123
},
BaselinePerformanceFactors = new BaselinePerformanceFactorsRequestProperty {
Cpu = new CpuPerformanceFactorRequestProperty {
References = new [] { new PerformanceFactorReferenceRequestProperty {
InstanceFamily = "instanceFamily"
} }
}
},
BurstablePerformance = "burstablePerformance",
CpuManufacturers = new [] { "cpuManufacturers" },
ExcludedInstanceTypes = new [] { "excludedInstanceTypes" },
InstanceGenerations = new [] { "instanceGenerations" },
LocalStorage = "localStorage",
LocalStorageTypes = new [] { "localStorageTypes" },
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice = 123,
MemoryGiBPerVCpu = new MemoryGiBPerVCpuRequestProperty {
Max = 123,
Min = 123
},
MemoryMiB = new MemoryMiBRequestProperty {
Max = 123,
Min = 123
},
NetworkBandwidthGbps = new NetworkBandwidthGbpsRequestProperty {
Max = 123,
Min = 123
},
NetworkInterfaceCount = new NetworkInterfaceCountRequestProperty {
Max = 123,
Min = 123
},
OnDemandMaxPricePercentageOverLowestPrice = 123,
RequireHibernateSupport = false,
SpotMaxPricePercentageOverLowestPrice = 123,
TotalLocalStorageGb = new TotalLocalStorageGBRequestProperty {
Max = 123,
Min = 123
},
VCpuCount = new VCpuCountRangeRequestProperty {
Max = 123,
Min = 123
}
};Synopsis
Properties
| AcceleratorCount | The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. |
| AcceleratorManufacturers | Indicates whether instance types must have accelerators by specific manufacturers. |
| AcceleratorNames | The accelerators that must be on the instance type. |
| AcceleratorTotalMemoryMiB | The minimum and maximum amount of total accelerator memory, in MiB. |
| AcceleratorTypes | The accelerator types that must be on the instance type. |
| AllowedInstanceTypes | The instance types to apply your specified attributes against. |
| BareMetal | Indicates whether bare metal instance types must be included, excluded, or required. |
| BaselineEbsBandwidthMbps | The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. |
| BaselinePerformanceFactors | The baseline performance to consider, using an instance family as a baseline reference. |
| BurstablePerformance | Indicates whether burstable performance T instance types are included, excluded, or required. |
| CpuManufacturers | The CPU manufacturers to include. |
| ExcludedInstanceTypes | The instance types to exclude. |
| InstanceGenerations | Indicates whether current or previous generation instance types are included. |
| LocalStorage | Indicates whether instance types with instance store volumes are included, excluded, or required. |
| LocalStorageTypes | The type of local storage that is required. |
| MaxSpotPriceAsPercentageOfOptimalOnDemandPrice | [Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. |
| MemoryGiBPerVCpu | The minimum and maximum amount of memory per vCPU, in GiB. |
| MemoryMiB | The minimum and maximum amount of memory, in MiB. |
| NetworkBandwidthGbps | The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). |
| NetworkInterfaceCount | The minimum and maximum number of network interfaces. |
| OnDemandMaxPricePercentageOverLowestPrice | [Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. |
| RequireHibernateSupport | Indicates whether instance types must support hibernation for On-Demand Instances. |
| SpotMaxPricePercentageOverLowestPrice | [Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. |
| TotalLocalStorageGb | The minimum and maximum amount of total local storage, in GB. |
| VCpuCount | The minimum and maximum number of vCPUs. |
Properties
AcceleratorCount
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.
object? AcceleratorCount { get; }Property Value
Remarks
To exclude accelerator-enabled instance types, set Max to 0 .
Default: No minimum or maximum limits
AcceleratorManufacturers
Indicates whether instance types must have accelerators by specific manufacturers.
string[]? AcceleratorManufacturers { get; }Property Value
string[]
Remarks
AcceleratorNames
The accelerators that must be on the instance type.
string[]? AcceleratorNames { get; }Property Value
string[]
Remarks
AcceleratorTotalMemoryMiB
The minimum and maximum amount of total accelerator memory, in MiB.
object? AcceleratorTotalMemoryMiB { get; }Property Value
Remarks
AcceleratorTypes
The accelerator types that must be on the instance type.
string[]? AcceleratorTypes { get; }Property Value
string[]
Remarks
AllowedInstanceTypes
The instance types to apply your specified attributes against.
string[]? AllowedInstanceTypes { get; }Property Value
string[]
Remarks
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 <code>AllowedInstanceTypes</code> , you can't specify <code>ExcludedInstanceTypes</code> .
Default: All instance types
BareMetal
Indicates whether bare metal instance types must be included, excluded, or required.
string? BareMetal { get; }Property Value
Remarks
BaselineEbsBandwidthMbps
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps.
object? BaselineEbsBandwidthMbps { get; }Property Value
Remarks
For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide .
Default: No minimum or maximum limits
BaselinePerformanceFactors
The baseline performance to consider, using an instance family as a baseline reference.
object? BaselinePerformanceFactors { get; }Property Value
Remarks
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 .
BurstablePerformance
Indicates whether burstable performance T instance types are included, excluded, or required.
string? BurstablePerformance { get; }Property Value
Remarks
CpuManufacturers
The CPU manufacturers to include.
string[]? CpuManufacturers { get; }Property Value
string[]
Remarks
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
ExcludedInstanceTypes
The instance types to exclude.
string[]? ExcludedInstanceTypes { get; }Property Value
string[]
Remarks
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 <code>ExcludedInstanceTypes</code> , you can't specify <code>AllowedInstanceTypes</code> .
Default: No excluded instance types
InstanceGenerations
Indicates whether current or previous generation instance types are included.
string[]? InstanceGenerations { get; }Property Value
string[]
Remarks
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
LocalStorage
Indicates whether instance types with instance store volumes are included, excluded, or required.
string? LocalStorage { get; }Property Value
Remarks
LocalStorageTypes
The type of local storage that is required.
string[]? LocalStorageTypes { get; }Property Value
string[]
Remarks
MaxSpotPriceAsPercentageOfOptimalOnDemandPrice
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price.
double? MaxSpotPriceAsPercentageOfOptimalOnDemandPrice { get; }Property Value
Remarks
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 <code>SpotMaxPricePercentageOverLowestPrice</code> or <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> 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 <code>999999</code> .
MemoryGiBPerVCpu
The minimum and maximum amount of memory per vCPU, in GiB.
object? MemoryGiBPerVCpu { get; }Property Value
Remarks
MemoryMiB
The minimum and maximum amount of memory, in MiB.
object? MemoryMiB { get; }Property Value
Remarks
NetworkBandwidthGbps
The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps).
object? NetworkBandwidthGbps { get; }Property Value
Remarks
For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide .
Default: No minimum or maximum limits
NetworkInterfaceCount
The minimum and maximum number of network interfaces.
object? NetworkInterfaceCount { get; }Property Value
Remarks
OnDemandMaxPricePercentageOverLowestPrice
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price.
double? OnDemandMaxPricePercentageOverLowestPrice { get; }Property Value
Remarks
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 <code>TargetCapacityUnitType</code> to <code>vcpu</code> or <code>memory-mib</code> , the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
RequireHibernateSupport
Indicates whether instance types must support hibernation for On-Demand Instances.
object? RequireHibernateSupport { get; }Property Value
Remarks
This parameter is not supported for GetSpotPlacementScores .
Default: false
SpotMaxPricePercentageOverLowestPrice
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price.
double? SpotMaxPricePercentageOverLowestPrice { get; }Property Value
Remarks
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 <code>SpotMaxPricePercentageOverLowestPrice</code> or <code>MaxSpotPriceAsPercentageOfOptimalOnDemandPrice</code> 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 <code>999999</code> .
Default: 100
TotalLocalStorageGb
The minimum and maximum amount of total local storage, in GB.
object? TotalLocalStorageGb { get; }Property Value
Remarks
VCpuCount
The minimum and maximum number of vCPUs.
object? VCpuCount { get; }