aws-sdk-dlm 1.62.0 → 1.64.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-dlm/client.rb +295 -7
- data/lib/aws-sdk-dlm/client_api.rb +77 -3
- data/lib/aws-sdk-dlm/endpoint_provider.rb +2 -2
- data/lib/aws-sdk-dlm/types.rb +615 -109
- data/lib/aws-sdk-dlm.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-dlm/types.rb
CHANGED
@@ -30,8 +30,8 @@ module Aws::DLM
|
|
30
30
|
include Aws::Structure
|
31
31
|
end
|
32
32
|
|
33
|
-
# **\[
|
34
|
-
# storage tier retention period.
|
33
|
+
# **\[Custom snapshot policies only\]** Specifies information about the
|
34
|
+
# archive storage tier retention period.
|
35
35
|
#
|
36
36
|
# @!attribute [rw] retention_archive_tier
|
37
37
|
# Information about retention period in the Amazon EBS Snapshots
|
@@ -51,8 +51,8 @@ module Aws::DLM
|
|
51
51
|
include Aws::Structure
|
52
52
|
end
|
53
53
|
|
54
|
-
# **\[
|
55
|
-
# a schedule.
|
54
|
+
# **\[Custom snapshot policies only\]** Specifies a snapshot archiving
|
55
|
+
# rule for a schedule.
|
56
56
|
#
|
57
57
|
# @!attribute [rw] retain_rule
|
58
58
|
# Information about the retention period for the snapshot archiving
|
@@ -78,17 +78,103 @@ module Aws::DLM
|
|
78
78
|
# @return [String]
|
79
79
|
#
|
80
80
|
# @!attribute [rw] state
|
81
|
-
# The
|
81
|
+
# The activation state of the lifecycle policy after creation.
|
82
82
|
# @return [String]
|
83
83
|
#
|
84
84
|
# @!attribute [rw] policy_details
|
85
85
|
# The configuration details of the lifecycle policy.
|
86
|
+
#
|
87
|
+
# If you create a default policy, you can specify the request
|
88
|
+
# parameters either in the request body, or in the PolicyDetails
|
89
|
+
# request structure, but not both.
|
86
90
|
# @return [Types::PolicyDetails]
|
87
91
|
#
|
88
92
|
# @!attribute [rw] tags
|
89
93
|
# The tags to apply to the lifecycle policy during creation.
|
90
94
|
# @return [Hash<String,String>]
|
91
95
|
#
|
96
|
+
# @!attribute [rw] default_policy
|
97
|
+
# **\[Default policies only\]** Specify the type of default policy to
|
98
|
+
# create.
|
99
|
+
#
|
100
|
+
# * To create a default policy for EBS snapshots, that creates
|
101
|
+
# snapshots of all volumes in the Region that do not have recent
|
102
|
+
# backups, specify `VOLUME`.
|
103
|
+
#
|
104
|
+
# * To create a default policy for EBS-backed AMIs, that creates
|
105
|
+
# EBS-backed AMIs from all instances in the Region that do not have
|
106
|
+
# recent backups, specify `INSTANCE`.
|
107
|
+
# @return [String]
|
108
|
+
#
|
109
|
+
# @!attribute [rw] create_interval
|
110
|
+
# **\[Default policies only\]** Specifies how often the policy should
|
111
|
+
# run and create snapshots or AMIs. The creation frequency can range
|
112
|
+
# from 1 to 7 days. If you do not specify a value, the default is 1.
|
113
|
+
#
|
114
|
+
# Default: 1
|
115
|
+
# @return [Integer]
|
116
|
+
#
|
117
|
+
# @!attribute [rw] retain_interval
|
118
|
+
# **\[Default policies only\]** Specifies how long the policy should
|
119
|
+
# retain snapshots or AMIs before deleting them. The retention period
|
120
|
+
# can range from 2 to 14 days, but it must be greater than the
|
121
|
+
# creation frequency to ensure that the policy retains at least 1
|
122
|
+
# snapshot or AMI at any given time. If you do not specify a value,
|
123
|
+
# the default is 7.
|
124
|
+
#
|
125
|
+
# Default: 7
|
126
|
+
# @return [Integer]
|
127
|
+
#
|
128
|
+
# @!attribute [rw] copy_tags
|
129
|
+
# **\[Default policies only\]** Indicates whether the policy should
|
130
|
+
# copy tags from the source resource to the snapshot or AMI. If you do
|
131
|
+
# not specify a value, the default is `false`.
|
132
|
+
#
|
133
|
+
# Default: false
|
134
|
+
# @return [Boolean]
|
135
|
+
#
|
136
|
+
# @!attribute [rw] extend_deletion
|
137
|
+
# **\[Default policies only\]** Defines the snapshot or AMI retention
|
138
|
+
# behavior for the policy if the source volume or instance is deleted,
|
139
|
+
# or if the policy enters the error, disabled, or deleted state.
|
140
|
+
#
|
141
|
+
# By default (**ExtendDeletion=false**):
|
142
|
+
#
|
143
|
+
# * If a source resource is deleted, Amazon Data Lifecycle Manager
|
144
|
+
# will continue to delete previously created snapshots or AMIs, up
|
145
|
+
# to but not including the last one, based on the specified
|
146
|
+
# retention period. If you want Amazon Data Lifecycle Manager to
|
147
|
+
# delete all snapshots or AMIs, including the last one, specify
|
148
|
+
# `true`.
|
149
|
+
#
|
150
|
+
# * If a policy enters the error, disabled, or deleted state, Amazon
|
151
|
+
# Data Lifecycle Manager stops deleting snapshots and AMIs. If you
|
152
|
+
# want Amazon Data Lifecycle Manager to continue deleting snapshots
|
153
|
+
# or AMIs, including the last one, if the policy enters one of these
|
154
|
+
# states, specify `true`.
|
155
|
+
#
|
156
|
+
# If you enable extended deletion (**ExtendDeletion=true**), you
|
157
|
+
# override both default behaviors simultaneously.
|
158
|
+
#
|
159
|
+
# If you do not specify a value, the default is `false`.
|
160
|
+
#
|
161
|
+
# Default: false
|
162
|
+
# @return [Boolean]
|
163
|
+
#
|
164
|
+
# @!attribute [rw] cross_region_copy_targets
|
165
|
+
# **\[Default policies only\]** Specifies destination Regions for
|
166
|
+
# snapshot or AMI copies. You can specify up to 3 destination Regions.
|
167
|
+
# If you do not want to create cross-Region copies, omit this
|
168
|
+
# parameter.
|
169
|
+
# @return [Array<Types::CrossRegionCopyTarget>]
|
170
|
+
#
|
171
|
+
# @!attribute [rw] exclusions
|
172
|
+
# **\[Default policies only\]** Specifies exclusion parameters for
|
173
|
+
# volumes or instances for which you do not want to create snapshots
|
174
|
+
# or AMIs. The policy will not create snapshots or AMIs for target
|
175
|
+
# resources that match any of the specified exclusion parameters.
|
176
|
+
# @return [Types::Exclusions]
|
177
|
+
#
|
92
178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateLifecyclePolicyRequest AWS API Documentation
|
93
179
|
#
|
94
180
|
class CreateLifecyclePolicyRequest < Struct.new(
|
@@ -96,7 +182,14 @@ module Aws::DLM
|
|
96
182
|
:description,
|
97
183
|
:state,
|
98
184
|
:policy_details,
|
99
|
-
:tags
|
185
|
+
:tags,
|
186
|
+
:default_policy,
|
187
|
+
:create_interval,
|
188
|
+
:retain_interval,
|
189
|
+
:copy_tags,
|
190
|
+
:extend_deletion,
|
191
|
+
:cross_region_copy_targets,
|
192
|
+
:exclusions)
|
100
193
|
SENSITIVE = []
|
101
194
|
include Aws::Structure
|
102
195
|
end
|
@@ -113,19 +206,23 @@ module Aws::DLM
|
|
113
206
|
include Aws::Structure
|
114
207
|
end
|
115
208
|
|
116
|
-
# **\[
|
117
|
-
# should create snapshots or AMIs.
|
209
|
+
# **\[Custom snapshot and AMI policies only\]** Specifies when the
|
210
|
+
# policy should create snapshots or AMIs.
|
118
211
|
#
|
119
212
|
# <note markdown="1"> * You must specify either **CronExpression**, or **Interval**,
|
120
213
|
# **IntervalUnit**, and **Times**.
|
121
214
|
#
|
122
|
-
# * If you need to specify an ArchiveRule for the schedule, then
|
123
|
-
# must specify a creation frequency of at least 28 days.
|
215
|
+
# * If you need to specify an [ArchiveRule][1] for the schedule, then
|
216
|
+
# you must specify a creation frequency of at least 28 days.
|
124
217
|
#
|
125
218
|
# </note>
|
126
219
|
#
|
220
|
+
#
|
221
|
+
#
|
222
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
223
|
+
#
|
127
224
|
# @!attribute [rw] location
|
128
|
-
# **\[
|
225
|
+
# **\[Custom snapshot policies only\]** Specifies the destination for
|
129
226
|
# snapshots created by the policy. To create snapshots in the same
|
130
227
|
# Region as the source resource, specify `CLOUD`. To create snapshots
|
131
228
|
# on the same Outpost as the source resource, specify `OUTPOST_LOCAL`.
|
@@ -166,6 +263,22 @@ module Aws::DLM
|
|
166
263
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
|
167
264
|
# @return [String]
|
168
265
|
#
|
266
|
+
# @!attribute [rw] scripts
|
267
|
+
# **\[Custom snapshot policies that target instances only\]**
|
268
|
+
# Specifies pre and/or post scripts for a snapshot lifecycle policy
|
269
|
+
# that targets instances. This is useful for creating
|
270
|
+
# application-consistent snapshots, or for performing specific
|
271
|
+
# administrative tasks before or after Amazon Data Lifecycle Manager
|
272
|
+
# initiates snapshot creation.
|
273
|
+
#
|
274
|
+
# For more information, see [Automating application-consistent
|
275
|
+
# snapshots with pre and post scripts][1].
|
276
|
+
#
|
277
|
+
#
|
278
|
+
#
|
279
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html
|
280
|
+
# @return [Array<Types::Script>]
|
281
|
+
#
|
169
282
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateRule AWS API Documentation
|
170
283
|
#
|
171
284
|
class CreateRule < Struct.new(
|
@@ -173,7 +286,8 @@ module Aws::DLM
|
|
173
286
|
:interval,
|
174
287
|
:interval_unit,
|
175
288
|
:times,
|
176
|
-
:cron_expression
|
289
|
+
:cron_expression,
|
290
|
+
:scripts)
|
177
291
|
SENSITIVE = []
|
178
292
|
include Aws::Structure
|
179
293
|
end
|
@@ -182,10 +296,14 @@ module Aws::DLM
|
|
182
296
|
# for event-based policies.
|
183
297
|
#
|
184
298
|
# <note markdown="1"> To specify a cross-Region copy rule for snapshot and AMI policies, use
|
185
|
-
# CrossRegionCopyRule.
|
299
|
+
# [CrossRegionCopyRule][1].
|
186
300
|
#
|
187
301
|
# </note>
|
188
302
|
#
|
303
|
+
#
|
304
|
+
#
|
305
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html
|
306
|
+
#
|
189
307
|
# @!attribute [rw] target
|
190
308
|
# The target Region.
|
191
309
|
# @return [String]
|
@@ -211,7 +329,7 @@ module Aws::DLM
|
|
211
329
|
include Aws::Structure
|
212
330
|
end
|
213
331
|
|
214
|
-
# **\[AMI policies only\]** Specifies an AMI deprecation rule for
|
332
|
+
# **\[Custom AMI policies only\]** Specifies an AMI deprecation rule for
|
215
333
|
# cross-Region AMI copies created by an AMI policy.
|
216
334
|
#
|
217
335
|
# @!attribute [rw] interval
|
@@ -262,30 +380,41 @@ module Aws::DLM
|
|
262
380
|
include Aws::Structure
|
263
381
|
end
|
264
382
|
|
265
|
-
# **\[
|
266
|
-
# rule for snapshot and AMI policies.
|
383
|
+
# **\[Custom snapshot and AMI policies only\]** Specifies a cross-Region
|
384
|
+
# copy rule for a snapshot and AMI policies.
|
267
385
|
#
|
268
386
|
# <note markdown="1"> To specify a cross-Region copy action for event-based polices, use
|
269
|
-
# CrossRegionCopyAction.
|
387
|
+
# [CrossRegionCopyAction][1].
|
270
388
|
#
|
271
389
|
# </note>
|
272
390
|
#
|
391
|
+
#
|
392
|
+
#
|
393
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html
|
394
|
+
#
|
273
395
|
# @!attribute [rw] target_region
|
274
|
-
# <note markdown="1">
|
275
|
-
# **Target**
|
276
|
-
#
|
396
|
+
# <note markdown="1"> Use this parameter for AMI policies only. For snapshot policies, use
|
397
|
+
# **Target** instead. For snapshot policies created before the
|
398
|
+
# **Target** parameter was introduced, this parameter indicates the
|
399
|
+
# target Region for snapshot copies.
|
400
|
+
#
|
277
401
|
#
|
278
|
-
# For policies created before the **Target** parameter was introduced,
|
279
|
-
# this parameter indicates the target Region for snapshot copies.
|
280
402
|
#
|
281
403
|
# </note>
|
404
|
+
#
|
405
|
+
# **\[Custom AMI policies only\]** The target Region or the Amazon
|
406
|
+
# Resource Name (ARN) of the target Outpost for the snapshot copies.
|
282
407
|
# @return [String]
|
283
408
|
#
|
284
409
|
# @!attribute [rw] target
|
285
|
-
#
|
286
|
-
#
|
410
|
+
# <note markdown="1"> Use this parameter for snapshot policies only. For AMI policies, use
|
411
|
+
# **TargetRegion** instead.
|
287
412
|
#
|
288
|
-
#
|
413
|
+
# </note>
|
414
|
+
#
|
415
|
+
# **\[Custom snapshot policies only\]** The target Region or the
|
416
|
+
# Amazon Resource Name (ARN) of the target Outpost for the snapshot
|
417
|
+
# copies.
|
289
418
|
# @return [String]
|
290
419
|
#
|
291
420
|
# @!attribute [rw] encrypted
|
@@ -312,8 +441,8 @@ module Aws::DLM
|
|
312
441
|
# @return [Types::CrossRegionCopyRetainRule]
|
313
442
|
#
|
314
443
|
# @!attribute [rw] deprecate_rule
|
315
|
-
# **\[AMI policies only\]** The AMI deprecation rule for
|
316
|
-
# AMI copies created by the rule.
|
444
|
+
# **\[Custom AMI policies only\]** The AMI deprecation rule for
|
445
|
+
# cross-Region AMI copies created by the rule.
|
317
446
|
# @return [Types::CrossRegionCopyDeprecateRule]
|
318
447
|
#
|
319
448
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CrossRegionCopyRule AWS API Documentation
|
@@ -330,6 +459,21 @@ module Aws::DLM
|
|
330
459
|
include Aws::Structure
|
331
460
|
end
|
332
461
|
|
462
|
+
# **\[Default policies only\]** Specifies a destination Region for
|
463
|
+
# cross-Region copy actions.
|
464
|
+
#
|
465
|
+
# @!attribute [rw] target_region
|
466
|
+
# The target Region, for example `us-east-1`.
|
467
|
+
# @return [String]
|
468
|
+
#
|
469
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CrossRegionCopyTarget AWS API Documentation
|
470
|
+
#
|
471
|
+
class CrossRegionCopyTarget < Struct.new(
|
472
|
+
:target_region)
|
473
|
+
SENSITIVE = []
|
474
|
+
include Aws::Structure
|
475
|
+
end
|
476
|
+
|
333
477
|
# @!attribute [rw] policy_id
|
334
478
|
# The identifier of the lifecycle policy.
|
335
479
|
# @return [String]
|
@@ -346,8 +490,8 @@ module Aws::DLM
|
|
346
490
|
#
|
347
491
|
class DeleteLifecyclePolicyResponse < Aws::EmptyStructure; end
|
348
492
|
|
349
|
-
# **\[AMI policies only\]** Specifies an AMI deprecation rule for
|
350
|
-
# created by an AMI lifecycle policy.
|
493
|
+
# **\[Custom AMI policies only\]** Specifies an AMI deprecation rule for
|
494
|
+
# AMIs created by an AMI lifecycle policy.
|
351
495
|
#
|
352
496
|
# For age-based schedules, you must specify **Interval** and
|
353
497
|
# **IntervalUnit**. For count-based schedules, you must specify
|
@@ -465,9 +609,43 @@ module Aws::DLM
|
|
465
609
|
include Aws::Structure
|
466
610
|
end
|
467
611
|
|
468
|
-
# **\[
|
469
|
-
#
|
470
|
-
#
|
612
|
+
# **\[Default policies only\]** Specifies exclusion parameters for
|
613
|
+
# volumes or instances for which you do not want to create snapshots or
|
614
|
+
# AMIs. The policy will not create snapshots or AMIs for target
|
615
|
+
# resources that match any of the specified exclusion parameters.
|
616
|
+
#
|
617
|
+
# @!attribute [rw] exclude_boot_volumes
|
618
|
+
# **\[Default policies for EBS snapshots only\]** Indicates whether to
|
619
|
+
# exclude volumes that are attached to instances as the boot volume.
|
620
|
+
# If you exclude boot volumes, only volumes attached as data
|
621
|
+
# (non-boot) volumes will be backed up by the policy. To exclude boot
|
622
|
+
# volumes, specify `true`.
|
623
|
+
# @return [Boolean]
|
624
|
+
#
|
625
|
+
# @!attribute [rw] exclude_volume_types
|
626
|
+
# **\[Default policies for EBS snapshots only\]** Specifies the volume
|
627
|
+
# types to exclude. Volumes of the specified types will not be
|
628
|
+
# targeted by the policy.
|
629
|
+
# @return [Array<String>]
|
630
|
+
#
|
631
|
+
# @!attribute [rw] exclude_tags
|
632
|
+
# **\[Default policies for EBS-backed AMIs only\]** Specifies whether
|
633
|
+
# to exclude volumes that have specific tags.
|
634
|
+
# @return [Array<Types::Tag>]
|
635
|
+
#
|
636
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/Exclusions AWS API Documentation
|
637
|
+
#
|
638
|
+
class Exclusions < Struct.new(
|
639
|
+
:exclude_boot_volumes,
|
640
|
+
:exclude_volume_types,
|
641
|
+
:exclude_tags)
|
642
|
+
SENSITIVE = []
|
643
|
+
include Aws::Structure
|
644
|
+
end
|
645
|
+
|
646
|
+
# **\[Custom snapshot policies only\]** Specifies a rule for enabling
|
647
|
+
# fast snapshot restore for snapshots created by snapshot policies. You
|
648
|
+
# can enable fast snapshot restore based on either a count or a time
|
471
649
|
# interval.
|
472
650
|
#
|
473
651
|
# @!attribute [rw] count
|
@@ -526,6 +704,17 @@ module Aws::DLM
|
|
526
704
|
# Services-added lifecycle tags.
|
527
705
|
# @return [Array<String>]
|
528
706
|
#
|
707
|
+
# @!attribute [rw] default_policy_type
|
708
|
+
# **\[Default policies only\]** Specifies the type of default policy
|
709
|
+
# to get. Specify one of the following:
|
710
|
+
#
|
711
|
+
# * `VOLUME` - To get only the default policy for EBS snapshots
|
712
|
+
#
|
713
|
+
# * `INSTANCE` - To get only the default policy for EBS-backed AMIs
|
714
|
+
#
|
715
|
+
# * `ALL` - To get all default policies
|
716
|
+
# @return [String]
|
717
|
+
#
|
529
718
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/GetLifecyclePoliciesRequest AWS API Documentation
|
530
719
|
#
|
531
720
|
class GetLifecyclePoliciesRequest < Struct.new(
|
@@ -533,7 +722,8 @@ module Aws::DLM
|
|
533
722
|
:state,
|
534
723
|
:resource_types,
|
535
724
|
:target_tags,
|
536
|
-
:tags_to_add
|
725
|
+
:tags_to_add,
|
726
|
+
:default_policy_type)
|
537
727
|
SENSITIVE = []
|
538
728
|
include Aws::Structure
|
539
729
|
end
|
@@ -619,8 +809,8 @@ module Aws::DLM
|
|
619
809
|
include Aws::Structure
|
620
810
|
end
|
621
811
|
|
622
|
-
# **\[
|
623
|
-
# or event-based lifecycle policy.
|
812
|
+
# **\[Custom policies only\]** Detailed information about a snapshot,
|
813
|
+
# AMI, or event-based lifecycle policy.
|
624
814
|
#
|
625
815
|
# @!attribute [rw] policy_id
|
626
816
|
# The identifier of the lifecycle policy.
|
@@ -663,6 +853,15 @@ module Aws::DLM
|
|
663
853
|
# The Amazon Resource Name (ARN) of the policy.
|
664
854
|
# @return [String]
|
665
855
|
#
|
856
|
+
# @!attribute [rw] default_policy
|
857
|
+
# **\[Default policies only\]** The type of default policy. Values
|
858
|
+
# include:
|
859
|
+
#
|
860
|
+
# * `VOLUME` - Default policy for EBS snapshots
|
861
|
+
#
|
862
|
+
# * `INSTANCE` - Default policy for EBS-backed AMIs
|
863
|
+
# @return [Boolean]
|
864
|
+
#
|
666
865
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/LifecyclePolicy AWS API Documentation
|
667
866
|
#
|
668
867
|
class LifecyclePolicy < Struct.new(
|
@@ -675,7 +874,8 @@ module Aws::DLM
|
|
675
874
|
:date_modified,
|
676
875
|
:policy_details,
|
677
876
|
:tags,
|
678
|
-
:policy_arn
|
877
|
+
:policy_arn,
|
878
|
+
:default_policy)
|
679
879
|
SENSITIVE = []
|
680
880
|
include Aws::Structure
|
681
881
|
end
|
@@ -707,6 +907,15 @@ module Aws::DLM
|
|
707
907
|
# shared with your account.
|
708
908
|
# @return [String]
|
709
909
|
#
|
910
|
+
# @!attribute [rw] default_policy
|
911
|
+
# **\[Default policies only\]** The type of default policy. Values
|
912
|
+
# include:
|
913
|
+
#
|
914
|
+
# * `VOLUME` - Default policy for EBS snapshots
|
915
|
+
#
|
916
|
+
# * `INSTANCE` - Default policy for EBS-backed AMIs
|
917
|
+
# @return [Boolean]
|
918
|
+
#
|
710
919
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/LifecyclePolicySummary AWS API Documentation
|
711
920
|
#
|
712
921
|
class LifecyclePolicySummary < Struct.new(
|
@@ -714,7 +923,8 @@ module Aws::DLM
|
|
714
923
|
:description,
|
715
924
|
:state,
|
716
925
|
:tags,
|
717
|
-
:policy_type
|
926
|
+
:policy_type,
|
927
|
+
:default_policy)
|
718
928
|
SENSITIVE = []
|
719
929
|
include Aws::Structure
|
720
930
|
end
|
@@ -765,9 +975,9 @@ module Aws::DLM
|
|
765
975
|
include Aws::Structure
|
766
976
|
end
|
767
977
|
|
768
|
-
# **\[
|
769
|
-
# for snapshot and AMI policies. The set of valid parameters
|
770
|
-
# the combination of policy type and target resource type.
|
978
|
+
# **\[Custom snapshot and AMI policies only\]** Specifies optional
|
979
|
+
# parameters for snapshot and AMI policies. The set of valid parameters
|
980
|
+
# depends on the combination of policy type and target resource type.
|
771
981
|
#
|
772
982
|
# If you choose to exclude boot volumes and you specify tags that
|
773
983
|
# consequently exclude all of the additional data volumes attached to an
|
@@ -781,25 +991,25 @@ module Aws::DLM
|
|
781
991
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html
|
782
992
|
#
|
783
993
|
# @!attribute [rw] exclude_boot_volume
|
784
|
-
# **\[
|
785
|
-
# whether to exclude the root volume from multi-volume
|
786
|
-
# The default is `false`. If you specify `true`, then
|
787
|
-
# attached to targeted instances will be excluded
|
788
|
-
# multi-volume snapshot sets created by the policy.
|
994
|
+
# **\[Custom snapshot policies that target instances only\]**
|
995
|
+
# Indicates whether to exclude the root volume from multi-volume
|
996
|
+
# snapshot sets. The default is `false`. If you specify `true`, then
|
997
|
+
# the root volumes attached to targeted instances will be excluded
|
998
|
+
# from the multi-volume snapshot sets created by the policy.
|
789
999
|
# @return [Boolean]
|
790
1000
|
#
|
791
1001
|
# @!attribute [rw] no_reboot
|
792
|
-
# **\[AMI policies only\]** Indicates whether targeted
|
793
|
-
# rebooted when the lifecycle policy runs. `true`
|
794
|
-
# targeted instances are not rebooted when the policy
|
795
|
-
# indicates that target instances are rebooted when the
|
796
|
-
# The default is `true` (instances are not rebooted).
|
1002
|
+
# **\[Custom AMI policies only\]** Indicates whether targeted
|
1003
|
+
# instances are rebooted when the lifecycle policy runs. `true`
|
1004
|
+
# indicates that targeted instances are not rebooted when the policy
|
1005
|
+
# runs. `false` indicates that target instances are rebooted when the
|
1006
|
+
# policy runs. The default is `true` (instances are not rebooted).
|
797
1007
|
# @return [Boolean]
|
798
1008
|
#
|
799
1009
|
# @!attribute [rw] exclude_data_volume_tags
|
800
|
-
# **\[
|
801
|
-
# to identify data (non-root) volumes to exclude from
|
802
|
-
# snapshot sets.
|
1010
|
+
# **\[Custom snapshot policies that target instances only\]** The tags
|
1011
|
+
# used to identify data (non-root) volumes to exclude from
|
1012
|
+
# multi-volume snapshot sets.
|
803
1013
|
#
|
804
1014
|
# If you create a snapshot lifecycle policy that targets instances and
|
805
1015
|
# you specify tags for this parameter, then data volumes with the
|
@@ -817,33 +1027,33 @@ module Aws::DLM
|
|
817
1027
|
include Aws::Structure
|
818
1028
|
end
|
819
1029
|
|
820
|
-
#
|
821
|
-
# policy.
|
1030
|
+
# Specifies the configuration of a lifecycle policy.
|
822
1031
|
#
|
823
1032
|
# @!attribute [rw] policy_type
|
824
|
-
# **\[
|
825
|
-
# a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to
|
826
|
-
# lifecycle policy that manages the lifecycle of Amazon EBS
|
827
|
-
# Specify `IMAGE_MANAGEMENT` to create a lifecycle policy
|
828
|
-
# the lifecycle of EBS-backed AMIs. Specify
|
829
|
-
# create an event-based policy that performs
|
830
|
-
# defined event occurs in your Amazon Web
|
1033
|
+
# **\[Custom policies only\]** The valid target resource types and
|
1034
|
+
# actions a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to
|
1035
|
+
# create a lifecycle policy that manages the lifecycle of Amazon EBS
|
1036
|
+
# snapshots. Specify `IMAGE_MANAGEMENT` to create a lifecycle policy
|
1037
|
+
# that manages the lifecycle of EBS-backed AMIs. Specify
|
1038
|
+
# `EVENT_BASED_POLICY ` to create an event-based policy that performs
|
1039
|
+
# specific actions when a defined event occurs in your Amazon Web
|
1040
|
+
# Services account.
|
831
1041
|
#
|
832
1042
|
# The default is `EBS_SNAPSHOT_MANAGEMENT`.
|
833
1043
|
# @return [String]
|
834
1044
|
#
|
835
1045
|
# @!attribute [rw] resource_types
|
836
|
-
# **\[
|
837
|
-
# and AMI lifecycle policies. Use `VOLUME `to create
|
838
|
-
# individual volumes or use `INSTANCE` to create
|
839
|
-
# snapshots from the volumes for an instance.
|
1046
|
+
# **\[Custom snapshot policies only\]** The target resource type for
|
1047
|
+
# snapshot and AMI lifecycle policies. Use `VOLUME `to create
|
1048
|
+
# snapshots of individual volumes or use `INSTANCE` to create
|
1049
|
+
# multi-volume snapshots from the volumes for an instance.
|
840
1050
|
# @return [Array<String>]
|
841
1051
|
#
|
842
1052
|
# @!attribute [rw] resource_locations
|
843
|
-
# **\[
|
844
|
-
# to backup. If the source resources are located in an
|
845
|
-
# Services Region, specify `CLOUD`. If the source resources
|
846
|
-
# located on an Outpost in your account, specify `OUTPOST`.
|
1053
|
+
# **\[Custom snapshot and AMI policies only\]** The location of the
|
1054
|
+
# resources to backup. If the source resources are located in an
|
1055
|
+
# Amazon Web Services Region, specify `CLOUD`. If the source resources
|
1056
|
+
# are located on an Outpost in your account, specify `OUTPOST`.
|
847
1057
|
#
|
848
1058
|
# If you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all
|
849
1059
|
# resources of the specified type with matching target tags across all
|
@@ -851,20 +1061,20 @@ module Aws::DLM
|
|
851
1061
|
# @return [Array<String>]
|
852
1062
|
#
|
853
1063
|
# @!attribute [rw] target_tags
|
854
|
-
# **\[
|
1064
|
+
# **\[Custom snapshot and AMI policies only\]** The single tag that
|
855
1065
|
# identifies targeted resources for this policy.
|
856
1066
|
# @return [Array<Types::Tag>]
|
857
1067
|
#
|
858
1068
|
# @!attribute [rw] schedules
|
859
|
-
# **\[
|
1069
|
+
# **\[Custom snapshot and AMI policies only\]** The schedules of
|
860
1070
|
# policy-defined actions for snapshot and AMI lifecycle policies. A
|
861
1071
|
# policy can have up to four schedules—one mandatory schedule and up
|
862
1072
|
# to three optional schedules.
|
863
1073
|
# @return [Array<Types::Schedule>]
|
864
1074
|
#
|
865
1075
|
# @!attribute [rw] parameters
|
866
|
-
# **\[
|
867
|
-
# for snapshot and AMI lifecycle policies.
|
1076
|
+
# **\[Custom snapshot and AMI policies only\]** A set of optional
|
1077
|
+
# parameters for snapshot and AMI lifecycle policies.
|
868
1078
|
#
|
869
1079
|
# <note markdown="1"> If you are modifying a policy that was created or previously
|
870
1080
|
# modified using the Amazon Data Lifecycle Manager console, then you
|
@@ -886,6 +1096,96 @@ module Aws::DLM
|
|
886
1096
|
# per policy.
|
887
1097
|
# @return [Array<Types::Action>]
|
888
1098
|
#
|
1099
|
+
# @!attribute [rw] policy_language
|
1100
|
+
# The type of policy to create. Specify one of the following:
|
1101
|
+
#
|
1102
|
+
# * `SIMPLIFIED` To create a default policy.
|
1103
|
+
#
|
1104
|
+
# * `STANDARD` To create a custom policy.
|
1105
|
+
# @return [String]
|
1106
|
+
#
|
1107
|
+
# @!attribute [rw] resource_type
|
1108
|
+
# **\[Default policies only\]** Specify the type of default policy to
|
1109
|
+
# create.
|
1110
|
+
#
|
1111
|
+
# * To create a default policy for EBS snapshots, that creates
|
1112
|
+
# snapshots of all volumes in the Region that do not have recent
|
1113
|
+
# backups, specify `VOLUME`.
|
1114
|
+
#
|
1115
|
+
# * To create a default policy for EBS-backed AMIs, that creates
|
1116
|
+
# EBS-backed AMIs from all instances in the Region that do not have
|
1117
|
+
# recent backups, specify `INSTANCE`.
|
1118
|
+
# @return [String]
|
1119
|
+
#
|
1120
|
+
# @!attribute [rw] create_interval
|
1121
|
+
# **\[Default policies only\]** Specifies how often the policy should
|
1122
|
+
# run and create snapshots or AMIs. The creation frequency can range
|
1123
|
+
# from 1 to 7 days. If you do not specify a value, the default is 1.
|
1124
|
+
#
|
1125
|
+
# Default: 1
|
1126
|
+
# @return [Integer]
|
1127
|
+
#
|
1128
|
+
# @!attribute [rw] retain_interval
|
1129
|
+
# **\[Default policies only\]** Specifies how long the policy should
|
1130
|
+
# retain snapshots or AMIs before deleting them. The retention period
|
1131
|
+
# can range from 2 to 14 days, but it must be greater than the
|
1132
|
+
# creation frequency to ensure that the policy retains at least 1
|
1133
|
+
# snapshot or AMI at any given time. If you do not specify a value,
|
1134
|
+
# the default is 7.
|
1135
|
+
#
|
1136
|
+
# Default: 7
|
1137
|
+
# @return [Integer]
|
1138
|
+
#
|
1139
|
+
# @!attribute [rw] copy_tags
|
1140
|
+
# **\[Default policies only\]** Indicates whether the policy should
|
1141
|
+
# copy tags from the source resource to the snapshot or AMI. If you do
|
1142
|
+
# not specify a value, the default is `false`.
|
1143
|
+
#
|
1144
|
+
# Default: false
|
1145
|
+
# @return [Boolean]
|
1146
|
+
#
|
1147
|
+
# @!attribute [rw] cross_region_copy_targets
|
1148
|
+
# **\[Default policies only\]** Specifies destination Regions for
|
1149
|
+
# snapshot or AMI copies. You can specify up to 3 destination Regions.
|
1150
|
+
# If you do not want to create cross-Region copies, omit this
|
1151
|
+
# parameter.
|
1152
|
+
# @return [Array<Types::CrossRegionCopyTarget>]
|
1153
|
+
#
|
1154
|
+
# @!attribute [rw] extend_deletion
|
1155
|
+
# **\[Default policies only\]** Defines the snapshot or AMI retention
|
1156
|
+
# behavior for the policy if the source volume or instance is deleted,
|
1157
|
+
# or if the policy enters the error, disabled, or deleted state.
|
1158
|
+
#
|
1159
|
+
# By default (**ExtendDeletion=false**):
|
1160
|
+
#
|
1161
|
+
# * If a source resource is deleted, Amazon Data Lifecycle Manager
|
1162
|
+
# will continue to delete previously created snapshots or AMIs, up
|
1163
|
+
# to but not including the last one, based on the specified
|
1164
|
+
# retention period. If you want Amazon Data Lifecycle Manager to
|
1165
|
+
# delete all snapshots or AMIs, including the last one, specify
|
1166
|
+
# `true`.
|
1167
|
+
#
|
1168
|
+
# * If a policy enters the error, disabled, or deleted state, Amazon
|
1169
|
+
# Data Lifecycle Manager stops deleting snapshots and AMIs. If you
|
1170
|
+
# want Amazon Data Lifecycle Manager to continue deleting snapshots
|
1171
|
+
# or AMIs, including the last one, if the policy enters one of these
|
1172
|
+
# states, specify `true`.
|
1173
|
+
#
|
1174
|
+
# If you enable extended deletion (**ExtendDeletion=true**), you
|
1175
|
+
# override both default behaviors simultaneously.
|
1176
|
+
#
|
1177
|
+
# If you do not specify a value, the default is `false`.
|
1178
|
+
#
|
1179
|
+
# Default: false
|
1180
|
+
# @return [Boolean]
|
1181
|
+
#
|
1182
|
+
# @!attribute [rw] exclusions
|
1183
|
+
# **\[Default policies only\]** Specifies exclusion parameters for
|
1184
|
+
# volumes or instances for which you do not want to create snapshots
|
1185
|
+
# or AMIs. The policy will not create snapshots or AMIs for target
|
1186
|
+
# resources that match any of the specified exclusion parameters.
|
1187
|
+
# @return [Types::Exclusions]
|
1188
|
+
#
|
889
1189
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/PolicyDetails AWS API Documentation
|
890
1190
|
#
|
891
1191
|
class PolicyDetails < Struct.new(
|
@@ -896,7 +1196,15 @@ module Aws::DLM
|
|
896
1196
|
:schedules,
|
897
1197
|
:parameters,
|
898
1198
|
:event_source,
|
899
|
-
:actions
|
1199
|
+
:actions,
|
1200
|
+
:policy_language,
|
1201
|
+
:resource_type,
|
1202
|
+
:create_interval,
|
1203
|
+
:retain_interval,
|
1204
|
+
:copy_tags,
|
1205
|
+
:cross_region_copy_targets,
|
1206
|
+
:extend_deletion,
|
1207
|
+
:exclusions)
|
900
1208
|
SENSITIVE = []
|
901
1209
|
include Aws::Structure
|
902
1210
|
end
|
@@ -928,13 +1236,13 @@ module Aws::DLM
|
|
928
1236
|
include Aws::Structure
|
929
1237
|
end
|
930
1238
|
|
931
|
-
# **\[
|
932
|
-
# snapshots created by snapshot policies, or for AMIs created
|
933
|
-
# policies.
|
1239
|
+
# **\[Custom snapshot and AMI policies only\]** Specifies a retention
|
1240
|
+
# rule for snapshots created by snapshot policies, or for AMIs created
|
1241
|
+
# by AMI policies.
|
934
1242
|
#
|
935
|
-
# <note markdown="1"> For snapshot policies that have an ArchiveRule, this retention
|
936
|
-
# applies to standard tier retention. When the retention threshold
|
937
|
-
# met, snapshots are moved from the standard to the archive tier.
|
1243
|
+
# <note markdown="1"> For snapshot policies that have an [ArchiveRule][1], this retention
|
1244
|
+
# rule applies to standard tier retention. When the retention threshold
|
1245
|
+
# is met, snapshots are moved from the standard to the archive tier.
|
938
1246
|
#
|
939
1247
|
# For snapshot policies that do not have an **ArchiveRule**, snapshots
|
940
1248
|
# are permanently deleted when this retention threshold is met.
|
@@ -945,27 +1253,38 @@ module Aws::DLM
|
|
945
1253
|
#
|
946
1254
|
# * **Count-based retention**
|
947
1255
|
#
|
948
|
-
# You must specify **Count**. If you specify an ArchiveRule for
|
949
|
-
# schedule, then you can specify a retention count of `0` to
|
950
|
-
# snapshots immediately after creation. If you specify a
|
951
|
-
# FastRestoreRule, ShareRule, or a CrossRegionCopyRule,
|
952
|
-
# specify a retention count of `1` or more.
|
1256
|
+
# You must specify **Count**. If you specify an [ArchiveRule][1] for
|
1257
|
+
# the schedule, then you can specify a retention count of `0` to
|
1258
|
+
# archive snapshots immediately after creation. If you specify a
|
1259
|
+
# [FastRestoreRule][2], [ShareRule][3], or a [CrossRegionCopyRule][4],
|
1260
|
+
# then you must specify a retention count of `1` or more.
|
953
1261
|
#
|
954
1262
|
# * **Age-based retention**
|
955
1263
|
#
|
956
1264
|
# You must specify **Interval** and **IntervalUnit**. If you specify
|
957
|
-
# an ArchiveRule for the schedule, then you can specify a
|
958
|
-
# interval of `0` days to archive snapshots immediately
|
959
|
-
# creation. If you specify a FastRestoreRule,
|
960
|
-
# CrossRegionCopyRule, then you must specify
|
961
|
-
# `1` day or more.
|
1265
|
+
# an [ArchiveRule][1] for the schedule, then you can specify a
|
1266
|
+
# retention interval of `0` days to archive snapshots immediately
|
1267
|
+
# after creation. If you specify a [FastRestoreRule][2],
|
1268
|
+
# [ShareRule][3], or a [CrossRegionCopyRule][4], then you must specify
|
1269
|
+
# a retention interval of `1` day or more.
|
1270
|
+
#
|
1271
|
+
#
|
1272
|
+
#
|
1273
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
1274
|
+
# [2]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html
|
1275
|
+
# [3]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html
|
1276
|
+
# [4]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html
|
962
1277
|
#
|
963
1278
|
# @!attribute [rw] count
|
964
1279
|
# The number of snapshots to retain for each volume, up to a maximum
|
965
1280
|
# of 1000. For example if you want to retain a maximum of three
|
966
1281
|
# snapshots, specify `3`. When the fourth snapshot is created, the
|
967
1282
|
# oldest retained snapshot is deleted, or it is moved to the archive
|
968
|
-
# tier if you have specified an ArchiveRule.
|
1283
|
+
# tier if you have specified an [ArchiveRule][1].
|
1284
|
+
#
|
1285
|
+
#
|
1286
|
+
#
|
1287
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
969
1288
|
# @return [Integer]
|
970
1289
|
#
|
971
1290
|
# @!attribute [rw] interval
|
@@ -978,7 +1297,11 @@ module Aws::DLM
|
|
978
1297
|
# snapshots for 3 months, specify `Interval=3` and
|
979
1298
|
# `IntervalUnit=MONTHS`. Once the snapshot has been retained for 3
|
980
1299
|
# months, it is deleted, or it is moved to the archive tier if you
|
981
|
-
# have specified an ArchiveRule.
|
1300
|
+
# have specified an [ArchiveRule][1].
|
1301
|
+
#
|
1302
|
+
#
|
1303
|
+
#
|
1304
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
982
1305
|
# @return [String]
|
983
1306
|
#
|
984
1307
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/RetainRule AWS API Documentation
|
@@ -991,7 +1314,7 @@ module Aws::DLM
|
|
991
1314
|
include Aws::Structure
|
992
1315
|
end
|
993
1316
|
|
994
|
-
# **\[
|
1317
|
+
# **\[Custom snapshot policies only\]** Describes the retention rule for
|
995
1318
|
# archived snapshots. Once the archive retention threshold is met, the
|
996
1319
|
# snapshots are permanently deleted from the archive tier.
|
997
1320
|
#
|
@@ -1042,8 +1365,8 @@ module Aws::DLM
|
|
1042
1365
|
include Aws::Structure
|
1043
1366
|
end
|
1044
1367
|
|
1045
|
-
# **\[
|
1046
|
-
# snapshot or AMI lifecycle policy.
|
1368
|
+
# **\[Custom snapshot and AMI policies only\]** Specifies a schedule for
|
1369
|
+
# a snapshot or AMI lifecycle policy.
|
1047
1370
|
#
|
1048
1371
|
# @!attribute [rw] name
|
1049
1372
|
# The name of the schedule.
|
@@ -1078,8 +1401,8 @@ module Aws::DLM
|
|
1078
1401
|
# @return [Types::RetainRule]
|
1079
1402
|
#
|
1080
1403
|
# @!attribute [rw] fast_restore_rule
|
1081
|
-
# **\[
|
1082
|
-
# restore.
|
1404
|
+
# **\[Custom snapshot policies only\]** The rule for enabling fast
|
1405
|
+
# snapshot restore.
|
1083
1406
|
# @return [Types::FastRestoreRule]
|
1084
1407
|
#
|
1085
1408
|
# @!attribute [rw] cross_region_copy_rules
|
@@ -1094,20 +1417,21 @@ module Aws::DLM
|
|
1094
1417
|
# @return [Array<Types::CrossRegionCopyRule>]
|
1095
1418
|
#
|
1096
1419
|
# @!attribute [rw] share_rules
|
1097
|
-
# **\[
|
1098
|
-
# other Amazon Web Services accounts.
|
1420
|
+
# **\[Custom snapshot policies only\]** The rule for sharing snapshots
|
1421
|
+
# with other Amazon Web Services accounts.
|
1099
1422
|
# @return [Array<Types::ShareRule>]
|
1100
1423
|
#
|
1101
1424
|
# @!attribute [rw] deprecate_rule
|
1102
|
-
# **\[AMI policies only\]** The AMI deprecation rule for the
|
1425
|
+
# **\[Custom AMI policies only\]** The AMI deprecation rule for the
|
1426
|
+
# schedule.
|
1103
1427
|
# @return [Types::DeprecateRule]
|
1104
1428
|
#
|
1105
1429
|
# @!attribute [rw] archive_rule
|
1106
|
-
# **\[
|
1107
|
-
# archiving rule for the schedule. When you specify an
|
1108
|
-
# snapshots are automatically moved from the standard
|
1109
|
-
# archive tier once the schedule's retention threshold is
|
1110
|
-
# Snapshots are then retained in the archive tier for the archive
|
1430
|
+
# **\[Custom snapshot policies that target volumes only\]** The
|
1431
|
+
# snapshot archiving rule for the schedule. When you specify an
|
1432
|
+
# archiving rule, snapshots are automatically moved from the standard
|
1433
|
+
# tier to the archive tier once the schedule's retention threshold is
|
1434
|
+
# met. Snapshots are then retained in the archive tier for the archive
|
1111
1435
|
# retention period that you specify.
|
1112
1436
|
#
|
1113
1437
|
# For more information about using snapshot archiving, see
|
@@ -1136,8 +1460,125 @@ module Aws::DLM
|
|
1136
1460
|
include Aws::Structure
|
1137
1461
|
end
|
1138
1462
|
|
1139
|
-
# **\[
|
1140
|
-
#
|
1463
|
+
# **\[Custom snapshot policies that target instances only\]**
|
1464
|
+
# Information about pre and/or post scripts for a snapshot lifecycle
|
1465
|
+
# policy that targets instances. For more information, see [ Automating
|
1466
|
+
# application-consistent snapshots with pre and post scripts][1].
|
1467
|
+
#
|
1468
|
+
#
|
1469
|
+
#
|
1470
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html
|
1471
|
+
#
|
1472
|
+
# @!attribute [rw] stages
|
1473
|
+
# Indicate which scripts Amazon Data Lifecycle Manager should run on
|
1474
|
+
# target instances. Pre scripts run before Amazon Data Lifecycle
|
1475
|
+
# Manager initiates snapshot creation. Post scripts run after Amazon
|
1476
|
+
# Data Lifecycle Manager initiates snapshot creation.
|
1477
|
+
#
|
1478
|
+
# * To run a pre script only, specify `PRE`. In this case, Amazon Data
|
1479
|
+
# Lifecycle Manager calls the SSM document with the `pre-script`
|
1480
|
+
# parameter before initiating snapshot creation.
|
1481
|
+
#
|
1482
|
+
# * To run a post script only, specify `POST`. In this case, Amazon
|
1483
|
+
# Data Lifecycle Manager calls the SSM document with the
|
1484
|
+
# `post-script` parameter after initiating snapshot creation.
|
1485
|
+
#
|
1486
|
+
# * To run both pre and post scripts, specify both `PRE` and `POST`.
|
1487
|
+
# In this case, Amazon Data Lifecycle Manager calls the SSM document
|
1488
|
+
# with the `pre-script` parameter before initiating snapshot
|
1489
|
+
# creation, and then it calls the SSM document again with the
|
1490
|
+
# `post-script` parameter after initiating snapshot creation.
|
1491
|
+
#
|
1492
|
+
# If you are automating VSS Backups, omit this parameter.
|
1493
|
+
#
|
1494
|
+
# Default: PRE and POST
|
1495
|
+
# @return [Array<String>]
|
1496
|
+
#
|
1497
|
+
# @!attribute [rw] execution_handler_service
|
1498
|
+
# Indicates the service used to execute the pre and/or post scripts.
|
1499
|
+
#
|
1500
|
+
# * If you are using custom SSM documents, specify
|
1501
|
+
# `AWS_SYSTEMS_MANAGER`.
|
1502
|
+
#
|
1503
|
+
# * If you are automating VSS Backups, omit this parameter.
|
1504
|
+
#
|
1505
|
+
# Default: AWS\_SYSTEMS\_MANAGER
|
1506
|
+
# @return [String]
|
1507
|
+
#
|
1508
|
+
# @!attribute [rw] execution_handler
|
1509
|
+
# The SSM document that includes the pre and/or post scripts to run.
|
1510
|
+
#
|
1511
|
+
# * If you are automating VSS backups, specify `AWS_VSS_BACKUP`. In
|
1512
|
+
# this case, Amazon Data Lifecycle Manager automatically uses the
|
1513
|
+
# `AWSEC2-CreateVssSnapshot` SSM document.
|
1514
|
+
#
|
1515
|
+
# * If you are using a custom SSM document that you own, specify
|
1516
|
+
# either the name or ARN of the SSM document. If you are using a
|
1517
|
+
# custom SSM document that is shared with you, specify the ARN of
|
1518
|
+
# the SSM document.
|
1519
|
+
# @return [String]
|
1520
|
+
#
|
1521
|
+
# @!attribute [rw] execute_operation_on_script_failure
|
1522
|
+
# Indicates whether Amazon Data Lifecycle Manager should default to
|
1523
|
+
# crash-consistent snapshots if the pre script fails.
|
1524
|
+
#
|
1525
|
+
# * To default to crash consistent snapshot if the pre script fails,
|
1526
|
+
# specify `true`.
|
1527
|
+
#
|
1528
|
+
# * To skip the instance for snapshot creation if the pre script
|
1529
|
+
# fails, specify `false`.
|
1530
|
+
#
|
1531
|
+
# This parameter is supported only if you run a pre script. If you run
|
1532
|
+
# a post script only, omit this parameter.
|
1533
|
+
#
|
1534
|
+
# Default: true
|
1535
|
+
# @return [Boolean]
|
1536
|
+
#
|
1537
|
+
# @!attribute [rw] execution_timeout
|
1538
|
+
# Specifies a timeout period, in seconds, after which Amazon Data
|
1539
|
+
# Lifecycle Manager fails the script run attempt if it has not
|
1540
|
+
# completed. If a script does not complete within its timeout period,
|
1541
|
+
# Amazon Data Lifecycle Manager fails the attempt. The timeout period
|
1542
|
+
# applies to the pre and post scripts individually.
|
1543
|
+
#
|
1544
|
+
# If you are automating VSS Backups, omit this parameter.
|
1545
|
+
#
|
1546
|
+
# Default: 10
|
1547
|
+
# @return [Integer]
|
1548
|
+
#
|
1549
|
+
# @!attribute [rw] maximum_retry_count
|
1550
|
+
# Specifies the number of times Amazon Data Lifecycle Manager should
|
1551
|
+
# retry scripts that fail.
|
1552
|
+
#
|
1553
|
+
# * If the pre script fails, Amazon Data Lifecycle Manager retries the
|
1554
|
+
# entire snapshot creation process, including running the pre and
|
1555
|
+
# post scripts.
|
1556
|
+
#
|
1557
|
+
# * If the post script fails, Amazon Data Lifecycle Manager retries
|
1558
|
+
# the post script only; in this case, the pre script will have
|
1559
|
+
# completed and the snapshot might have been created.
|
1560
|
+
#
|
1561
|
+
# If you do not want Amazon Data Lifecycle Manager to retry failed
|
1562
|
+
# scripts, specify `0`.
|
1563
|
+
#
|
1564
|
+
# Default: 0
|
1565
|
+
# @return [Integer]
|
1566
|
+
#
|
1567
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/Script AWS API Documentation
|
1568
|
+
#
|
1569
|
+
class Script < Struct.new(
|
1570
|
+
:stages,
|
1571
|
+
:execution_handler_service,
|
1572
|
+
:execution_handler,
|
1573
|
+
:execute_operation_on_script_failure,
|
1574
|
+
:execution_timeout,
|
1575
|
+
:maximum_retry_count)
|
1576
|
+
SENSITIVE = []
|
1577
|
+
include Aws::Structure
|
1578
|
+
end
|
1579
|
+
|
1580
|
+
# **\[Custom snapshot policies only\]** Specifies a rule for sharing
|
1581
|
+
# snapshots across Amazon Web Services accounts.
|
1141
1582
|
#
|
1142
1583
|
# @!attribute [rw] target_accounts
|
1143
1584
|
# The IDs of the Amazon Web Services accounts with which to share the
|
@@ -1246,6 +1687,65 @@ module Aws::DLM
|
|
1246
1687
|
# policy type or the resource type.
|
1247
1688
|
# @return [Types::PolicyDetails]
|
1248
1689
|
#
|
1690
|
+
# @!attribute [rw] create_interval
|
1691
|
+
# **\[Default policies only\]** Specifies how often the policy should
|
1692
|
+
# run and create snapshots or AMIs. The creation frequency can range
|
1693
|
+
# from 1 to 7 days.
|
1694
|
+
# @return [Integer]
|
1695
|
+
#
|
1696
|
+
# @!attribute [rw] retain_interval
|
1697
|
+
# **\[Default policies only\]** Specifies how long the policy should
|
1698
|
+
# retain snapshots or AMIs before deleting them. The retention period
|
1699
|
+
# can range from 2 to 14 days, but it must be greater than the
|
1700
|
+
# creation frequency to ensure that the policy retains at least 1
|
1701
|
+
# snapshot or AMI at any given time.
|
1702
|
+
# @return [Integer]
|
1703
|
+
#
|
1704
|
+
# @!attribute [rw] copy_tags
|
1705
|
+
# **\[Default policies only\]** Indicates whether the policy should
|
1706
|
+
# copy tags from the source resource to the snapshot or AMI.
|
1707
|
+
# @return [Boolean]
|
1708
|
+
#
|
1709
|
+
# @!attribute [rw] extend_deletion
|
1710
|
+
# **\[Default policies only\]** Defines the snapshot or AMI retention
|
1711
|
+
# behavior for the policy if the source volume or instance is deleted,
|
1712
|
+
# or if the policy enters the error, disabled, or deleted state.
|
1713
|
+
#
|
1714
|
+
# By default (**ExtendDeletion=false**):
|
1715
|
+
#
|
1716
|
+
# * If a source resource is deleted, Amazon Data Lifecycle Manager
|
1717
|
+
# will continue to delete previously created snapshots or AMIs, up
|
1718
|
+
# to but not including the last one, based on the specified
|
1719
|
+
# retention period. If you want Amazon Data Lifecycle Manager to
|
1720
|
+
# delete all snapshots or AMIs, including the last one, specify
|
1721
|
+
# `true`.
|
1722
|
+
#
|
1723
|
+
# * If a policy enters the error, disabled, or deleted state, Amazon
|
1724
|
+
# Data Lifecycle Manager stops deleting snapshots and AMIs. If you
|
1725
|
+
# want Amazon Data Lifecycle Manager to continue deleting snapshots
|
1726
|
+
# or AMIs, including the last one, if the policy enters one of these
|
1727
|
+
# states, specify `true`.
|
1728
|
+
#
|
1729
|
+
# If you enable extended deletion (**ExtendDeletion=true**), you
|
1730
|
+
# override both default behaviors simultaneously.
|
1731
|
+
#
|
1732
|
+
# Default: false
|
1733
|
+
# @return [Boolean]
|
1734
|
+
#
|
1735
|
+
# @!attribute [rw] cross_region_copy_targets
|
1736
|
+
# **\[Default policies only\]** Specifies destination Regions for
|
1737
|
+
# snapshot or AMI copies. You can specify up to 3 destination Regions.
|
1738
|
+
# If you do not want to create cross-Region copies, omit this
|
1739
|
+
# parameter.
|
1740
|
+
# @return [Array<Types::CrossRegionCopyTarget>]
|
1741
|
+
#
|
1742
|
+
# @!attribute [rw] exclusions
|
1743
|
+
# **\[Default policies only\]** Specifies exclusion parameters for
|
1744
|
+
# volumes or instances for which you do not want to create snapshots
|
1745
|
+
# or AMIs. The policy will not create snapshots or AMIs for target
|
1746
|
+
# resources that match any of the specified exclusion parameters.
|
1747
|
+
# @return [Types::Exclusions]
|
1748
|
+
#
|
1249
1749
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/UpdateLifecyclePolicyRequest AWS API Documentation
|
1250
1750
|
#
|
1251
1751
|
class UpdateLifecyclePolicyRequest < Struct.new(
|
@@ -1253,7 +1753,13 @@ module Aws::DLM
|
|
1253
1753
|
:execution_role_arn,
|
1254
1754
|
:state,
|
1255
1755
|
:description,
|
1256
|
-
:policy_details
|
1756
|
+
:policy_details,
|
1757
|
+
:create_interval,
|
1758
|
+
:retain_interval,
|
1759
|
+
:copy_tags,
|
1760
|
+
:extend_deletion,
|
1761
|
+
:cross_region_copy_targets,
|
1762
|
+
:exclusions)
|
1257
1763
|
SENSITIVE = []
|
1258
1764
|
include Aws::Structure
|
1259
1765
|
end
|