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
// 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 UpdateLifecyclePolicyInput {
/// <p>The identifier of the lifecycle policy.</p>
pub policy_id: ::std::option::Option<::std::string::String>,
/// <p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>
pub execution_role_arn: ::std::option::Option<::std::string::String>,
/// <p>The desired activation state of the lifecycle policy after creation.</p>
pub state: ::std::option::Option<crate::types::SettablePolicyStateValues>,
/// <p>A description of the lifecycle policy.</p>
pub description: ::std::option::Option<::std::string::String>,
/// <p>The configuration of the lifecycle policy. You cannot update the policy type or the resource type.</p>
pub policy_details: ::std::option::Option<crate::types::PolicyDetails>,
/// <p><b>\[Default policies only\]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.</p>
pub create_interval: ::std::option::Option<i32>,
/// <p><b>\[Default policies only\]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.</p>
pub retain_interval: ::std::option::Option<i32>,
/// <p><b>\[Default policies only\]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.</p>
pub copy_tags: ::std::option::Option<bool>,
/// <p><b>\[Default policies only\]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</p>
/// <p>By default (<b>ExtendDeletion=false</b>):</p>
/// <ul>
/// <li>
/// <p>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <code>true</code>.</p></li>
/// <li>
/// <p>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <code>true</code>.</p></li>
/// </ul>
/// <p>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</p>
/// <p>Default: false</p>
pub extend_deletion: ::std::option::Option<bool>,
/// <p><b>\[Default policies only\]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</p>
pub cross_region_copy_targets: ::std::option::Option<::std::vec::Vec<crate::types::CrossRegionCopyTarget>>,
/// <p><b>\[Default policies only\]</b> Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.</p>
pub exclusions: ::std::option::Option<crate::types::Exclusions>,
}
impl UpdateLifecyclePolicyInput {
/// <p>The identifier of the lifecycle policy.</p>
pub fn policy_id(&self) -> ::std::option::Option<&str> {
self.policy_id.as_deref()
}
/// <p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>
pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
self.execution_role_arn.as_deref()
}
/// <p>The desired activation state of the lifecycle policy after creation.</p>
pub fn state(&self) -> ::std::option::Option<&crate::types::SettablePolicyStateValues> {
self.state.as_ref()
}
/// <p>A description of the lifecycle policy.</p>
pub fn description(&self) -> ::std::option::Option<&str> {
self.description.as_deref()
}
/// <p>The configuration of the lifecycle policy. You cannot update the policy type or the resource type.</p>
pub fn policy_details(&self) -> ::std::option::Option<&crate::types::PolicyDetails> {
self.policy_details.as_ref()
}
/// <p><b>\[Default policies only\]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.</p>
pub fn create_interval(&self) -> ::std::option::Option<i32> {
self.create_interval
}
/// <p><b>\[Default policies only\]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.</p>
pub fn retain_interval(&self) -> ::std::option::Option<i32> {
self.retain_interval
}
/// <p><b>\[Default policies only\]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.</p>
pub fn copy_tags(&self) -> ::std::option::Option<bool> {
self.copy_tags
}
/// <p><b>\[Default policies only\]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</p>
/// <p>By default (<b>ExtendDeletion=false</b>):</p>
/// <ul>
/// <li>
/// <p>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <code>true</code>.</p></li>
/// <li>
/// <p>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <code>true</code>.</p></li>
/// </ul>
/// <p>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</p>
/// <p>Default: false</p>
pub fn extend_deletion(&self) -> ::std::option::Option<bool> {
self.extend_deletion
}
/// <p><b>\[Default policies only\]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</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 `.cross_region_copy_targets.is_none()`.
pub fn cross_region_copy_targets(&self) -> &[crate::types::CrossRegionCopyTarget] {
self.cross_region_copy_targets.as_deref().unwrap_or_default()
}
/// <p><b>\[Default policies only\]</b> Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.</p>
pub fn exclusions(&self) -> ::std::option::Option<&crate::types::Exclusions> {
self.exclusions.as_ref()
}
}
impl UpdateLifecyclePolicyInput {
/// Creates a new builder-style object to manufacture [`UpdateLifecyclePolicyInput`](crate::operation::update_lifecycle_policy::UpdateLifecyclePolicyInput).
pub fn builder() -> crate::operation::update_lifecycle_policy::builders::UpdateLifecyclePolicyInputBuilder {
crate::operation::update_lifecycle_policy::builders::UpdateLifecyclePolicyInputBuilder::default()
}
}
/// A builder for [`UpdateLifecyclePolicyInput`](crate::operation::update_lifecycle_policy::UpdateLifecyclePolicyInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct UpdateLifecyclePolicyInputBuilder {
pub(crate) policy_id: ::std::option::Option<::std::string::String>,
pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
pub(crate) state: ::std::option::Option<crate::types::SettablePolicyStateValues>,
pub(crate) description: ::std::option::Option<::std::string::String>,
pub(crate) policy_details: ::std::option::Option<crate::types::PolicyDetails>,
pub(crate) create_interval: ::std::option::Option<i32>,
pub(crate) retain_interval: ::std::option::Option<i32>,
pub(crate) copy_tags: ::std::option::Option<bool>,
pub(crate) extend_deletion: ::std::option::Option<bool>,
pub(crate) cross_region_copy_targets: ::std::option::Option<::std::vec::Vec<crate::types::CrossRegionCopyTarget>>,
pub(crate) exclusions: ::std::option::Option<crate::types::Exclusions>,
}
impl UpdateLifecyclePolicyInputBuilder {
/// <p>The identifier of the lifecycle policy.</p>
/// This field is required.
pub fn policy_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.policy_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The identifier of the lifecycle policy.</p>
pub fn set_policy_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.policy_id = input;
self
}
/// <p>The identifier of the lifecycle policy.</p>
pub fn get_policy_id(&self) -> &::std::option::Option<::std::string::String> {
&self.policy_id
}
/// <p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>
pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.execution_role_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>
pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.execution_role_arn = input;
self
}
/// <p>The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.</p>
pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.execution_role_arn
}
/// <p>The desired activation state of the lifecycle policy after creation.</p>
pub fn state(mut self, input: crate::types::SettablePolicyStateValues) -> Self {
self.state = ::std::option::Option::Some(input);
self
}
/// <p>The desired activation state of the lifecycle policy after creation.</p>
pub fn set_state(mut self, input: ::std::option::Option<crate::types::SettablePolicyStateValues>) -> Self {
self.state = input;
self
}
/// <p>The desired activation state of the lifecycle policy after creation.</p>
pub fn get_state(&self) -> &::std::option::Option<crate::types::SettablePolicyStateValues> {
&self.state
}
/// <p>A description of the lifecycle policy.</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 of the lifecycle policy.</p>
pub fn set_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.description = input;
self
}
/// <p>A description of the lifecycle policy.</p>
pub fn get_description(&self) -> &::std::option::Option<::std::string::String> {
&self.description
}
/// <p>The configuration of the lifecycle policy. You cannot update the policy type or the resource type.</p>
pub fn policy_details(mut self, input: crate::types::PolicyDetails) -> Self {
self.policy_details = ::std::option::Option::Some(input);
self
}
/// <p>The configuration of the lifecycle policy. You cannot update the policy type or the resource type.</p>
pub fn set_policy_details(mut self, input: ::std::option::Option<crate::types::PolicyDetails>) -> Self {
self.policy_details = input;
self
}
/// <p>The configuration of the lifecycle policy. You cannot update the policy type or the resource type.</p>
pub fn get_policy_details(&self) -> &::std::option::Option<crate::types::PolicyDetails> {
&self.policy_details
}
/// <p><b>\[Default policies only\]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.</p>
pub fn create_interval(mut self, input: i32) -> Self {
self.create_interval = ::std::option::Option::Some(input);
self
}
/// <p><b>\[Default policies only\]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.</p>
pub fn set_create_interval(mut self, input: ::std::option::Option<i32>) -> Self {
self.create_interval = input;
self
}
/// <p><b>\[Default policies only\]</b> Specifies how often the policy should run and create snapshots or AMIs. The creation frequency can range from 1 to 7 days.</p>
pub fn get_create_interval(&self) -> &::std::option::Option<i32> {
&self.create_interval
}
/// <p><b>\[Default policies only\]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.</p>
pub fn retain_interval(mut self, input: i32) -> Self {
self.retain_interval = ::std::option::Option::Some(input);
self
}
/// <p><b>\[Default policies only\]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.</p>
pub fn set_retain_interval(mut self, input: ::std::option::Option<i32>) -> Self {
self.retain_interval = input;
self
}
/// <p><b>\[Default policies only\]</b> Specifies how long the policy should retain snapshots or AMIs before deleting them. The retention period can range from 2 to 14 days, but it must be greater than the creation frequency to ensure that the policy retains at least 1 snapshot or AMI at any given time.</p>
pub fn get_retain_interval(&self) -> &::std::option::Option<i32> {
&self.retain_interval
}
/// <p><b>\[Default policies only\]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.</p>
pub fn copy_tags(mut self, input: bool) -> Self {
self.copy_tags = ::std::option::Option::Some(input);
self
}
/// <p><b>\[Default policies only\]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.</p>
pub fn set_copy_tags(mut self, input: ::std::option::Option<bool>) -> Self {
self.copy_tags = input;
self
}
/// <p><b>\[Default policies only\]</b> Indicates whether the policy should copy tags from the source resource to the snapshot or AMI.</p>
pub fn get_copy_tags(&self) -> &::std::option::Option<bool> {
&self.copy_tags
}
/// <p><b>\[Default policies only\]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</p>
/// <p>By default (<b>ExtendDeletion=false</b>):</p>
/// <ul>
/// <li>
/// <p>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <code>true</code>.</p></li>
/// <li>
/// <p>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <code>true</code>.</p></li>
/// </ul>
/// <p>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</p>
/// <p>Default: false</p>
pub fn extend_deletion(mut self, input: bool) -> Self {
self.extend_deletion = ::std::option::Option::Some(input);
self
}
/// <p><b>\[Default policies only\]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</p>
/// <p>By default (<b>ExtendDeletion=false</b>):</p>
/// <ul>
/// <li>
/// <p>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <code>true</code>.</p></li>
/// <li>
/// <p>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <code>true</code>.</p></li>
/// </ul>
/// <p>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</p>
/// <p>Default: false</p>
pub fn set_extend_deletion(mut self, input: ::std::option::Option<bool>) -> Self {
self.extend_deletion = input;
self
}
/// <p><b>\[Default policies only\]</b> Defines the snapshot or AMI retention behavior for the policy if the source volume or instance is deleted, or if the policy enters the error, disabled, or deleted state.</p>
/// <p>By default (<b>ExtendDeletion=false</b>):</p>
/// <ul>
/// <li>
/// <p>If a source resource is deleted, Amazon Data Lifecycle Manager will continue to delete previously created snapshots or AMIs, up to but not including the last one, based on the specified retention period. If you want Amazon Data Lifecycle Manager to delete all snapshots or AMIs, including the last one, specify <code>true</code>.</p></li>
/// <li>
/// <p>If a policy enters the error, disabled, or deleted state, Amazon Data Lifecycle Manager stops deleting snapshots and AMIs. If you want Amazon Data Lifecycle Manager to continue deleting snapshots or AMIs, including the last one, if the policy enters one of these states, specify <code>true</code>.</p></li>
/// </ul>
/// <p>If you enable extended deletion (<b>ExtendDeletion=true</b>), you override both default behaviors simultaneously.</p>
/// <p>Default: false</p>
pub fn get_extend_deletion(&self) -> &::std::option::Option<bool> {
&self.extend_deletion
}
/// Appends an item to `cross_region_copy_targets`.
///
/// To override the contents of this collection use [`set_cross_region_copy_targets`](Self::set_cross_region_copy_targets).
///
/// <p><b>\[Default policies only\]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</p>
pub fn cross_region_copy_targets(mut self, input: crate::types::CrossRegionCopyTarget) -> Self {
let mut v = self.cross_region_copy_targets.unwrap_or_default();
v.push(input);
self.cross_region_copy_targets = ::std::option::Option::Some(v);
self
}
/// <p><b>\[Default policies only\]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</p>
pub fn set_cross_region_copy_targets(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::CrossRegionCopyTarget>>) -> Self {
self.cross_region_copy_targets = input;
self
}
/// <p><b>\[Default policies only\]</b> Specifies destination Regions for snapshot or AMI copies. You can specify up to 3 destination Regions. If you do not want to create cross-Region copies, omit this parameter.</p>
pub fn get_cross_region_copy_targets(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::CrossRegionCopyTarget>> {
&self.cross_region_copy_targets
}
/// <p><b>\[Default policies only\]</b> Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.</p>
pub fn exclusions(mut self, input: crate::types::Exclusions) -> Self {
self.exclusions = ::std::option::Option::Some(input);
self
}
/// <p><b>\[Default policies only\]</b> Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.</p>
pub fn set_exclusions(mut self, input: ::std::option::Option<crate::types::Exclusions>) -> Self {
self.exclusions = input;
self
}
/// <p><b>\[Default policies only\]</b> Specifies exclusion parameters for volumes or instances for which you do not want to create snapshots or AMIs. The policy will not create snapshots or AMIs for target resources that match any of the specified exclusion parameters.</p>
pub fn get_exclusions(&self) -> &::std::option::Option<crate::types::Exclusions> {
&self.exclusions
}
/// Consumes the builder and constructs a [`UpdateLifecyclePolicyInput`](crate::operation::update_lifecycle_policy::UpdateLifecyclePolicyInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_lifecycle_policy::UpdateLifecyclePolicyInput, ::aws_smithy_types::error::operation::BuildError>
{
::std::result::Result::Ok(crate::operation::update_lifecycle_policy::UpdateLifecyclePolicyInput {
policy_id: self.policy_id,
execution_role_arn: self.execution_role_arn,
state: self.state,
description: self.description,
policy_details: self.policy_details,
create_interval: self.create_interval,
retain_interval: self.retain_interval,
copy_tags: self.copy_tags,
extend_deletion: self.extend_deletion,
cross_region_copy_targets: self.cross_region_copy_targets,
exclusions: self.exclusions,
})
}
}