aws_sdk_ec2/client/

create_capacity_reservation_fleet.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateCapacityReservationFleet`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`allocation_strategy(impl Into<String>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::allocation_strategy) / [`set_allocation_strategy(Option<String>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_allocation_strategy):<br>required: **false**<br><p>The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the <code>prioritized</code> allocation strategy is supported. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy"> Allocation strategy</a> in the <i>Amazon EC2 User Guide</i>.</p> <p>Valid values: <code>prioritized</code></p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_client_token):<br>required: **false**<br><p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html">Ensure Idempotency</a>.</p><br>
    ///   - [`instance_type_specifications(ReservationFleetInstanceSpecification)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::instance_type_specifications) / [`set_instance_type_specifications(Option<Vec::<ReservationFleetInstanceSpecification>>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_instance_type_specifications):<br>required: **true**<br><p>Information about the instance types for which to reserve the capacity.</p><br>
    ///   - [`tenancy(FleetCapacityReservationTenancy)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::tenancy) / [`set_tenancy(Option<FleetCapacityReservationTenancy>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_tenancy):<br>required: **false**<br><p>Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings:</p> <ul>  <li>   <p><code>default</code> - The Capacity Reservation Fleet is created on hardware that is shared with other Amazon Web Services accounts.</p></li>  <li>   <p><code>dedicated</code> - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single Amazon Web Services account.</p></li> </ul><br>
    ///   - [`total_target_capacity(i32)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::total_target_capacity) / [`set_total_target_capacity(Option<i32>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_total_target_capacity):<br>required: **true**<br><p>The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity">Total target capacity</a> in the <i>Amazon EC2 User Guide</i>.</p><br>
    ///   - [`end_date(DateTime)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::end_date) / [`set_end_date(Option<DateTime>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_end_date):<br>required: **false**<br><p>The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to <code>expired</code> and all of the Capacity Reservations in the Fleet expire.</p> <p>The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify <code>5/31/2019</code>, <code>13:30:55</code>, the Capacity Reservation Fleet is guaranteed to expire between <code>13:30:55</code> and <code>14:30:55</code> on <code>5/31/2019</code>.</p><br>
    ///   - [`instance_match_criteria(FleetInstanceMatchCriteria)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::instance_match_criteria) / [`set_instance_match_criteria(Option<FleetInstanceMatchCriteria>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_instance_match_criteria):<br>required: **false**<br><p>Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria.</p> <p>Currently, Capacity Reservation Fleets support <code>open</code> instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity.</p><br>
    ///   - [`tag_specifications(TagSpecification)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::tag_specifications) / [`set_tag_specifications(Option<Vec::<TagSpecification>>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_tag_specifications):<br>required: **false**<br><p>The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
    /// - On success, responds with [`CreateCapacityReservationFleetOutput`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput) with field(s):
    ///   - [`capacity_reservation_fleet_id(Option<String>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::capacity_reservation_fleet_id): <p>The ID of the Capacity Reservation Fleet.</p>
    ///   - [`state(Option<CapacityReservationFleetState>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::state): <p>The status of the Capacity Reservation Fleet.</p>
    ///   - [`total_target_capacity(Option<i32>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::total_target_capacity): <p>The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.</p>
    ///   - [`total_fulfilled_capacity(Option<f64>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::total_fulfilled_capacity): <p>The requested capacity units that have been successfully reserved.</p>
    ///   - [`instance_match_criteria(Option<FleetInstanceMatchCriteria>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::instance_match_criteria): <p>The instance matching criteria for the Capacity Reservation Fleet.</p>
    ///   - [`allocation_strategy(Option<String>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::allocation_strategy): <p>The allocation strategy used by the Capacity Reservation Fleet.</p>
    ///   - [`create_time(Option<DateTime>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::create_time): <p>The date and time at which the Capacity Reservation Fleet was created.</p>
    ///   - [`end_date(Option<DateTime>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::end_date): <p>The date and time at which the Capacity Reservation Fleet expires.</p>
    ///   - [`tenancy(Option<FleetCapacityReservationTenancy>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::tenancy): <p>Indicates the tenancy of Capacity Reservation Fleet.</p>
    ///   - [`fleet_capacity_reservations(Option<Vec::<FleetCapacityReservation>>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::fleet_capacity_reservations): <p>Information about the individual Capacity Reservations in the Capacity Reservation Fleet.</p>
    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetOutput::tags): <p>The tags assigned to the Capacity Reservation Fleet.</p>
    /// - On failure, responds with [`SdkError<CreateCapacityReservationFleetError>`](crate::operation::create_capacity_reservation_fleet::CreateCapacityReservationFleetError)
    pub fn create_capacity_reservation_fleet(
        &self,
    ) -> crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder {
        crate::operation::create_capacity_reservation_fleet::builders::CreateCapacityReservationFleetFluentBuilder::new(self.handle.clone())
    }
}