aws_sdk_ec2/types/

_on_demand_options.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Describes the configuration of On-Demand Instances in an EC2 Fleet.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct OnDemandOptions {
    /// <p>The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.</p>
    /// <p><code>lowest-price</code> - EC2 Fleet uses price to determine the order, launching the lowest price first.</p>
    /// <p><code>prioritized</code> - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.</p>
    /// <p>Default: <code>lowest-price</code></p>
    pub allocation_strategy: ::std::option::Option<crate::types::FleetOnDemandAllocationStrategy>,
    /// <p>The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub capacity_reservation_options: ::std::option::Option<crate::types::CapacityReservationOptions>,
    /// <p>Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub single_instance_type: ::std::option::Option<bool>,
    /// <p>Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub single_availability_zone: ::std::option::Option<bool>,
    /// <p>The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.</p>
    /// <p>Constraints: Maximum value of <code>1000</code>. Supported only for fleets of type <code>instant</code>.</p>
    /// <p>At least one of the following must be specified: <code>SingleAvailabilityZone</code> | <code>SingleInstanceType</code></p>
    pub min_target_capacity: ::std::option::Option<i32>,
    /// <p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p><note>
    /// <p>If your fleet includes T instances that are configured as <code>unlimited</code>, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>maxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>maxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>Amazon EC2 User Guide</i>.</p>
    /// </note>
    pub max_total_price: ::std::option::Option<::std::string::String>,
}
impl OnDemandOptions {
    /// <p>The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.</p>
    /// <p><code>lowest-price</code> - EC2 Fleet uses price to determine the order, launching the lowest price first.</p>
    /// <p><code>prioritized</code> - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.</p>
    /// <p>Default: <code>lowest-price</code></p>
    pub fn allocation_strategy(&self) -> ::std::option::Option<&crate::types::FleetOnDemandAllocationStrategy> {
        self.allocation_strategy.as_ref()
    }
    /// <p>The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn capacity_reservation_options(&self) -> ::std::option::Option<&crate::types::CapacityReservationOptions> {
        self.capacity_reservation_options.as_ref()
    }
    /// <p>Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn single_instance_type(&self) -> ::std::option::Option<bool> {
        self.single_instance_type
    }
    /// <p>Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn single_availability_zone(&self) -> ::std::option::Option<bool> {
        self.single_availability_zone
    }
    /// <p>The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.</p>
    /// <p>Constraints: Maximum value of <code>1000</code>. Supported only for fleets of type <code>instant</code>.</p>
    /// <p>At least one of the following must be specified: <code>SingleAvailabilityZone</code> | <code>SingleInstanceType</code></p>
    pub fn min_target_capacity(&self) -> ::std::option::Option<i32> {
        self.min_target_capacity
    }
    /// <p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p><note>
    /// <p>If your fleet includes T instances that are configured as <code>unlimited</code>, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>maxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>maxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>Amazon EC2 User Guide</i>.</p>
    /// </note>
    pub fn max_total_price(&self) -> ::std::option::Option<&str> {
        self.max_total_price.as_deref()
    }
}
impl OnDemandOptions {
    /// Creates a new builder-style object to manufacture [`OnDemandOptions`](crate::types::OnDemandOptions).
    pub fn builder() -> crate::types::builders::OnDemandOptionsBuilder {
        crate::types::builders::OnDemandOptionsBuilder::default()
    }
}

/// A builder for [`OnDemandOptions`](crate::types::OnDemandOptions).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct OnDemandOptionsBuilder {
    pub(crate) allocation_strategy: ::std::option::Option<crate::types::FleetOnDemandAllocationStrategy>,
    pub(crate) capacity_reservation_options: ::std::option::Option<crate::types::CapacityReservationOptions>,
    pub(crate) single_instance_type: ::std::option::Option<bool>,
    pub(crate) single_availability_zone: ::std::option::Option<bool>,
    pub(crate) min_target_capacity: ::std::option::Option<i32>,
    pub(crate) max_total_price: ::std::option::Option<::std::string::String>,
}
impl OnDemandOptionsBuilder {
    /// <p>The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.</p>
    /// <p><code>lowest-price</code> - EC2 Fleet uses price to determine the order, launching the lowest price first.</p>
    /// <p><code>prioritized</code> - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.</p>
    /// <p>Default: <code>lowest-price</code></p>
    pub fn allocation_strategy(mut self, input: crate::types::FleetOnDemandAllocationStrategy) -> Self {
        self.allocation_strategy = ::std::option::Option::Some(input);
        self
    }
    /// <p>The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.</p>
    /// <p><code>lowest-price</code> - EC2 Fleet uses price to determine the order, launching the lowest price first.</p>
    /// <p><code>prioritized</code> - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.</p>
    /// <p>Default: <code>lowest-price</code></p>
    pub fn set_allocation_strategy(mut self, input: ::std::option::Option<crate::types::FleetOnDemandAllocationStrategy>) -> Self {
        self.allocation_strategy = input;
        self
    }
    /// <p>The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.</p>
    /// <p><code>lowest-price</code> - EC2 Fleet uses price to determine the order, launching the lowest price first.</p>
    /// <p><code>prioritized</code> - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.</p>
    /// <p>Default: <code>lowest-price</code></p>
    pub fn get_allocation_strategy(&self) -> &::std::option::Option<crate::types::FleetOnDemandAllocationStrategy> {
        &self.allocation_strategy
    }
    /// <p>The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn capacity_reservation_options(mut self, input: crate::types::CapacityReservationOptions) -> Self {
        self.capacity_reservation_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn set_capacity_reservation_options(mut self, input: ::std::option::Option<crate::types::CapacityReservationOptions>) -> Self {
        self.capacity_reservation_options = input;
        self
    }
    /// <p>The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn get_capacity_reservation_options(&self) -> &::std::option::Option<crate::types::CapacityReservationOptions> {
        &self.capacity_reservation_options
    }
    /// <p>Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn single_instance_type(mut self, input: bool) -> Self {
        self.single_instance_type = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn set_single_instance_type(mut self, input: ::std::option::Option<bool>) -> Self {
        self.single_instance_type = input;
        self
    }
    /// <p>Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn get_single_instance_type(&self) -> &::std::option::Option<bool> {
        &self.single_instance_type
    }
    /// <p>Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn single_availability_zone(mut self, input: bool) -> Self {
        self.single_availability_zone = ::std::option::Option::Some(input);
        self
    }
    /// <p>Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn set_single_availability_zone(mut self, input: ::std::option::Option<bool>) -> Self {
        self.single_availability_zone = input;
        self
    }
    /// <p>Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.</p>
    /// <p>Supported only for fleets of type <code>instant</code>.</p>
    pub fn get_single_availability_zone(&self) -> &::std::option::Option<bool> {
        &self.single_availability_zone
    }
    /// <p>The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.</p>
    /// <p>Constraints: Maximum value of <code>1000</code>. Supported only for fleets of type <code>instant</code>.</p>
    /// <p>At least one of the following must be specified: <code>SingleAvailabilityZone</code> | <code>SingleInstanceType</code></p>
    pub fn min_target_capacity(mut self, input: i32) -> Self {
        self.min_target_capacity = ::std::option::Option::Some(input);
        self
    }
    /// <p>The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.</p>
    /// <p>Constraints: Maximum value of <code>1000</code>. Supported only for fleets of type <code>instant</code>.</p>
    /// <p>At least one of the following must be specified: <code>SingleAvailabilityZone</code> | <code>SingleInstanceType</code></p>
    pub fn set_min_target_capacity(mut self, input: ::std::option::Option<i32>) -> Self {
        self.min_target_capacity = input;
        self
    }
    /// <p>The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.</p>
    /// <p>Constraints: Maximum value of <code>1000</code>. Supported only for fleets of type <code>instant</code>.</p>
    /// <p>At least one of the following must be specified: <code>SingleAvailabilityZone</code> | <code>SingleInstanceType</code></p>
    pub fn get_min_target_capacity(&self) -> &::std::option::Option<i32> {
        &self.min_target_capacity
    }
    /// <p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p><note>
    /// <p>If your fleet includes T instances that are configured as <code>unlimited</code>, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>maxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>maxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>Amazon EC2 User Guide</i>.</p>
    /// </note>
    pub fn max_total_price(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.max_total_price = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p><note>
    /// <p>If your fleet includes T instances that are configured as <code>unlimited</code>, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>maxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>maxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>Amazon EC2 User Guide</i>.</p>
    /// </note>
    pub fn set_max_total_price(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.max_total_price = input;
        self
    }
    /// <p>The maximum amount per hour for On-Demand Instances that you're willing to pay.</p><note>
    /// <p>If your fleet includes T instances that are configured as <code>unlimited</code>, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The <code>maxTotalPrice</code> does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for <code>maxTotalPrice</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits">Surplus credits can incur charges</a> in the <i>Amazon EC2 User Guide</i>.</p>
    /// </note>
    pub fn get_max_total_price(&self) -> &::std::option::Option<::std::string::String> {
        &self.max_total_price
    }
    /// Consumes the builder and constructs a [`OnDemandOptions`](crate::types::OnDemandOptions).
    pub fn build(self) -> crate::types::OnDemandOptions {
        crate::types::OnDemandOptions {
            allocation_strategy: self.allocation_strategy,
            capacity_reservation_options: self.capacity_reservation_options,
            single_instance_type: self.single_instance_type,
            single_availability_zone: self.single_availability_zone,
            min_target_capacity: self.min_target_capacity,
            max_total_price: self.max_total_price,
        }
    }
}