Struct aws_sdk_ec2::model::SpotFleetRequestConfigData

#[non_exhaustive]
pub struct SpotFleetRequestConfigData {

    pub allocation_strategy: Option<AllocationStrategy>,
    pub on_demand_allocation_strategy: Option<OnDemandAllocationStrategy>,
    pub spot_maintenance_strategies: Option<SpotMaintenanceStrategies>,
    pub client_token: Option<String>,
    pub excess_capacity_termination_policy: Option<ExcessCapacityTerminationPolicy>,
    pub fulfilled_capacity: Option<f64>,
    pub on_demand_fulfilled_capacity: Option<f64>,
    pub iam_fleet_role: Option<String>,
    pub launch_specifications: Option<Vec<SpotFleetLaunchSpecification>>,
    pub launch_template_configs: Option<Vec<LaunchTemplateConfig>>,
    pub spot_price: Option<String>,
    pub target_capacity: Option<i32>,
    pub on_demand_target_capacity: Option<i32>,
    pub on_demand_max_total_price: Option<String>,
    pub spot_max_total_price: Option<String>,
    pub terminate_instances_with_expiration: Option<bool>,
    pub type: Option<FleetType>,
    pub valid_from: Option<DateTime>,
    pub valid_until: Option<DateTime>,
    pub replace_unhealthy_instances: Option<bool>,
    pub instance_interruption_behavior: Option<InstanceInterruptionBehavior>,
    pub load_balancers_config: Option<LoadBalancersConfig>,
    pub instance_pools_to_use_count: Option<i32>,
    pub context: Option<String>,
    pub target_capacity_unit_type: Option<TargetCapacityUnitType>,
    pub tag_specifications: Option<Vec<TagSpecification>>,
}

Describes the configuration of a Spot Fleet request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

allocation_strategy: Option<AllocationStrategy>

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

on_demand_allocation_strategy: Option<OnDemandAllocationStrategy>

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

spot_maintenance_strategies: Option<SpotMaintenanceStrategies>

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

client_token: Option<String>

A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

excess_capacity_termination_policy: Option<ExcessCapacityTerminationPolicy>

Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.

fulfilled_capacity: Option<f64>

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

on_demand_fulfilled_capacity: Option<f64>

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

iam_fleet_role: Option<String>

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.

launch_specifications: Option<Vec<SpotFleetLaunchSpecification>>

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

launch_template_configs: Option<Vec<LaunchTemplateConfig>>

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

spot_price: Option<String>

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

target_capacity: Option<i32>

The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

on_demand_target_capacity: Option<i32>

The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

on_demand_max_total_price: Option<String>

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

spot_max_total_price: Option<String>

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

terminate_instances_with_expiration: Option<bool>

Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.

type: Option<FleetType>

The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.

valid_from: Option<DateTime>

The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.

valid_until: Option<DateTime>

The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.

replace_unhealthy_instances: Option<bool>

Indicates whether Spot Fleet should replace unhealthy instances.

instance_interruption_behavior: Option<InstanceInterruptionBehavior>

The behavior when a Spot Instance is interrupted. The default is terminate.

load_balancers_config: Option<LoadBalancersConfig>

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

instance_pools_to_use_count: Option<i32>

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

context: Option<String>

Reserved.

target_capacity_unit_type: Option<TargetCapacityUnitType>

The unit for the target capacity.

Default: units (translates to number of instances)

tag_specifications: Option<Vec<TagSpecification>>

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

Implementations

impl SpotFleetRequestConfigData

pub fn allocation_strategy(&self) -> Option<&AllocationStrategy>

Indicates how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet request.

If the allocation strategy is lowestPrice, Spot Fleet launches instances from the Spot Instance pools with the lowest price. This is the default allocation strategy.

If the allocation strategy is diversified, Spot Fleet launches instances from all the Spot Instance pools that you specify.

If the allocation strategy is capacityOptimized (recommended), Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.

pub fn on_demand_allocation_strategy(
    &self
) -> Option<&OnDemandAllocationStrategy>

The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.

pub fn spot_maintenance_strategies(&self) -> Option<&SpotMaintenanceStrategies>

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

pub fn client_token(&self) -> Option<&str>

A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.

pub fn excess_capacity_termination_policy(
    &self
) -> Option<&ExcessCapacityTerminationPolicy>

Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.

pub fn fulfilled_capacity(&self) -> Option<f64>

The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.

pub fn on_demand_fulfilled_capacity(&self) -> Option<f64>

The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.

pub fn iam_fleet_role(&self) -> Option<&str>

The Amazon Resource Name (ARN) of an Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.

pub fn launch_specifications(&self) -> Option<&[SpotFleetLaunchSpecification]>

The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

pub fn launch_template_configs(&self) -> Option<&[LaunchTemplateConfig]>

The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.

pub fn spot_price(&self) -> Option<&str>

The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.

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

The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

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

The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.

pub fn on_demand_max_total_price(&self) -> Option<&str>

The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

pub fn spot_max_total_price(&self) -> Option<&str>

The maximum amount per hour for Spot Instances that you're willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.

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

Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.

pub fn type(&self) -> Option<&FleetType>

The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.

pub fn valid_from(&self) -> Option<&DateTime>

The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.

pub fn valid_until(&self) -> Option<&DateTime>

The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.

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

Indicates whether Spot Fleet should replace unhealthy instances.

pub fn instance_interruption_behavior(
    &self
) -> Option<&InstanceInterruptionBehavior>

The behavior when a Spot Instance is interrupted. The default is terminate.

pub fn load_balancers_config(&self) -> Option<&LoadBalancersConfig>

One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.

With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.

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

The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.

Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.

pub fn context(&self) -> Option<&str>

Reserved.

pub fn target_capacity_unit_type(&self) -> Option<&TargetCapacityUnitType>

The unit for the target capacity.

Default: units (translates to number of instances)

pub fn tag_specifications(&self) -> Option<&[TagSpecification]>

The key-value pair for tagging the Spot Fleet request on creation. The value for ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.

impl SpotFleetRequestConfigData

pub fn builder() -> Builder

Creates a new builder-style object to manufacture SpotFleetRequestConfigData

Trait Implementations

impl Clone for SpotFleetRequestConfigData

fn clone(&self) -> SpotFleetRequestConfigData

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpotFleetRequestConfigData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<SpotFleetRequestConfigData> for SpotFleetRequestConfigData

fn eq(&self, other: &SpotFleetRequestConfigData) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SpotFleetRequestConfigData) -> bool

This method tests for !=.

impl StructuralPartialEq for SpotFleetRequestConfigData