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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateComponentInput {
/// <p>The name of the component.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The semantic version of the component. This version follows the semantic version syntax.</p><note>
/// <p>The semantic version has four nodes: <major>
/// .
/// <minor>
/// .
/// <patch>
/// /
/// <build>
/// . You can assign values for the first three, and can filter on all of them.
/// </build>
/// </patch>
/// </minor>
/// </major></p>
/// <p><b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p>
/// <p><b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p>
/// </note>
pub semantic_version: ::std::option::Option<::std::string::String>,
/// <p>Describes the contents of the component.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.</p>
pub change_description: ::std::option::Option<::std::string::String>,
/// <p>The operating system platform of the component.</p>
pub platform: ::std::option::Option<crate::types::Platform>,
/// <p>The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.</p>
pub supported_os_versions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
/// <p>Component <code>data</code> contains inline YAML document content for the component. Alternatively, you can specify the <code>uri</code> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</p>
pub data: ::std::option::Option<::std::string::String>,
/// <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL (<code>s3://bucket/key</code>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</p>
/// <p>Alternatively, you can specify the YAML document inline, using the component <code>data</code> property. You cannot specify both properties.</p>
pub uri: ::std::option::Option<::std::string::String>,
/// <p>The ID of the KMS key that is used to encrypt this component.</p>
pub kms_key_id: ::std::option::Option<::std::string::String>,
/// <p>The tags that apply to the component.</p>
pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
/// <p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>
pub client_token: ::std::option::Option<::std::string::String>,
}
impl CreateComponentInput {
/// <p>The name of the component.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The semantic version of the component. This version follows the semantic version syntax.</p><note>
/// <p>The semantic version has four nodes: <major>
/// .
/// <minor>
/// .
/// <patch>
/// /
/// <build>
/// . You can assign values for the first three, and can filter on all of them.
/// </build>
/// </patch>
/// </minor>
/// </major></p>
/// <p><b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p>
/// <p><b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p>
/// </note>
pub fn semantic_version(&self) -> ::std::option::Option<&str> {
self.semantic_version.as_deref()
}
/// <p>Describes the contents of the component.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.</p>
pub fn change_description(&self) -> ::std::option::Option<&str> {
self.change_description.as_deref()
}
/// <p>The operating system platform of the component.</p>
pub fn platform(&self) -> ::std::option::Option<&crate::types::Platform> {
self.platform.as_ref()
}
/// <p>The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.</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 `.supported_os_versions.is_none()`.
pub fn supported_os_versions(&self) -> &[::std::string::String] {
self.supported_os_versions.as_deref().unwrap_or_default()
}
/// <p>Component <code>data</code> contains inline YAML document content for the component. Alternatively, you can specify the <code>uri</code> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</p>
pub fn data(&self) -> ::std::option::Option<&str> {
self.data.as_deref()
}
/// <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL (<code>s3://bucket/key</code>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</p>
/// <p>Alternatively, you can specify the YAML document inline, using the component <code>data</code> property. You cannot specify both properties.</p>
pub fn uri(&self) -> ::std::option::Option<&str> {
self.uri.as_deref()
}
/// <p>The ID of the KMS key that is used to encrypt this component.</p>
pub fn kms_key_id(&self) -> ::std::option::Option<&str> {
self.kms_key_id.as_deref()
}
/// <p>The tags that apply to the component.</p>
pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
self.tags.as_ref()
}
/// <p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>
pub fn client_token(&self) -> ::std::option::Option<&str> {
self.client_token.as_deref()
}
}
impl CreateComponentInput {
/// Creates a new builder-style object to manufacture [`CreateComponentInput`](crate::operation::create_component::CreateComponentInput).
pub fn builder() -> crate::operation::create_component::builders::CreateComponentInputBuilder {
crate::operation::create_component::builders::CreateComponentInputBuilder::default()
}
}
/// A builder for [`CreateComponentInput`](crate::operation::create_component::CreateComponentInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct CreateComponentInputBuilder {
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) semantic_version: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) change_description: ::std::option::Option<::std::string::String>,
pub(crate) platform: ::std::option::Option<crate::types::Platform>,
pub(crate) supported_os_versions: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
pub(crate) data: ::std::option::Option<::std::string::String>,
pub(crate) uri: ::std::option::Option<::std::string::String>,
pub(crate) kms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl CreateComponentInputBuilder {
/// <p>The name of the component.</p>
/// This field is required.
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 component.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name of the component.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The semantic version of the component. This version follows the semantic version syntax.</p><note>
/// <p>The semantic version has four nodes: <major>
/// .
/// <minor>
/// .
/// <patch>
/// /
/// <build>
/// . You can assign values for the first three, and can filter on all of them.
/// </build>
/// </patch>
/// </minor>
/// </major></p>
/// <p><b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p>
/// <p><b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p>
/// </note>
/// This field is required.
pub fn semantic_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.semantic_version = ::std::option::Option::Some(input.into());
self
}
/// <p>The semantic version of the component. This version follows the semantic version syntax.</p><note>
/// <p>The semantic version has four nodes: <major>
/// .
/// <minor>
/// .
/// <patch>
/// /
/// <build>
/// . You can assign values for the first three, and can filter on all of them.
/// </build>
/// </patch>
/// </minor>
/// </major></p>
/// <p><b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p>
/// <p><b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p>
/// </note>
pub fn set_semantic_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.semantic_version = input;
self
}
/// <p>The semantic version of the component. This version follows the semantic version syntax.</p><note>
/// <p>The semantic version has four nodes: <major>
/// .
/// <minor>
/// .
/// <patch>
/// /
/// <build>
/// . You can assign values for the first three, and can filter on all of them.
/// </build>
/// </patch>
/// </minor>
/// </major></p>
/// <p><b>Assignment:</b> For the first three nodes you can assign any positive integer value, including zero, with an upper limit of 2^30-1, or 1073741823 for each node. Image Builder automatically assigns the build number to the fourth node.</p>
/// <p><b>Patterns:</b> You can use any numeric pattern that adheres to the assignment requirements for the nodes that you can assign. For example, you might choose a software version pattern, such as 1.0.0, or a date, such as 2021.01.01.</p>
/// </note>
pub fn get_semantic_version(&self) -> &::std::option::Option<::std::string::String> {
&self.semantic_version
}
/// <p>Describes the contents of the component.</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>Describes the contents of the component.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>Describes the contents of the component.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.</p>
pub fn change_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.change_description = ::std::option::Option::Some(input.into());
self
}
/// <p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.</p>
pub fn set_change_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.change_description = input;
self
}
/// <p>The change description of the component. Describes what change has been made in this version, or what makes this version different from other versions of the component.</p>
pub fn get_change_description(&self) -> &::std::option::Option<::std::string::String> {
&self.change_description
}
/// <p>The operating system platform of the component.</p>
/// This field is required.
pub fn platform(mut self, input: crate::types::Platform) -> Self {
self.platform = ::std::option::Option::Some(input);
self
}
/// <p>The operating system platform of the component.</p>
pub fn set_platform(mut self, input: ::std::option::Option<crate::types::Platform>) -> Self {
self.platform = input;
self
}
/// <p>The operating system platform of the component.</p>
pub fn get_platform(&self) -> &::std::option::Option<crate::types::Platform> {
&self.platform
}
/// Appends an item to `supported_os_versions`.
///
/// To override the contents of this collection use [`set_supported_os_versions`](Self::set_supported_os_versions).
///
/// <p>The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.</p>
pub fn supported_os_versions(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
let mut v = self.supported_os_versions.unwrap_or_default();
v.push(input.into());
self.supported_os_versions = ::std::option::Option::Some(v);
self
}
/// <p>The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.</p>
pub fn set_supported_os_versions(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
self.supported_os_versions = input;
self
}
/// <p>The operating system (OS) version supported by the component. If the OS information is available, a prefix match is performed against the base image OS version during image recipe creation.</p>
pub fn get_supported_os_versions(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
&self.supported_os_versions
}
/// <p>Component <code>data</code> contains inline YAML document content for the component. Alternatively, you can specify the <code>uri</code> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</p>
pub fn data(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.data = ::std::option::Option::Some(input.into());
self
}
/// <p>Component <code>data</code> contains inline YAML document content for the component. Alternatively, you can specify the <code>uri</code> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</p>
pub fn set_data(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.data = input;
self
}
/// <p>Component <code>data</code> contains inline YAML document content for the component. Alternatively, you can specify the <code>uri</code> of a YAML document file stored in Amazon S3. However, you cannot specify both properties.</p>
pub fn get_data(&self) -> &::std::option::Option<::std::string::String> {
&self.data
}
/// <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL (<code>s3://bucket/key</code>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</p>
/// <p>Alternatively, you can specify the YAML document inline, using the component <code>data</code> property. You cannot specify both properties.</p>
pub fn uri(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.uri = ::std::option::Option::Some(input.into());
self
}
/// <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL (<code>s3://bucket/key</code>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</p>
/// <p>Alternatively, you can specify the YAML document inline, using the component <code>data</code> property. You cannot specify both properties.</p>
pub fn set_uri(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.uri = input;
self
}
/// <p>The <code>uri</code> of a YAML component document file. This must be an S3 URL (<code>s3://bucket/key</code>), and the requester must have permission to access the S3 bucket it points to. If you use Amazon S3, you can specify component content up to your service quota.</p>
/// <p>Alternatively, you can specify the YAML document inline, using the component <code>data</code> property. You cannot specify both properties.</p>
pub fn get_uri(&self) -> &::std::option::Option<::std::string::String> {
&self.uri
}
/// <p>The ID of the KMS key that is used to encrypt this component.</p>
pub fn kms_key_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.kms_key_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the KMS key that is used to encrypt this component.</p>
pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.kms_key_id = input;
self
}
/// <p>The ID of the KMS key that is used to encrypt this component.</p>
pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.kms_key_id
}
/// Adds a key-value pair to `tags`.
///
/// To override the contents of this collection use [`set_tags`](Self::set_tags).
///
/// <p>The tags that apply to the component.</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 tags that apply to the component.</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 tags that apply to the component.</p>
pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
&self.tags
}
/// <p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>
/// This field is required.
pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.client_token = ::std::option::Option::Some(input.into());
self
}
/// <p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>
pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_token = input;
self
}
/// <p>Unique, case-sensitive identifier you provide to ensure 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> in the <i>Amazon EC2 API Reference</i>.</p>
pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_token
}
/// Consumes the builder and constructs a [`CreateComponentInput`](crate::operation::create_component::CreateComponentInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_component::CreateComponentInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_component::CreateComponentInput {
name: self.name,
semantic_version: self.semantic_version,
description: self.description,
change_description: self.change_description,
platform: self.platform,
supported_os_versions: self.supported_os_versions,
data: self.data,
uri: self.uri,
kms_key_id: self.kms_key_id,
tags: self.tags,
client_token: self.client_token,
})
}
}