aws-sdk-ec2 1.224.0

AWS SDK for Amazon Elastic Compute Cloud
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212

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

/// <p>Describes the result of the purchase.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Purchase {
    /// <p>The currency in which the <code>UpfrontPrice</code> and <code>HourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
    pub currency_code: ::std::option::Option<crate::types::CurrencyCodeValues>,
    /// <p>The duration of the reservation's term in seconds.</p>
    pub duration: ::std::option::Option<i32>,
    /// <p>The IDs of the Dedicated Hosts associated with the reservation.</p>
    pub host_id_set: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The ID of the reservation.</p>
    pub host_reservation_id: ::std::option::Option<::std::string::String>,
    /// <p>The hourly price of the reservation per hour.</p>
    pub hourly_price: ::std::option::Option<::std::string::String>,
    /// <p>The instance family on the Dedicated Host that the reservation can be associated with.</p>
    pub instance_family: ::std::option::Option<::std::string::String>,
    /// <p>The payment option for the reservation.</p>
    pub payment_option: ::std::option::Option<crate::types::PaymentOption>,
    /// <p>The upfront price of the reservation.</p>
    pub upfront_price: ::std::option::Option<::std::string::String>,
}
impl Purchase {
    /// <p>The currency in which the <code>UpfrontPrice</code> and <code>HourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
    pub fn currency_code(&self) -> ::std::option::Option<&crate::types::CurrencyCodeValues> {
        self.currency_code.as_ref()
    }
    /// <p>The duration of the reservation's term in seconds.</p>
    pub fn duration(&self) -> ::std::option::Option<i32> {
        self.duration
    }
    /// <p>The IDs of the Dedicated Hosts associated with the reservation.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.host_id_set.is_none()`.
    pub fn host_id_set(&self) -> &[::std::string::String] {
        self.host_id_set.as_deref().unwrap_or_default()
    }
    /// <p>The ID of the reservation.</p>
    pub fn host_reservation_id(&self) -> ::std::option::Option<&str> {
        self.host_reservation_id.as_deref()
    }
    /// <p>The hourly price of the reservation per hour.</p>
    pub fn hourly_price(&self) -> ::std::option::Option<&str> {
        self.hourly_price.as_deref()
    }
    /// <p>The instance family on the Dedicated Host that the reservation can be associated with.</p>
    pub fn instance_family(&self) -> ::std::option::Option<&str> {
        self.instance_family.as_deref()
    }
    /// <p>The payment option for the reservation.</p>
    pub fn payment_option(&self) -> ::std::option::Option<&crate::types::PaymentOption> {
        self.payment_option.as_ref()
    }
    /// <p>The upfront price of the reservation.</p>
    pub fn upfront_price(&self) -> ::std::option::Option<&str> {
        self.upfront_price.as_deref()
    }
}
impl Purchase {
    /// Creates a new builder-style object to manufacture [`Purchase`](crate::types::Purchase).
    pub fn builder() -> crate::types::builders::PurchaseBuilder {
        crate::types::builders::PurchaseBuilder::default()
    }
}

/// A builder for [`Purchase`](crate::types::Purchase).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct PurchaseBuilder {
    pub(crate) currency_code: ::std::option::Option<crate::types::CurrencyCodeValues>,
    pub(crate) duration: ::std::option::Option<i32>,
    pub(crate) host_id_set: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) host_reservation_id: ::std::option::Option<::std::string::String>,
    pub(crate) hourly_price: ::std::option::Option<::std::string::String>,
    pub(crate) instance_family: ::std::option::Option<::std::string::String>,
    pub(crate) payment_option: ::std::option::Option<crate::types::PaymentOption>,
    pub(crate) upfront_price: ::std::option::Option<::std::string::String>,
}
impl PurchaseBuilder {
    /// <p>The currency in which the <code>UpfrontPrice</code> and <code>HourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
    pub fn currency_code(mut self, input: crate::types::CurrencyCodeValues) -> Self {
        self.currency_code = ::std::option::Option::Some(input);
        self
    }
    /// <p>The currency in which the <code>UpfrontPrice</code> and <code>HourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
    pub fn set_currency_code(mut self, input: ::std::option::Option<crate::types::CurrencyCodeValues>) -> Self {
        self.currency_code = input;
        self
    }
    /// <p>The currency in which the <code>UpfrontPrice</code> and <code>HourlyPrice</code> amounts are specified. At this time, the only supported currency is <code>USD</code>.</p>
    pub fn get_currency_code(&self) -> &::std::option::Option<crate::types::CurrencyCodeValues> {
        &self.currency_code
    }
    /// <p>The duration of the reservation's term in seconds.</p>
    pub fn duration(mut self, input: i32) -> Self {
        self.duration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The duration of the reservation's term in seconds.</p>
    pub fn set_duration(mut self, input: ::std::option::Option<i32>) -> Self {
        self.duration = input;
        self
    }
    /// <p>The duration of the reservation's term in seconds.</p>
    pub fn get_duration(&self) -> &::std::option::Option<i32> {
        &self.duration
    }
    /// Appends an item to `host_id_set`.
    ///
    /// To override the contents of this collection use [`set_host_id_set`](Self::set_host_id_set).
    ///
    /// <p>The IDs of the Dedicated Hosts associated with the reservation.</p>
    pub fn host_id_set(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.host_id_set.unwrap_or_default();
        v.push(input.into());
        self.host_id_set = ::std::option::Option::Some(v);
        self
    }
    /// <p>The IDs of the Dedicated Hosts associated with the reservation.</p>
    pub fn set_host_id_set(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.host_id_set = input;
        self
    }
    /// <p>The IDs of the Dedicated Hosts associated with the reservation.</p>
    pub fn get_host_id_set(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.host_id_set
    }
    /// <p>The ID of the reservation.</p>
    pub fn host_reservation_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.host_reservation_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the reservation.</p>
    pub fn set_host_reservation_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.host_reservation_id = input;
        self
    }
    /// <p>The ID of the reservation.</p>
    pub fn get_host_reservation_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.host_reservation_id
    }
    /// <p>The hourly price of the reservation per hour.</p>
    pub fn hourly_price(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.hourly_price = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The hourly price of the reservation per hour.</p>
    pub fn set_hourly_price(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.hourly_price = input;
        self
    }
    /// <p>The hourly price of the reservation per hour.</p>
    pub fn get_hourly_price(&self) -> &::std::option::Option<::std::string::String> {
        &self.hourly_price
    }
    /// <p>The instance family on the Dedicated Host that the reservation can be associated with.</p>
    pub fn instance_family(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.instance_family = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The instance family on the Dedicated Host that the reservation can be associated with.</p>
    pub fn set_instance_family(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.instance_family = input;
        self
    }
    /// <p>The instance family on the Dedicated Host that the reservation can be associated with.</p>
    pub fn get_instance_family(&self) -> &::std::option::Option<::std::string::String> {
        &self.instance_family
    }
    /// <p>The payment option for the reservation.</p>
    pub fn payment_option(mut self, input: crate::types::PaymentOption) -> Self {
        self.payment_option = ::std::option::Option::Some(input);
        self
    }
    /// <p>The payment option for the reservation.</p>
    pub fn set_payment_option(mut self, input: ::std::option::Option<crate::types::PaymentOption>) -> Self {
        self.payment_option = input;
        self
    }
    /// <p>The payment option for the reservation.</p>
    pub fn get_payment_option(&self) -> &::std::option::Option<crate::types::PaymentOption> {
        &self.payment_option
    }
    /// <p>The upfront price of the reservation.</p>
    pub fn upfront_price(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.upfront_price = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The upfront price of the reservation.</p>
    pub fn set_upfront_price(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.upfront_price = input;
        self
    }
    /// <p>The upfront price of the reservation.</p>
    pub fn get_upfront_price(&self) -> &::std::option::Option<::std::string::String> {
        &self.upfront_price
    }
    /// Consumes the builder and constructs a [`Purchase`](crate::types::Purchase).
    pub fn build(self) -> crate::types::Purchase {
        crate::types::Purchase {
            currency_code: self.currency_code,
            duration: self.duration,
            host_id_set: self.host_id_set,
            host_reservation_id: self.host_reservation_id,
            hourly_price: self.hourly_price,
            instance_family: self.instance_family,
            payment_option: self.payment_option,
            upfront_price: self.upfront_price,
        }
    }
}