Struct aws_sdk_ec2::model::InstanceRequirements

source ·

#[non_exhaustive]
pub struct InstanceRequirements { /* private fields */ }

Expand description

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

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.

You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute 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.

Implementations§

source §

impl InstanceRequirements

source

pub fn v_cpu_count(&self) -> Option<&VCpuCountRange>

The minimum and maximum number of vCPUs.

source

pub fn memory_mi_b(&self) -> Option<&MemoryMiB>

The minimum and maximum amount of memory, in MiB.

source

pub fn cpu_manufacturers(&self) -> Option<&[CpuManufacturer]>

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

source

pub fn memory_gi_b_per_v_cpu(&self) -> Option<&MemoryGiBPerVCpu>

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

Default: No minimum or maximum limits

source

pub fn excluded_instance_types(&self) -> Option<&[String]>

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

source

pub fn instance_generations(&self) -> Option<&[InstanceGeneration]>

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

source

pub fn spot_max_price_percentage_over_lowest_price(&self) -> Option<i32>

The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the least expensive current generation 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

source

pub fn on_demand_max_price_percentage_over_lowest_price(&self) -> Option<i32>

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 least expensive current generation 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

source

pub fn bare_metal(&self) -> Option<&BareMetal>

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

source

pub fn burstable_performance(&self) -> Option<&BurstablePerformance>

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

source

pub fn require_hibernate_support(&self) -> Option<bool>

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

This parameter is not supported for GetSpotPlacementScores.

Default: false

source

pub fn network_interface_count(&self) -> Option<&NetworkInterfaceCount>

The minimum and maximum number of network interfaces.

Default: No minimum or maximum limits

source

pub fn local_storage(&self) -> Option<&LocalStorage>

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

source

pub fn local_storage_types(&self) -> Option<&[LocalStorageType]>

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

source

pub fn total_local_storage_gb(&self) -> Option<&TotalLocalStorageGb>

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

Default: No minimum or maximum limits

source

pub fn baseline_ebs_bandwidth_mbps(&self) -> Option<&BaselineEbsBandwidthMbps>

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

source

pub fn accelerator_types(&self) -> Option<&[AcceleratorType]>

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

source

pub fn accelerator_count(&self) -> Option<&AcceleratorCount>

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

source

pub fn accelerator_manufacturers(&self) -> Option<&[AcceleratorManufacturer]>

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

source

pub fn accelerator_names(&self) -> Option<&[AcceleratorName]>

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.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.

Default: Any accelerator

source

pub fn accelerator_total_memory_mi_b(
&self
) -> Option<&AcceleratorTotalMemoryMiB>

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

Default: No minimum or maximum limits

source §

impl InstanceRequirements

source

pub fn builder() -> Builder

Creates a new builder-style object to manufacture InstanceRequirements.

Examples found in repository ?

src/xml_deser.rs (line 53231)

pub fn deser_structure_crate_model_instance_requirements(
    decoder: &mut aws_smithy_xml::decode::ScopedDecoder,
) -> Result<crate::model::InstanceRequirements, aws_smithy_xml::decode::XmlDecodeError> {
    #[allow(unused_mut)]
    let mut builder = crate::model::InstanceRequirements::builder();
    while let Some(mut tag) = decoder.next_tag() {
        match tag.start_el() {
            s if s.matches("vCpuCount") /* VCpuCount com.amazonaws.ec2#InstanceRequirements$VCpuCount */ =>  {
                let var_2539 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_v_cpu_count_range(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_v_cpu_count(var_2539);
            }
            ,
            s if s.matches("memoryMiB") /* MemoryMiB com.amazonaws.ec2#InstanceRequirements$MemoryMiB */ =>  {
                let var_2540 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_memory_mi_b(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_memory_mi_b(var_2540);
            }
            ,
            s if s.matches("cpuManufacturerSet") /* CpuManufacturers com.amazonaws.ec2#InstanceRequirements$CpuManufacturers */ =>  {
                let var_2541 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_cpu_manufacturer_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_cpu_manufacturers(var_2541);
            }
            ,
            s if s.matches("memoryGiBPerVCpu") /* MemoryGiBPerVCpu com.amazonaws.ec2#InstanceRequirements$MemoryGiBPerVCpu */ =>  {
                let var_2542 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_memory_gi_b_per_v_cpu(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_memory_gi_b_per_v_cpu(var_2542);
            }
            ,
            s if s.matches("excludedInstanceTypeSet") /* ExcludedInstanceTypes com.amazonaws.ec2#InstanceRequirements$ExcludedInstanceTypes */ =>  {
                let var_2543 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_excluded_instance_type_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_excluded_instance_types(var_2543);
            }
            ,
            s if s.matches("instanceGenerationSet") /* InstanceGenerations com.amazonaws.ec2#InstanceRequirements$InstanceGenerations */ =>  {
                let var_2544 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_instance_generation_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_instance_generations(var_2544);
            }
            ,
            s if s.matches("spotMaxPricePercentageOverLowestPrice") /* SpotMaxPricePercentageOverLowestPrice com.amazonaws.ec2#InstanceRequirements$SpotMaxPricePercentageOverLowestPrice */ =>  {
                let var_2545 =
                    Some(
                         {
                            <i32 as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                            .map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (integer: `com.amazonaws.ec2#Integer`)"))
                        }
                        ?
                    )
                ;
                builder = builder.set_spot_max_price_percentage_over_lowest_price(var_2545);
            }
            ,
            s if s.matches("onDemandMaxPricePercentageOverLowestPrice") /* OnDemandMaxPricePercentageOverLowestPrice com.amazonaws.ec2#InstanceRequirements$OnDemandMaxPricePercentageOverLowestPrice */ =>  {
                let var_2546 =
                    Some(
                         {
                            <i32 as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                            .map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (integer: `com.amazonaws.ec2#Integer`)"))
                        }
                        ?
                    )
                ;
                builder = builder.set_on_demand_max_price_percentage_over_lowest_price(var_2546);
            }
            ,
            s if s.matches("bareMetal") /* BareMetal com.amazonaws.ec2#InstanceRequirements$BareMetal */ =>  {
                let var_2547 =
                    Some(
                        Result::<crate::model::BareMetal, aws_smithy_xml::decode::XmlDecodeError>::Ok(
                            crate::model::BareMetal::from(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                        )
                        ?
                    )
                ;
                builder = builder.set_bare_metal(var_2547);
            }
            ,
            s if s.matches("burstablePerformance") /* BurstablePerformance com.amazonaws.ec2#InstanceRequirements$BurstablePerformance */ =>  {
                let var_2548 =
                    Some(
                        Result::<crate::model::BurstablePerformance, aws_smithy_xml::decode::XmlDecodeError>::Ok(
                            crate::model::BurstablePerformance::from(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                        )
                        ?
                    )
                ;
                builder = builder.set_burstable_performance(var_2548);
            }
            ,
            s if s.matches("requireHibernateSupport") /* RequireHibernateSupport com.amazonaws.ec2#InstanceRequirements$RequireHibernateSupport */ =>  {
                let var_2549 =
                    Some(
                         {
                            <bool as aws_smithy_types::primitive::Parse>::parse_smithy_primitive(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                            .map_err(|_|aws_smithy_xml::decode::XmlDecodeError::custom("expected (boolean: `com.amazonaws.ec2#Boolean`)"))
                        }
                        ?
                    )
                ;
                builder = builder.set_require_hibernate_support(var_2549);
            }
            ,
            s if s.matches("networkInterfaceCount") /* NetworkInterfaceCount com.amazonaws.ec2#InstanceRequirements$NetworkInterfaceCount */ =>  {
                let var_2550 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_network_interface_count(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_network_interface_count(var_2550);
            }
            ,
            s if s.matches("localStorage") /* LocalStorage com.amazonaws.ec2#InstanceRequirements$LocalStorage */ =>  {
                let var_2551 =
                    Some(
                        Result::<crate::model::LocalStorage, aws_smithy_xml::decode::XmlDecodeError>::Ok(
                            crate::model::LocalStorage::from(
                                aws_smithy_xml::decode::try_data(&mut tag)?.as_ref()
                            )
                        )
                        ?
                    )
                ;
                builder = builder.set_local_storage(var_2551);
            }
            ,
            s if s.matches("localStorageTypeSet") /* LocalStorageTypes com.amazonaws.ec2#InstanceRequirements$LocalStorageTypes */ =>  {
                let var_2552 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_local_storage_type_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_local_storage_types(var_2552);
            }
            ,
            s if s.matches("totalLocalStorageGB") /* TotalLocalStorageGB com.amazonaws.ec2#InstanceRequirements$TotalLocalStorageGB */ =>  {
                let var_2553 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_total_local_storage_gb(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_total_local_storage_gb(var_2553);
            }
            ,
            s if s.matches("baselineEbsBandwidthMbps") /* BaselineEbsBandwidthMbps com.amazonaws.ec2#InstanceRequirements$BaselineEbsBandwidthMbps */ =>  {
                let var_2554 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_baseline_ebs_bandwidth_mbps(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_baseline_ebs_bandwidth_mbps(var_2554);
            }
            ,
            s if s.matches("acceleratorTypeSet") /* AcceleratorTypes com.amazonaws.ec2#InstanceRequirements$AcceleratorTypes */ =>  {
                let var_2555 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_accelerator_type_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_accelerator_types(var_2555);
            }
            ,
            s if s.matches("acceleratorCount") /* AcceleratorCount com.amazonaws.ec2#InstanceRequirements$AcceleratorCount */ =>  {
                let var_2556 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_accelerator_count(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_accelerator_count(var_2556);
            }
            ,
            s if s.matches("acceleratorManufacturerSet") /* AcceleratorManufacturers com.amazonaws.ec2#InstanceRequirements$AcceleratorManufacturers */ =>  {
                let var_2557 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_accelerator_manufacturer_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_accelerator_manufacturers(var_2557);
            }
            ,
            s if s.matches("acceleratorNameSet") /* AcceleratorNames com.amazonaws.ec2#InstanceRequirements$AcceleratorNames */ =>  {
                let var_2558 =
                    Some(
                        crate::xml_deser::deser_list_com_amazonaws_ec2_accelerator_name_set(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_accelerator_names(var_2558);
            }
            ,
            s if s.matches("acceleratorTotalMemoryMiB") /* AcceleratorTotalMemoryMiB com.amazonaws.ec2#InstanceRequirements$AcceleratorTotalMemoryMiB */ =>  {
                let var_2559 =
                    Some(
                        crate::xml_deser::deser_structure_crate_model_accelerator_total_memory_mi_b(&mut tag)
                        ?
                    )
                ;
                builder = builder.set_accelerator_total_memory_mi_b(var_2559);
            }
            ,
            _ => {}
        }
    }
    Ok(builder.build())
}