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
// 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 CreateSnapshotsInput {
/// <p>A description propagated to every snapshot specified by the instance.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The instance to specify which volumes should be included in the snapshots.</p>
pub instance_specification: ::std::option::Option<crate::types::InstanceSpecification>,
/// <note>
/// <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p></li>
/// <li>
/// <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p>
pub outpost_arn: ::std::option::Option<::std::string::String>,
/// <p>Tags to apply to every snapshot specified by the instance.</p>
pub tag_specifications: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>,
/// <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>Copies the tags from the specified volume to corresponding snapshot.</p>
pub copy_tags_from_source: ::std::option::Option<crate::types::CopyTagsFromSource>,
/// <note>
/// <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p></li>
/// <li>
/// <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p></li>
/// </ul>
/// <p>Default value: <code>regional</code></p>
pub location: ::std::option::Option<crate::types::SnapshotLocationEnum>,
}
impl CreateSnapshotsInput {
/// <p>A description propagated to every snapshot specified by the instance.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The instance to specify which volumes should be included in the snapshots.</p>
pub fn instance_specification(&self) -> ::std::option::Option<&crate::types::InstanceSpecification> {
self.instance_specification.as_ref()
}
/// <note>
/// <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p></li>
/// <li>
/// <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn outpost_arn(&self) -> ::std::option::Option<&str> {
self.outpost_arn.as_deref()
}
/// <p>Tags to apply to every snapshot specified by the instance.</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()
}
/// <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>Copies the tags from the specified volume to corresponding snapshot.</p>
pub fn copy_tags_from_source(&self) -> ::std::option::Option<&crate::types::CopyTagsFromSource> {
self.copy_tags_from_source.as_ref()
}
/// <note>
/// <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p></li>
/// <li>
/// <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p></li>
/// </ul>
/// <p>Default value: <code>regional</code></p>
pub fn location(&self) -> ::std::option::Option<&crate::types::SnapshotLocationEnum> {
self.location.as_ref()
}
}
impl CreateSnapshotsInput {
/// Creates a new builder-style object to manufacture [`CreateSnapshotsInput`](crate::operation::create_snapshots::CreateSnapshotsInput).
pub fn builder() -> crate::operation::create_snapshots::builders::CreateSnapshotsInputBuilder {
crate::operation::create_snapshots::builders::CreateSnapshotsInputBuilder::default()
}
}
/// A builder for [`CreateSnapshotsInput`](crate::operation::create_snapshots::CreateSnapshotsInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateSnapshotsInputBuilder {
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) instance_specification: ::std::option::Option<crate::types::InstanceSpecification>,
pub(crate) outpost_arn: ::std::option::Option<::std::string::String>,
pub(crate) tag_specifications: ::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>>,
pub(crate) dry_run: ::std::option::Option<bool>,
pub(crate) copy_tags_from_source: ::std::option::Option<crate::types::CopyTagsFromSource>,
pub(crate) location: ::std::option::Option<crate::types::SnapshotLocationEnum>,
}
impl CreateSnapshotsInputBuilder {
/// <p>A description propagated to every snapshot specified by the instance.</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>A description propagated to every snapshot specified by the instance.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description propagated to every snapshot specified by the instance.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The instance to specify which volumes should be included in the snapshots.</p>
/// This field is required.
pub fn instance_specification(mut self, input: crate::types::InstanceSpecification) -> Self {
self.instance_specification = ::std::option::Option::Some(input);
self
}
/// <p>The instance to specify which volumes should be included in the snapshots.</p>
pub fn set_instance_specification(mut self, input: ::std::option::Option<crate::types::InstanceSpecification>) -> Self {
self.instance_specification = input;
self
}
/// <p>The instance to specify which volumes should be included in the snapshots.</p>
pub fn get_instance_specification(&self) -> &::std::option::Option<crate::types::InstanceSpecification> {
&self.instance_specification
}
/// <note>
/// <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p></li>
/// <li>
/// <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn outpost_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.outpost_arn = ::std::option::Option::Some(input.into());
self
}
/// <note>
/// <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p></li>
/// <li>
/// <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn set_outpost_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.outpost_arn = input;
self
}
/// <note>
/// <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p></li>
/// <li>
/// <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p></li>
/// </ul>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p>
pub fn get_outpost_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.outpost_arn
}
/// Appends an item to `tag_specifications`.
///
/// To override the contents of this collection use [`set_tag_specifications`](Self::set_tag_specifications).
///
/// <p>Tags to apply to every snapshot specified by the instance.</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>Tags to apply to every snapshot specified by the instance.</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>Tags to apply to every snapshot specified by the instance.</p>
pub fn get_tag_specifications(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::TagSpecification>> {
&self.tag_specifications
}
/// <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>Copies the tags from the specified volume to corresponding snapshot.</p>
pub fn copy_tags_from_source(mut self, input: crate::types::CopyTagsFromSource) -> Self {
self.copy_tags_from_source = ::std::option::Option::Some(input);
self
}
/// <p>Copies the tags from the specified volume to corresponding snapshot.</p>
pub fn set_copy_tags_from_source(mut self, input: ::std::option::Option<crate::types::CopyTagsFromSource>) -> Self {
self.copy_tags_from_source = input;
self
}
/// <p>Copies the tags from the specified volume to corresponding snapshot.</p>
pub fn get_copy_tags_from_source(&self) -> &::std::option::Option<crate::types::CopyTagsFromSource> {
&self.copy_tags_from_source
}
/// <note>
/// <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p></li>
/// <li>
/// <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p></li>
/// </ul>
/// <p>Default value: <code>regional</code></p>
pub fn location(mut self, input: crate::types::SnapshotLocationEnum) -> Self {
self.location = ::std::option::Option::Some(input);
self
}
/// <note>
/// <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p></li>
/// <li>
/// <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p></li>
/// </ul>
/// <p>Default value: <code>regional</code></p>
pub fn set_location(mut self, input: ::std::option::Option<crate::types::SnapshotLocationEnum>) -> Self {
self.location = input;
self
}
/// <note>
/// <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p>
/// </note>
/// <ul>
/// <li>
/// <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p></li>
/// <li>
/// <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p></li>
/// </ul>
/// <p>Default value: <code>regional</code></p>
pub fn get_location(&self) -> &::std::option::Option<crate::types::SnapshotLocationEnum> {
&self.location
}
/// Consumes the builder and constructs a [`CreateSnapshotsInput`](crate::operation::create_snapshots::CreateSnapshotsInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::create_snapshots::CreateSnapshotsInput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::create_snapshots::CreateSnapshotsInput {
description: self.description,
instance_specification: self.instance_specification,
outpost_arn: self.outpost_arn,
tag_specifications: self.tag_specifications,
dry_run: self.dry_run,
copy_tags_from_source: self.copy_tags_from_source,
location: self.location,
})
}
}