aws_sdk_ec2/operation/purchase_host_reservation/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::purchase_host_reservation::_purchase_host_reservation_output::PurchaseHostReservationOutputBuilder;
3
4pub use crate::operation::purchase_host_reservation::_purchase_host_reservation_input::PurchaseHostReservationInputBuilder;
5
6impl crate::operation::purchase_host_reservation::builders::PurchaseHostReservationInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::purchase_host_reservation::PurchaseHostReservationOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::purchase_host_reservation::PurchaseHostReservationError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.purchase_host_reservation();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `PurchaseHostReservation`.
24///
25/// <p>Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct PurchaseHostReservationFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::purchase_host_reservation::builders::PurchaseHostReservationInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::purchase_host_reservation::PurchaseHostReservationOutput,
35        crate::operation::purchase_host_reservation::PurchaseHostReservationError,
36    > for PurchaseHostReservationFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::purchase_host_reservation::PurchaseHostReservationOutput,
44            crate::operation::purchase_host_reservation::PurchaseHostReservationError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl PurchaseHostReservationFluentBuilder {
51    /// Creates a new `PurchaseHostReservationFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the PurchaseHostReservation as a reference.
60    pub fn as_input(&self) -> &crate::operation::purchase_host_reservation::builders::PurchaseHostReservationInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::purchase_host_reservation::PurchaseHostReservationOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::purchase_host_reservation::PurchaseHostReservationError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::purchase_host_reservation::PurchaseHostReservation::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::purchase_host_reservation::PurchaseHostReservation::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::purchase_host_reservation::PurchaseHostReservationOutput,
97        crate::operation::purchase_host_reservation::PurchaseHostReservationError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <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">Ensuring Idempotency</a>.</p>
112    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.client_token(input.into());
114        self
115    }
116    /// <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">Ensuring Idempotency</a>.</p>
117    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_client_token(input);
119        self
120    }
121    /// <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">Ensuring Idempotency</a>.</p>
122    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_client_token()
124    }
125    /// <p>The currency in which the <code>totalUpfrontPrice</code>, <code>LimitPrice</code>, and <code>totalHourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
126    pub fn currency_code(mut self, input: crate::types::CurrencyCodeValues) -> Self {
127        self.inner = self.inner.currency_code(input);
128        self
129    }
130    /// <p>The currency in which the <code>totalUpfrontPrice</code>, <code>LimitPrice</code>, and <code>totalHourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
131    pub fn set_currency_code(mut self, input: ::std::option::Option<crate::types::CurrencyCodeValues>) -> Self {
132        self.inner = self.inner.set_currency_code(input);
133        self
134    }
135    /// <p>The currency in which the <code>totalUpfrontPrice</code>, <code>LimitPrice</code>, and <code>totalHourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
136    pub fn get_currency_code(&self) -> &::std::option::Option<crate::types::CurrencyCodeValues> {
137        self.inner.get_currency_code()
138    }
139    ///
140    /// Appends an item to `HostIdSet`.
141    ///
142    /// To override the contents of this collection use [`set_host_id_set`](Self::set_host_id_set).
143    ///
144    /// <p>The IDs of the Dedicated Hosts with which the reservation will be associated.</p>
145    pub fn host_id_set(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
146        self.inner = self.inner.host_id_set(input.into());
147        self
148    }
149    /// <p>The IDs of the Dedicated Hosts with which the reservation will be associated.</p>
150    pub fn set_host_id_set(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
151        self.inner = self.inner.set_host_id_set(input);
152        self
153    }
154    /// <p>The IDs of the Dedicated Hosts with which the reservation will be associated.</p>
155    pub fn get_host_id_set(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
156        self.inner.get_host_id_set()
157    }
158    /// <p>The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is <code>USD</code>. For example, to indicate a limit price of USD 100, specify 100.00.</p>
159    pub fn limit_price(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
160        self.inner = self.inner.limit_price(input.into());
161        self
162    }
163    /// <p>The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is <code>USD</code>. For example, to indicate a limit price of USD 100, specify 100.00.</p>
164    pub fn set_limit_price(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
165        self.inner = self.inner.set_limit_price(input);
166        self
167    }
168    /// <p>The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is <code>USD</code>. For example, to indicate a limit price of USD 100, specify 100.00.</p>
169    pub fn get_limit_price(&self) -> &::std::option::Option<::std::string::String> {
170        self.inner.get_limit_price()
171    }
172    /// <p>The ID of the offering.</p>
173    pub fn offering_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
174        self.inner = self.inner.offering_id(input.into());
175        self
176    }
177    /// <p>The ID of the offering.</p>
178    pub fn set_offering_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
179        self.inner = self.inner.set_offering_id(input);
180        self
181    }
182    /// <p>The ID of the offering.</p>
183    pub fn get_offering_id(&self) -> &::std::option::Option<::std::string::String> {
184        self.inner.get_offering_id()
185    }
186    ///
187    /// Appends an item to `TagSpecifications`.
188    ///
189    /// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
190    ///
191    /// <p>The tags to apply to the Dedicated Host Reservation during purchase.</p>
192    pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
193        self.inner = self.inner.tag_specifications(input);
194        self
195    }
196    /// <p>The tags to apply to the Dedicated Host Reservation during purchase.</p>
197    pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
198        self.inner = self.inner.set_tag_specifications(input);
199        self
200    }
201    /// <p>The tags to apply to the Dedicated Host Reservation during purchase.</p>
202    pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
203        self.inner.get_tag_specifications()
204    }
205}