#[non_exhaustive]pub struct InstanceRequirementsRequestBuilder { /* private fields */ }
Expand description
A builder for InstanceRequirementsRequest
.
Implementations§
Source§impl InstanceRequirementsRequestBuilder
impl InstanceRequirementsRequestBuilder
Sourcepub fn v_cpu_count(self, input: VCpuCountRangeRequest) -> Self
pub fn v_cpu_count(self, input: VCpuCountRangeRequest) -> Self
The minimum and maximum number of vCPUs.
This field is required.Sourcepub fn set_v_cpu_count(self, input: Option<VCpuCountRangeRequest>) -> Self
pub fn set_v_cpu_count(self, input: Option<VCpuCountRangeRequest>) -> Self
The minimum and maximum number of vCPUs.
Sourcepub fn get_v_cpu_count(&self) -> &Option<VCpuCountRangeRequest>
pub fn get_v_cpu_count(&self) -> &Option<VCpuCountRangeRequest>
The minimum and maximum number of vCPUs.
Sourcepub fn memory_mib(self, input: MemoryMiBRequest) -> Self
pub fn memory_mib(self, input: MemoryMiBRequest) -> Self
The minimum and maximum amount of memory, in MiB.
This field is required.Sourcepub fn set_memory_mib(self, input: Option<MemoryMiBRequest>) -> Self
pub fn set_memory_mib(self, input: Option<MemoryMiBRequest>) -> Self
The minimum and maximum amount of memory, in MiB.
Sourcepub fn get_memory_mib(&self) -> &Option<MemoryMiBRequest>
pub fn get_memory_mib(&self) -> &Option<MemoryMiBRequest>
The minimum and maximum amount of memory, in MiB.
Sourcepub fn cpu_manufacturers(self, input: CpuManufacturer) -> Self
pub fn cpu_manufacturers(self, input: CpuManufacturer) -> Self
Appends an item to cpu_manufacturers
.
To override the contents of this collection use set_cpu_manufacturers
.
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
. -
For instance types with Apple CPUs, specify
apple
.
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
Sourcepub fn set_cpu_manufacturers(self, input: Option<Vec<CpuManufacturer>>) -> Self
pub fn set_cpu_manufacturers(self, input: Option<Vec<CpuManufacturer>>) -> Self
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
. -
For instance types with Apple CPUs, specify
apple
.
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
Sourcepub fn get_cpu_manufacturers(&self) -> &Option<Vec<CpuManufacturer>>
pub fn get_cpu_manufacturers(&self) -> &Option<Vec<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
. -
For instance types with Apple CPUs, specify
apple
.
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
Sourcepub fn memory_gib_per_v_cpu(self, input: MemoryGiBPerVCpuRequest) -> Self
pub fn memory_gib_per_v_cpu(self, input: MemoryGiBPerVCpuRequest) -> Self
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Sourcepub fn set_memory_gib_per_v_cpu(
self,
input: Option<MemoryGiBPerVCpuRequest>,
) -> Self
pub fn set_memory_gib_per_v_cpu( self, input: Option<MemoryGiBPerVCpuRequest>, ) -> Self
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Sourcepub fn get_memory_gib_per_v_cpu(&self) -> &Option<MemoryGiBPerVCpuRequest>
pub fn get_memory_gib_per_v_cpu(&self) -> &Option<MemoryGiBPerVCpuRequest>
The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
Sourcepub fn excluded_instance_types(self, input: impl Into<String>) -> Self
pub fn excluded_instance_types(self, input: impl Into<String>) -> Self
Appends an item to excluded_instance_types
.
To override the contents of this collection use set_excluded_instance_types
.
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
Sourcepub fn set_excluded_instance_types(self, input: Option<Vec<String>>) -> Self
pub fn set_excluded_instance_types(self, input: Option<Vec<String>>) -> Self
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
Sourcepub fn get_excluded_instance_types(&self) -> &Option<Vec<String>>
pub fn get_excluded_instance_types(&self) -> &Option<Vec<String>>
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
Sourcepub fn instance_generations(self, input: InstanceGeneration) -> Self
pub fn instance_generations(self, input: InstanceGeneration) -> Self
Appends an item to instance_generations
.
To override the contents of this collection use set_instance_generations
.
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
Sourcepub fn set_instance_generations(
self,
input: Option<Vec<InstanceGeneration>>,
) -> Self
pub fn set_instance_generations( self, input: Option<Vec<InstanceGeneration>>, ) -> Self
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
Sourcepub fn get_instance_generations(&self) -> &Option<Vec<InstanceGeneration>>
pub fn get_instance_generations(&self) -> &Option<Vec<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
Sourcepub fn spot_max_price_percentage_over_lowest_price(self, input: i32) -> Self
pub fn spot_max_price_percentage_over_lowest_price(self, input: i32) -> Self
\[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
Sourcepub fn set_spot_max_price_percentage_over_lowest_price(
self,
input: Option<i32>,
) -> Self
pub fn set_spot_max_price_percentage_over_lowest_price( self, input: Option<i32>, ) -> Self
\[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
Sourcepub fn get_spot_max_price_percentage_over_lowest_price(&self) -> &Option<i32>
pub fn get_spot_max_price_percentage_over_lowest_price(&self) -> &Option<i32>
\[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
Sourcepub fn on_demand_max_price_percentage_over_lowest_price(
self,
input: i32,
) -> Self
pub fn on_demand_max_price_percentage_over_lowest_price( self, input: i32, ) -> Self
\[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
Sourcepub fn set_on_demand_max_price_percentage_over_lowest_price(
self,
input: Option<i32>,
) -> Self
pub fn set_on_demand_max_price_percentage_over_lowest_price( self, input: Option<i32>, ) -> Self
\[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
Sourcepub fn get_on_demand_max_price_percentage_over_lowest_price(
&self,
) -> &Option<i32>
pub fn get_on_demand_max_price_percentage_over_lowest_price( &self, ) -> &Option<i32>
\[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
Sourcepub fn bare_metal(self, input: BareMetal) -> Self
pub fn bare_metal(self, input: BareMetal) -> Self
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
Sourcepub fn set_bare_metal(self, input: Option<BareMetal>) -> Self
pub fn set_bare_metal(self, input: Option<BareMetal>) -> Self
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
Sourcepub fn get_bare_metal(&self) -> &Option<BareMetal>
pub fn get_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
Sourcepub fn burstable_performance(self, input: BurstablePerformance) -> Self
pub fn burstable_performance(self, input: BurstablePerformance) -> Self
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
Sourcepub fn set_burstable_performance(
self,
input: Option<BurstablePerformance>,
) -> Self
pub fn set_burstable_performance( self, input: Option<BurstablePerformance>, ) -> Self
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
Sourcepub fn get_burstable_performance(&self) -> &Option<BurstablePerformance>
pub fn get_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
Sourcepub fn require_hibernate_support(self, input: bool) -> Self
pub fn require_hibernate_support(self, input: bool) -> Self
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
Sourcepub fn set_require_hibernate_support(self, input: Option<bool>) -> Self
pub fn set_require_hibernate_support(self, input: Option<bool>) -> Self
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
Sourcepub fn get_require_hibernate_support(&self) -> &Option<bool>
pub fn get_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
Sourcepub fn network_interface_count(
self,
input: NetworkInterfaceCountRequest,
) -> Self
pub fn network_interface_count( self, input: NetworkInterfaceCountRequest, ) -> Self
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Sourcepub fn set_network_interface_count(
self,
input: Option<NetworkInterfaceCountRequest>,
) -> Self
pub fn set_network_interface_count( self, input: Option<NetworkInterfaceCountRequest>, ) -> Self
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Sourcepub fn get_network_interface_count(
&self,
) -> &Option<NetworkInterfaceCountRequest>
pub fn get_network_interface_count( &self, ) -> &Option<NetworkInterfaceCountRequest>
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
Sourcepub fn local_storage(self, input: LocalStorage) -> Self
pub fn local_storage(self, input: LocalStorage) -> Self
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
Sourcepub fn set_local_storage(self, input: Option<LocalStorage>) -> Self
pub fn set_local_storage(self, input: Option<LocalStorage>) -> Self
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
Sourcepub fn get_local_storage(&self) -> &Option<LocalStorage>
pub fn get_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
Sourcepub fn local_storage_types(self, input: LocalStorageType) -> Self
pub fn local_storage_types(self, input: LocalStorageType) -> Self
Appends an item to local_storage_types
.
To override the contents of this collection use set_local_storage_types
.
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
Sourcepub fn set_local_storage_types(
self,
input: Option<Vec<LocalStorageType>>,
) -> Self
pub fn set_local_storage_types( self, input: Option<Vec<LocalStorageType>>, ) -> Self
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
Sourcepub fn get_local_storage_types(&self) -> &Option<Vec<LocalStorageType>>
pub fn get_local_storage_types(&self) -> &Option<Vec<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
Sourcepub fn total_local_storage_gb(self, input: TotalLocalStorageGbRequest) -> Self
pub fn total_local_storage_gb(self, input: TotalLocalStorageGbRequest) -> Self
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Sourcepub fn set_total_local_storage_gb(
self,
input: Option<TotalLocalStorageGbRequest>,
) -> Self
pub fn set_total_local_storage_gb( self, input: Option<TotalLocalStorageGbRequest>, ) -> Self
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Sourcepub fn get_total_local_storage_gb(&self) -> &Option<TotalLocalStorageGbRequest>
pub fn get_total_local_storage_gb(&self) -> &Option<TotalLocalStorageGbRequest>
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
Sourcepub fn baseline_ebs_bandwidth_mbps(
self,
input: BaselineEbsBandwidthMbpsRequest,
) -> Self
pub fn baseline_ebs_bandwidth_mbps( self, input: BaselineEbsBandwidthMbpsRequest, ) -> Self
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
Sourcepub fn set_baseline_ebs_bandwidth_mbps(
self,
input: Option<BaselineEbsBandwidthMbpsRequest>,
) -> Self
pub fn set_baseline_ebs_bandwidth_mbps( self, input: Option<BaselineEbsBandwidthMbpsRequest>, ) -> Self
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
Sourcepub fn get_baseline_ebs_bandwidth_mbps(
&self,
) -> &Option<BaselineEbsBandwidthMbpsRequest>
pub fn get_baseline_ebs_bandwidth_mbps( &self, ) -> &Option<BaselineEbsBandwidthMbpsRequest>
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
Sourcepub fn accelerator_types(self, input: AcceleratorType) -> Self
pub fn accelerator_types(self, input: AcceleratorType) -> Self
Appends an item to accelerator_types
.
To override the contents of this collection use set_accelerator_types
.
The accelerator types that must be on the instance type.
-
For instance types with FPGA accelerators, specify
fpga
. -
For instance types with GPU accelerators, specify
gpu
. -
For instance types with Inference accelerators, specify
inference
.
Default: Any accelerator type
Sourcepub fn set_accelerator_types(self, input: Option<Vec<AcceleratorType>>) -> Self
pub fn set_accelerator_types(self, input: Option<Vec<AcceleratorType>>) -> Self
The accelerator types that must be on the instance type.
-
For instance types with FPGA accelerators, specify
fpga
. -
For instance types with GPU accelerators, specify
gpu
. -
For instance types with Inference accelerators, specify
inference
.
Default: Any accelerator type
Sourcepub fn get_accelerator_types(&self) -> &Option<Vec<AcceleratorType>>
pub fn get_accelerator_types(&self) -> &Option<Vec<AcceleratorType>>
The accelerator types that must be on the instance type.
-
For instance types with FPGA accelerators, specify
fpga
. -
For instance types with GPU accelerators, specify
gpu
. -
For instance types with Inference accelerators, specify
inference
.
Default: Any accelerator type
Sourcepub fn accelerator_count(self, input: AcceleratorCountRequest) -> Self
pub fn accelerator_count(self, input: AcceleratorCountRequest) -> Self
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
Sourcepub fn set_accelerator_count(
self,
input: Option<AcceleratorCountRequest>,
) -> Self
pub fn set_accelerator_count( self, input: Option<AcceleratorCountRequest>, ) -> Self
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
Sourcepub fn get_accelerator_count(&self) -> &Option<AcceleratorCountRequest>
pub fn get_accelerator_count(&self) -> &Option<AcceleratorCountRequest>
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
Sourcepub fn accelerator_manufacturers(self, input: AcceleratorManufacturer) -> Self
pub fn accelerator_manufacturers(self, input: AcceleratorManufacturer) -> Self
Appends an item to accelerator_manufacturers
.
To override the contents of this collection use set_accelerator_manufacturers
.
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
Sourcepub fn set_accelerator_manufacturers(
self,
input: Option<Vec<AcceleratorManufacturer>>,
) -> Self
pub fn set_accelerator_manufacturers( self, input: Option<Vec<AcceleratorManufacturer>>, ) -> Self
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
Sourcepub fn get_accelerator_manufacturers(
&self,
) -> &Option<Vec<AcceleratorManufacturer>>
pub fn get_accelerator_manufacturers( &self, ) -> &Option<Vec<AcceleratorManufacturer>>
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
Sourcepub fn accelerator_names(self, input: AcceleratorName) -> Self
pub fn accelerator_names(self, input: AcceleratorName) -> Self
Appends an item to accelerator_names
.
To override the contents of this collection use set_accelerator_names
.
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
Sourcepub fn set_accelerator_names(self, input: Option<Vec<AcceleratorName>>) -> Self
pub fn set_accelerator_names(self, input: Option<Vec<AcceleratorName>>) -> Self
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
Sourcepub fn get_accelerator_names(&self) -> &Option<Vec<AcceleratorName>>
pub fn get_accelerator_names(&self) -> &Option<Vec<AcceleratorName>>
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
Sourcepub fn accelerator_total_memory_mib(
self,
input: AcceleratorTotalMemoryMiBRequest,
) -> Self
pub fn accelerator_total_memory_mib( self, input: AcceleratorTotalMemoryMiBRequest, ) -> Self
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Sourcepub fn set_accelerator_total_memory_mib(
self,
input: Option<AcceleratorTotalMemoryMiBRequest>,
) -> Self
pub fn set_accelerator_total_memory_mib( self, input: Option<AcceleratorTotalMemoryMiBRequest>, ) -> Self
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Sourcepub fn get_accelerator_total_memory_mib(
&self,
) -> &Option<AcceleratorTotalMemoryMiBRequest>
pub fn get_accelerator_total_memory_mib( &self, ) -> &Option<AcceleratorTotalMemoryMiBRequest>
The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
Sourcepub fn network_bandwidth_gbps(self, input: NetworkBandwidthGbpsRequest) -> Self
pub fn network_bandwidth_gbps(self, input: NetworkBandwidthGbpsRequest) -> Self
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
Sourcepub fn set_network_bandwidth_gbps(
self,
input: Option<NetworkBandwidthGbpsRequest>,
) -> Self
pub fn set_network_bandwidth_gbps( self, input: Option<NetworkBandwidthGbpsRequest>, ) -> Self
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
Sourcepub fn get_network_bandwidth_gbps(&self) -> &Option<NetworkBandwidthGbpsRequest>
pub fn get_network_bandwidth_gbps(&self) -> &Option<NetworkBandwidthGbpsRequest>
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
Sourcepub fn allowed_instance_types(self, input: impl Into<String>) -> Self
pub fn allowed_instance_types(self, input: impl Into<String>) -> Self
Appends an item to allowed_instance_types
.
To override the contents of this collection use set_allowed_instance_types
.
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
Sourcepub fn set_allowed_instance_types(self, input: Option<Vec<String>>) -> Self
pub fn set_allowed_instance_types(self, input: Option<Vec<String>>) -> Self
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
Sourcepub fn get_allowed_instance_types(&self) -> &Option<Vec<String>>
pub fn get_allowed_instance_types(&self) -> &Option<Vec<String>>
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
Sourcepub fn max_spot_price_as_percentage_of_optimal_on_demand_price(
self,
input: i32,
) -> Self
pub fn max_spot_price_as_percentage_of_optimal_on_demand_price( self, input: i32, ) -> Self
\[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
.
Sourcepub fn set_max_spot_price_as_percentage_of_optimal_on_demand_price(
self,
input: Option<i32>,
) -> Self
pub fn set_max_spot_price_as_percentage_of_optimal_on_demand_price( self, input: Option<i32>, ) -> Self
\[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
.
Sourcepub fn get_max_spot_price_as_percentage_of_optimal_on_demand_price(
&self,
) -> &Option<i32>
pub fn get_max_spot_price_as_percentage_of_optimal_on_demand_price( &self, ) -> &Option<i32>
\[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
.
Sourcepub fn baseline_performance_factors(
self,
input: BaselinePerformanceFactorsRequest,
) -> Self
pub fn baseline_performance_factors( self, input: BaselinePerformanceFactorsRequest, ) -> Self
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.
Sourcepub fn set_baseline_performance_factors(
self,
input: Option<BaselinePerformanceFactorsRequest>,
) -> Self
pub fn set_baseline_performance_factors( self, input: Option<BaselinePerformanceFactorsRequest>, ) -> Self
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.
Sourcepub fn get_baseline_performance_factors(
&self,
) -> &Option<BaselinePerformanceFactorsRequest>
pub fn get_baseline_performance_factors( &self, ) -> &Option<BaselinePerformanceFactorsRequest>
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.
Sourcepub fn build(self) -> InstanceRequirementsRequest
pub fn build(self) -> InstanceRequirementsRequest
Consumes the builder and constructs a InstanceRequirementsRequest
.
Trait Implementations§
Source§impl Clone for InstanceRequirementsRequestBuilder
impl Clone for InstanceRequirementsRequestBuilder
Source§fn clone(&self) -> InstanceRequirementsRequestBuilder
fn clone(&self) -> InstanceRequirementsRequestBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for InstanceRequirementsRequestBuilder
impl Default for InstanceRequirementsRequestBuilder
Source§fn default() -> InstanceRequirementsRequestBuilder
fn default() -> InstanceRequirementsRequestBuilder
Source§impl PartialEq for InstanceRequirementsRequestBuilder
impl PartialEq for InstanceRequirementsRequestBuilder
Source§fn eq(&self, other: &InstanceRequirementsRequestBuilder) -> bool
fn eq(&self, other: &InstanceRequirementsRequestBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for InstanceRequirementsRequestBuilder
Auto Trait Implementations§
impl Freeze for InstanceRequirementsRequestBuilder
impl RefUnwindSafe for InstanceRequirementsRequestBuilder
impl Send for InstanceRequirementsRequestBuilder
impl Sync for InstanceRequirementsRequestBuilder
impl Unpin for InstanceRequirementsRequestBuilder
impl UnwindSafe for InstanceRequirementsRequestBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);