aws-sdk-outposts 1.106.0

AWS SDK for AWS Outposts
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

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

/// <p>Information about a site.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct Site {
    /// <p>The ID of the site.</p>
    pub site_id: ::std::option::Option<::std::string::String>,
    /// <p>The ID of the Amazon Web Services account.</p>
    pub account_id: ::std::option::Option<::std::string::String>,
    /// <p>The name of the site.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The description of the site.</p>
    pub description: ::std::option::Option<::std::string::String>,
    /// <p>The site tags.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The Amazon Resource Name (ARN) of the site.</p>
    pub site_arn: ::std::option::Option<::std::string::String>,
    /// <p>Notes about a site.</p>
    pub notes: ::std::option::Option<::std::string::String>,
    /// <p>The ISO-3166 two-letter country code where the hardware is installed and powered on.</p>
    pub operating_address_country_code: ::std::option::Option<::std::string::String>,
    /// <p>State or region where the hardware is installed and powered on.</p>
    pub operating_address_state_or_region: ::std::option::Option<::std::string::String>,
    /// <p>City where the hardware is installed and powered on.</p>
    pub operating_address_city: ::std::option::Option<::std::string::String>,
    /// <p>Information about the physical and logistical details for a rack at the site.</p>
    pub rack_physical_properties: ::std::option::Option<crate::types::RackPhysicalProperties>,
}
impl Site {
    /// <p>The ID of the site.</p>
    pub fn site_id(&self) -> ::std::option::Option<&str> {
        self.site_id.as_deref()
    }
    /// <p>The ID of the Amazon Web Services account.</p>
    pub fn account_id(&self) -> ::std::option::Option<&str> {
        self.account_id.as_deref()
    }
    /// <p>The name of the site.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The description of the site.</p>
    pub fn description(&self) -> ::std::option::Option<&str> {
        self.description.as_deref()
    }
    /// <p>The site tags.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the site.</p>
    pub fn site_arn(&self) -> ::std::option::Option<&str> {
        self.site_arn.as_deref()
    }
    /// <p>Notes about a site.</p>
    pub fn notes(&self) -> ::std::option::Option<&str> {
        self.notes.as_deref()
    }
    /// <p>The ISO-3166 two-letter country code where the hardware is installed and powered on.</p>
    pub fn operating_address_country_code(&self) -> ::std::option::Option<&str> {
        self.operating_address_country_code.as_deref()
    }
    /// <p>State or region where the hardware is installed and powered on.</p>
    pub fn operating_address_state_or_region(&self) -> ::std::option::Option<&str> {
        self.operating_address_state_or_region.as_deref()
    }
    /// <p>City where the hardware is installed and powered on.</p>
    pub fn operating_address_city(&self) -> ::std::option::Option<&str> {
        self.operating_address_city.as_deref()
    }
    /// <p>Information about the physical and logistical details for a rack at the site.</p>
    pub fn rack_physical_properties(&self) -> ::std::option::Option<&crate::types::RackPhysicalProperties> {
        self.rack_physical_properties.as_ref()
    }
}
impl Site {
    /// Creates a new builder-style object to manufacture [`Site`](crate::types::Site).
    pub fn builder() -> crate::types::builders::SiteBuilder {
        crate::types::builders::SiteBuilder::default()
    }
}

/// A builder for [`Site`](crate::types::Site).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct SiteBuilder {
    pub(crate) site_id: ::std::option::Option<::std::string::String>,
    pub(crate) account_id: ::std::option::Option<::std::string::String>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) description: ::std::option::Option<::std::string::String>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) site_arn: ::std::option::Option<::std::string::String>,
    pub(crate) notes: ::std::option::Option<::std::string::String>,
    pub(crate) operating_address_country_code: ::std::option::Option<::std::string::String>,
    pub(crate) operating_address_state_or_region: ::std::option::Option<::std::string::String>,
    pub(crate) operating_address_city: ::std::option::Option<::std::string::String>,
    pub(crate) rack_physical_properties: ::std::option::Option<crate::types::RackPhysicalProperties>,
}
impl SiteBuilder {
    /// <p>The ID of the site.</p>
    pub fn site_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.site_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the site.</p>
    pub fn set_site_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.site_id = input;
        self
    }
    /// <p>The ID of the site.</p>
    pub fn get_site_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.site_id
    }
    /// <p>The ID of the Amazon Web Services account.</p>
    pub fn account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.account_id = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ID of the Amazon Web Services account.</p>
    pub fn set_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.account_id = input;
        self
    }
    /// <p>The ID of the Amazon Web Services account.</p>
    pub fn get_account_id(&self) -> &::std::option::Option<::std::string::String> {
        &self.account_id
    }
    /// <p>The name of the site.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the site.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name of the site.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The description of the site.</p>
    pub fn description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.description = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The description of the site.</p>
    pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.description = input;
        self
    }
    /// <p>The description of the site.</p>
    pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
        &self.description
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>The site tags.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The site tags.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>The site tags.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// <p>The Amazon Resource Name (ARN) of the site.</p>
    pub fn site_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.site_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the site.</p>
    pub fn set_site_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.site_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the site.</p>
    pub fn get_site_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.site_arn
    }
    /// <p>Notes about a site.</p>
    pub fn notes(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.notes = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Notes about a site.</p>
    pub fn set_notes(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.notes = input;
        self
    }
    /// <p>Notes about a site.</p>
    pub fn get_notes(&self) -> &::std::option::Option<::std::string::String> {
        &self.notes
    }
    /// <p>The ISO-3166 two-letter country code where the hardware is installed and powered on.</p>
    pub fn operating_address_country_code(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.operating_address_country_code = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The ISO-3166 two-letter country code where the hardware is installed and powered on.</p>
    pub fn set_operating_address_country_code(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.operating_address_country_code = input;
        self
    }
    /// <p>The ISO-3166 two-letter country code where the hardware is installed and powered on.</p>
    pub fn get_operating_address_country_code(&self) -> &::std::option::Option<::std::string::String> {
        &self.operating_address_country_code
    }
    /// <p>State or region where the hardware is installed and powered on.</p>
    pub fn operating_address_state_or_region(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.operating_address_state_or_region = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>State or region where the hardware is installed and powered on.</p>
    pub fn set_operating_address_state_or_region(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.operating_address_state_or_region = input;
        self
    }
    /// <p>State or region where the hardware is installed and powered on.</p>
    pub fn get_operating_address_state_or_region(&self) -> &::std::option::Option<::std::string::String> {
        &self.operating_address_state_or_region
    }
    /// <p>City where the hardware is installed and powered on.</p>
    pub fn operating_address_city(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.operating_address_city = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>City where the hardware is installed and powered on.</p>
    pub fn set_operating_address_city(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.operating_address_city = input;
        self
    }
    /// <p>City where the hardware is installed and powered on.</p>
    pub fn get_operating_address_city(&self) -> &::std::option::Option<::std::string::String> {
        &self.operating_address_city
    }
    /// <p>Information about the physical and logistical details for a rack at the site.</p>
    pub fn rack_physical_properties(mut self, input: crate::types::RackPhysicalProperties) -> Self {
        self.rack_physical_properties = ::std::option::Option::Some(input);
        self
    }
    /// <p>Information about the physical and logistical details for a rack at the site.</p>
    pub fn set_rack_physical_properties(mut self, input: ::std::option::Option<crate::types::RackPhysicalProperties>) -> Self {
        self.rack_physical_properties = input;
        self
    }
    /// <p>Information about the physical and logistical details for a rack at the site.</p>
    pub fn get_rack_physical_properties(&self) -> &::std::option::Option<crate::types::RackPhysicalProperties> {
        &self.rack_physical_properties
    }
    /// Consumes the builder and constructs a [`Site`](crate::types::Site).
    pub fn build(self) -> crate::types::Site {
        crate::types::Site {
            site_id: self.site_id,
            account_id: self.account_id,
            name: self.name,
            description: self.description,
            tags: self.tags,
            site_arn: self.site_arn,
            notes: self.notes,
            operating_address_country_code: self.operating_address_country_code,
            operating_address_state_or_region: self.operating_address_state_or_region,
            operating_address_city: self.operating_address_city,
            rack_physical_properties: self.rack_physical_properties,
        }
    }
}