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
// 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 ImportSnapshotInput {
/// <p>The client-specific data.</p>
pub client_data: ::std::option::Option<crate::types::ClientData>,
/// <p>Token to enable idempotency for VM import requests.</p>
pub client_token: ::std::option::Option<::std::string::String>,
/// <p>The description string for the import snapshot task.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>Information about the disk container.</p>
pub disk_container: ::std::option::Option<crate::types::SnapshotDiskContainer>,
/// <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>
pub dry_run: ::std::option::Option<bool>,
/// <p>Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub encrypted: ::std::option::Option<bool>,
/// <p>An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</p>
/// <p>The KMS key identifier may be provided in any of the following formats:</p>
/// <ul>
/// <li>
/// <p>Key ID</p></li>
/// <li>
/// <p>Key alias</p></li>
/// <li>
/// <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p></li>
/// <li>
/// <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p></li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.</p>
/// <p>The specified KMS key must exist in the Region that the snapshot is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</p>
pub kms_key_id: ::std::option::Option<::std::string::String>,
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub role_name: ::std::option::Option<::std::string::String>,
/// <p>The tags to apply to the import snapshot task during creation.</p>
pub tag_specifications: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>,
}
impl ImportSnapshotInput {
/// <p>The client-specific data.</p>
pub fn client_data(&self) -> ::std::option::Option<&crate::types::ClientData> {
self.client_data.as_ref()
}
/// <p>Token to enable idempotency for VM import requests.</p>
pub fn client_token(&self) -> ::std::option::Option<&str> {
self.client_token.as_deref()
}
/// <p>The description string for the import snapshot task.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>Information about the disk container.</p>
pub fn disk_container(&self) -> ::std::option::Option<&crate::types::SnapshotDiskContainer> {
self.disk_container.as_ref()
}
/// <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>
pub fn dry_run(&self) -> ::std::option::Option<bool> {
self.dry_run
}
/// <p>Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn encrypted(&self) -> ::std::option::Option<bool> {
self.encrypted
}
/// <p>An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</p>
/// <p>The KMS key identifier may be provided in any of the following formats:</p>
/// <ul>
/// <li>
/// <p>Key ID</p></li>
/// <li>
/// <p>Key alias</p></li>
/// <li>
/// <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p></li>
/// <li>
/// <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p></li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.</p>
/// <p>The specified KMS key must exist in the Region that the snapshot is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</p>
pub fn kms_key_id(&self) -> ::std::option::Option<&str> {
self.kms_key_id.as_deref()
}
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub fn role_name(&self) -> ::std::option::Option<&str> {
self.role_name.as_deref()
}
/// <p>The tags to apply to the import snapshot task during 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 `.tag_specifications.is_none()`.
pub fn tag_specifications(&self) -> &[crate::types::TagSpecification] {
self.tag_specifications.as_deref().unwrap_or_default()
}
}
impl ImportSnapshotInput {
/// Creates a new builder-style object to manufacture [`ImportSnapshotInput`](crate::operation::import_snapshot::ImportSnapshotInput).
pub fn builder() -> crate::operation::import_snapshot::builders::ImportSnapshotInputBuilder {
crate::operation::import_snapshot::builders::ImportSnapshotInputBuilder::default()
}
}
/// A builder for [`ImportSnapshotInput`](crate::operation::import_snapshot::ImportSnapshotInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct ImportSnapshotInputBuilder {
pub(crate) client_data: ::std::option::Option<crate::types::ClientData>,
pub(crate) client_token: ::std::option::Option<::std::string::String>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) disk_container: ::std::option::Option<crate::types::SnapshotDiskContainer>,
pub(crate) dry_run: ::std::option::Option<bool>,
pub(crate) encrypted: ::std::option::Option<bool>,
pub(crate) kms_key_id: ::std::option::Option<::std::string::String>,
pub(crate) role_name: ::std::option::Option<::std::string::String>,
pub(crate) tag_specifications: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>,
}
impl ImportSnapshotInputBuilder {
/// <p>The client-specific data.</p>
pub fn client_data(mut self, input: crate::types::ClientData) -> Self {
self.client_data = ::std::option::Option::Some(input);
self
}
/// <p>The client-specific data.</p>
pub fn set_client_data(mut self, input: ::std::option::Option<crate::types::ClientData>) -> Self {
self.client_data = input;
self
}
/// <p>The client-specific data.</p>
pub fn get_client_data(&self) -> &::std::option::Option<crate::types::ClientData> {
&self.client_data
}
/// <p>Token to enable idempotency for VM import requests.</p>
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>Token to enable idempotency for VM import requests.</p>
pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.client_token = input;
self
}
/// <p>Token to enable idempotency for VM import requests.</p>
pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
&self.client_token
}
/// <p>The description string for the import snapshot task.</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 string for the import snapshot task.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>The description string for the import snapshot task.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>Information about the disk container.</p>
pub fn disk_container(mut self, input: crate::types::SnapshotDiskContainer) -> Self {
self.disk_container = ::std::option::Option::Some(input);
self
}
/// <p>Information about the disk container.</p>
pub fn set_disk_container(mut self, input: ::std::option::Option<crate::types::SnapshotDiskContainer>) -> Self {
self.disk_container = input;
self
}
/// <p>Information about the disk container.</p>
pub fn get_disk_container(&self) -> &::std::option::Option<crate::types::SnapshotDiskContainer> {
&self.disk_container
}
/// <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>
pub fn dry_run(mut self, input: bool) -> Self {
self.dry_run = ::std::option::Option::Some(input);
self
}
/// <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>
pub fn set_dry_run(mut self, input: ::std::option::Option<bool>) -> Self {
self.dry_run = input;
self
}
/// <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>
pub fn get_dry_run(&self) -> &::std::option::Option<bool> {
&self.dry_run
}
/// <p>Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn encrypted(mut self, input: bool) -> Self {
self.encrypted = ::std::option::Option::Some(input);
self
}
/// <p>Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn set_encrypted(mut self, input: ::std::option::Option<bool>) -> Self {
self.encrypted = input;
self
}
/// <p>Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using <code>KmsKeyId</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html">Amazon EBS Encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
pub fn get_encrypted(&self) -> &::std::option::Option<bool> {
&self.encrypted
}
/// <p>An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</p>
/// <p>The KMS key identifier may be provided in any of the following formats:</p>
/// <ul>
/// <li>
/// <p>Key ID</p></li>
/// <li>
/// <p>Key alias</p></li>
/// <li>
/// <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p></li>
/// <li>
/// <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p></li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.</p>
/// <p>The specified KMS key must exist in the Region that the snapshot is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</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>An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</p>
/// <p>The KMS key identifier may be provided in any of the following formats:</p>
/// <ul>
/// <li>
/// <p>Key ID</p></li>
/// <li>
/// <p>Key alias</p></li>
/// <li>
/// <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p></li>
/// <li>
/// <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p></li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.</p>
/// <p>The specified KMS key must exist in the Region that the snapshot is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</p>
pub fn set_kms_key_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.kms_key_id = input;
self
}
/// <p>An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a <code>KmsKeyId</code> is specified, the <code>Encrypted</code> flag must also be set.</p>
/// <p>The KMS key identifier may be provided in any of the following formats:</p>
/// <ul>
/// <li>
/// <p>Key ID</p></li>
/// <li>
/// <p>Key alias</p></li>
/// <li>
/// <p>ARN using key ID. The ID ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>key</code> namespace, and then the key ID. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:key/<i>abcd1234-a123-456a-a12b-a123b4cd56ef</i>.</p></li>
/// <li>
/// <p>ARN using key alias. The alias ARN contains the <code>arn:aws:kms</code> namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the <code>alias</code> namespace, and then the key alias. For example, arn:aws:kms:<i>us-east-1</i>:<i>012345678910</i>:alias/<i>ExampleAlias</i>.</p></li>
/// </ul>
/// <p>Amazon Web Services parses <code>KmsKeyId</code> asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.</p>
/// <p>The specified KMS key must exist in the Region that the snapshot is being copied to.</p>
/// <p>Amazon EBS does not support asymmetric KMS keys.</p>
pub fn get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
&self.kms_key_id
}
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub fn role_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.role_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub fn set_role_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.role_name = input;
self
}
/// <p>The name of the role to use when not using the default role, 'vmimport'.</p>
pub fn get_role_name(&self) -> &::std::option::Option<::std::string::String> {
&self.role_name
}
/// Appends an item to `tag_specifications`.
///
/// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
///
/// <p>The tags to apply to the import snapshot task during creation.</p>
pub fn tag_specifications(mut self, input: crate::types::TagSpecification) -> Self {
let mut v = self.tag_specifications.unwrap_or_default();
v.push(input);
self.tag_specifications = ::std::option::Option::Some(v);
self
}
/// <p>The tags to apply to the import snapshot task during creation.</p>
pub fn set_tag_specifications(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>) -> Self {
self.tag_specifications = input;
self
}
/// <p>The tags to apply to the import snapshot task during creation.</p>
pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
&self.tag_specifications
}
/// Consumes the builder and constructs a [`ImportSnapshotInput`](crate::operation::import_snapshot::ImportSnapshotInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::import_snapshot::ImportSnapshotInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::import_snapshot::ImportSnapshotInput {
client_data: self.client_data,
client_token: self.client_token,
description: self.description,
disk_container: self.disk_container,
dry_run: self.dry_run,
encrypted: self.encrypted,
kms_key_id: self.kms_key_id,
role_name: self.role_name,
tag_specifications: self.tag_specifications,
})
}
}