aws-sdk-dlm 1.50.0 → 1.51.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-dlm/client.rb +16 -1
- data/lib/aws-sdk-dlm/client_api.rb +4 -0
- data/lib/aws-sdk-dlm/types.rb +201 -115
- data/lib/aws-sdk-dlm.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4f6ad5fd07597b7aeac6b9ee2cc8a61a093004a4f29179004fafced24d357c7b
|
4
|
+
data.tar.gz: b0db20321df4881bb70262d86558cd248acf731d0d3ccea22425e3d062624a54
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3083cea292878446be722980293f68ba60590139ced2c9a47579d3e5187b9624b5b6cff31bd768037f5c6d6e03f8ef60bc877c1db6c118ca8475b483e4c7eb39
|
7
|
+
data.tar.gz: 9576b7fbf6557975d66890ead405a3f6e217ae2d01487f6d8395960bc7088848a517b6cec62c44b7c7ba81eb9b4782a5552ae84891f7449941d26c73e61934ca
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.51.0 (2022-08-10)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for excluding specific data (non-boot) volumes from multi-volume snapshot sets created by snapshot lifecycle policies
|
8
|
+
|
4
9
|
1.50.0 (2022-02-24)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.51.0
|
data/lib/aws-sdk-dlm/client.rb
CHANGED
@@ -459,6 +459,12 @@ module Aws::DLM
|
|
459
459
|
# parameters: {
|
460
460
|
# exclude_boot_volume: false,
|
461
461
|
# no_reboot: false,
|
462
|
+
# exclude_data_volume_tags: [
|
463
|
+
# {
|
464
|
+
# key: "String", # required
|
465
|
+
# value: "String", # required
|
466
|
+
# },
|
467
|
+
# ],
|
462
468
|
# },
|
463
469
|
# event_source: {
|
464
470
|
# type: "MANAGED_CWE", # required, accepts MANAGED_CWE
|
@@ -663,6 +669,9 @@ module Aws::DLM
|
|
663
669
|
# resp.policy.policy_details.schedules[0].deprecate_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
|
664
670
|
# resp.policy.policy_details.parameters.exclude_boot_volume #=> Boolean
|
665
671
|
# resp.policy.policy_details.parameters.no_reboot #=> Boolean
|
672
|
+
# resp.policy.policy_details.parameters.exclude_data_volume_tags #=> Array
|
673
|
+
# resp.policy.policy_details.parameters.exclude_data_volume_tags[0].key #=> String
|
674
|
+
# resp.policy.policy_details.parameters.exclude_data_volume_tags[0].value #=> String
|
666
675
|
# resp.policy.policy_details.event_source.type #=> String, one of "MANAGED_CWE"
|
667
676
|
# resp.policy.policy_details.event_source.parameters.event_type #=> String, one of "shareSnapshot"
|
668
677
|
# resp.policy.policy_details.event_source.parameters.snapshot_owner #=> Array
|
@@ -878,6 +887,12 @@ module Aws::DLM
|
|
878
887
|
# parameters: {
|
879
888
|
# exclude_boot_volume: false,
|
880
889
|
# no_reboot: false,
|
890
|
+
# exclude_data_volume_tags: [
|
891
|
+
# {
|
892
|
+
# key: "String", # required
|
893
|
+
# value: "String", # required
|
894
|
+
# },
|
895
|
+
# ],
|
881
896
|
# },
|
882
897
|
# event_source: {
|
883
898
|
# type: "MANAGED_CWE", # required, accepts MANAGED_CWE
|
@@ -930,7 +945,7 @@ module Aws::DLM
|
|
930
945
|
params: params,
|
931
946
|
config: config)
|
932
947
|
context[:gem_name] = 'aws-sdk-dlm'
|
933
|
-
context[:gem_version] = '1.
|
948
|
+
context[:gem_version] = '1.51.0'
|
934
949
|
Seahorse::Client::Request.new(handlers, context)
|
935
950
|
end
|
936
951
|
|
@@ -46,6 +46,7 @@ module Aws::DLM
|
|
46
46
|
EventSourceValues = Shapes::StringShape.new(name: 'EventSourceValues')
|
47
47
|
EventTypeValues = Shapes::StringShape.new(name: 'EventTypeValues')
|
48
48
|
ExcludeBootVolume = Shapes::BooleanShape.new(name: 'ExcludeBootVolume')
|
49
|
+
ExcludeDataVolumeTagList = Shapes::ListShape.new(name: 'ExcludeDataVolumeTagList')
|
49
50
|
ExecutionRoleArn = Shapes::StringShape.new(name: 'ExecutionRoleArn')
|
50
51
|
FastRestoreRule = Shapes::StructureShape.new(name: 'FastRestoreRule')
|
51
52
|
GetLifecyclePoliciesRequest = Shapes::StructureShape.new(name: 'GetLifecyclePoliciesRequest')
|
@@ -188,6 +189,8 @@ module Aws::DLM
|
|
188
189
|
EventSource.add_member(:parameters, Shapes::ShapeRef.new(shape: EventParameters, location_name: "Parameters"))
|
189
190
|
EventSource.struct_class = Types::EventSource
|
190
191
|
|
192
|
+
ExcludeDataVolumeTagList.member = Shapes::ShapeRef.new(shape: Tag)
|
193
|
+
|
191
194
|
FastRestoreRule.add_member(:count, Shapes::ShapeRef.new(shape: Count, location_name: "Count"))
|
192
195
|
FastRestoreRule.add_member(:interval, Shapes::ShapeRef.new(shape: Interval, location_name: "Interval"))
|
193
196
|
FastRestoreRule.add_member(:interval_unit, Shapes::ShapeRef.new(shape: RetentionIntervalUnitValues, location_name: "IntervalUnit"))
|
@@ -256,6 +259,7 @@ module Aws::DLM
|
|
256
259
|
|
257
260
|
Parameters.add_member(:exclude_boot_volume, Shapes::ShapeRef.new(shape: ExcludeBootVolume, location_name: "ExcludeBootVolume"))
|
258
261
|
Parameters.add_member(:no_reboot, Shapes::ShapeRef.new(shape: NoReboot, location_name: "NoReboot"))
|
262
|
+
Parameters.add_member(:exclude_data_volume_tags, Shapes::ShapeRef.new(shape: ExcludeDataVolumeTagList, location_name: "ExcludeDataVolumeTags"))
|
259
263
|
Parameters.struct_class = Types::Parameters
|
260
264
|
|
261
265
|
PolicyDetails.add_member(:policy_type, Shapes::ShapeRef.new(shape: PolicyTypeValues, location_name: "PolicyType"))
|
data/lib/aws-sdk-dlm/types.rb
CHANGED
@@ -10,7 +10,8 @@
|
|
10
10
|
module Aws::DLM
|
11
11
|
module Types
|
12
12
|
|
13
|
-
# Specifies an action for an
|
13
|
+
# **\[Event-based policies only\]** Specifies an action for an
|
14
|
+
# event-based policy.
|
14
15
|
#
|
15
16
|
# @note When making an API call, you may pass Action
|
16
17
|
# data as a hash:
|
@@ -134,6 +135,12 @@ module Aws::DLM
|
|
134
135
|
# parameters: {
|
135
136
|
# exclude_boot_volume: false,
|
136
137
|
# no_reboot: false,
|
138
|
+
# exclude_data_volume_tags: [
|
139
|
+
# {
|
140
|
+
# key: "String", # required
|
141
|
+
# value: "String", # required
|
142
|
+
# },
|
143
|
+
# ],
|
137
144
|
# },
|
138
145
|
# event_source: {
|
139
146
|
# type: "MANAGED_CWE", # required, accepts MANAGED_CWE
|
@@ -213,7 +220,8 @@ module Aws::DLM
|
|
213
220
|
include Aws::Structure
|
214
221
|
end
|
215
222
|
|
216
|
-
#
|
223
|
+
# **\[Snapshot and AMI policies only\]** Specifies when the policy
|
224
|
+
# should create snapshots or AMIs.
|
217
225
|
#
|
218
226
|
# You must specify either a Cron expression or an interval, interval
|
219
227
|
# unit, and start time. You cannot specify both.
|
@@ -230,19 +238,17 @@ module Aws::DLM
|
|
230
238
|
# }
|
231
239
|
#
|
232
240
|
# @!attribute [rw] location
|
233
|
-
# Specifies the destination for
|
234
|
-
#
|
235
|
-
# `CLOUD`. To create snapshots
|
236
|
-
# resource, specify `OUTPOST_LOCAL`.
|
237
|
-
# `CLOUD` is used by default.
|
241
|
+
# **\[Snapshot policies only\]** Specifies the destination for
|
242
|
+
# snapshots created by the policy. To create snapshots in the same
|
243
|
+
# Region as the source resource, specify `CLOUD`. To create snapshots
|
244
|
+
# on the same Outpost as the source resource, specify `OUTPOST_LOCAL`.
|
245
|
+
# If you omit this parameter, `CLOUD` is used by default.
|
238
246
|
#
|
239
247
|
# If the policy targets resources in an Amazon Web Services Region,
|
240
248
|
# then you must create snapshots in the same Region as the source
|
241
|
-
# resource.
|
242
|
-
#
|
243
|
-
#
|
244
|
-
# snapshots on the same Outpost as the source resource, or in the
|
245
|
-
# Region of that Outpost.
|
249
|
+
# resource. If the policy targets resources on an Outpost, then you
|
250
|
+
# can create snapshots on the same Outpost as the source resource, or
|
251
|
+
# in the Region of that Outpost.
|
246
252
|
# @return [String]
|
247
253
|
#
|
248
254
|
# @!attribute [rw] interval
|
@@ -285,7 +291,13 @@ module Aws::DLM
|
|
285
291
|
include Aws::Structure
|
286
292
|
end
|
287
293
|
|
288
|
-
#
|
294
|
+
# **\[Event-based policies only\]** Specifies a cross-Region copy action
|
295
|
+
# for event-based policies.
|
296
|
+
#
|
297
|
+
# <note markdown="1"> To specify a cross-Region copy rule for snapshot and AMI policies, use
|
298
|
+
# CrossRegionCopyRule.
|
299
|
+
#
|
300
|
+
# </note>
|
289
301
|
#
|
290
302
|
# @note When making an API call, you may pass CrossRegionCopyAction
|
291
303
|
# data as a hash:
|
@@ -311,7 +323,10 @@ module Aws::DLM
|
|
311
323
|
# @return [Types::EncryptionConfiguration]
|
312
324
|
#
|
313
325
|
# @!attribute [rw] retain_rule
|
314
|
-
# Specifies
|
326
|
+
# Specifies a retention rule for cross-Region snapshot copies created
|
327
|
+
# by snapshot or event-based policies, or cross-Region AMI copies
|
328
|
+
# created by AMI policies. After the retention period expires, the
|
329
|
+
# cross-Region copy is deleted.
|
315
330
|
# @return [Types::CrossRegionCopyRetainRule]
|
316
331
|
#
|
317
332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CrossRegionCopyAction AWS API Documentation
|
@@ -324,8 +339,8 @@ module Aws::DLM
|
|
324
339
|
include Aws::Structure
|
325
340
|
end
|
326
341
|
|
327
|
-
# Specifies an AMI deprecation rule for
|
328
|
-
#
|
342
|
+
# **\[AMI policies only\]** Specifies an AMI deprecation rule for
|
343
|
+
# cross-Region AMI copies created by an AMI policy.
|
329
344
|
#
|
330
345
|
# @note When making an API call, you may pass CrossRegionCopyDeprecateRule
|
331
346
|
# data as a hash:
|
@@ -343,7 +358,9 @@ module Aws::DLM
|
|
343
358
|
# @return [Integer]
|
344
359
|
#
|
345
360
|
# @!attribute [rw] interval_unit
|
346
|
-
# The unit of time in which to measure the **Interval**.
|
361
|
+
# The unit of time in which to measure the **Interval**. For example,
|
362
|
+
# to deprecate a cross-Region AMI copy after 3 months, specify
|
363
|
+
# `Interval=3` and `IntervalUnit=MONTHS`.
|
347
364
|
# @return [String]
|
348
365
|
#
|
349
366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CrossRegionCopyDeprecateRule AWS API Documentation
|
@@ -355,7 +372,10 @@ module Aws::DLM
|
|
355
372
|
include Aws::Structure
|
356
373
|
end
|
357
374
|
|
358
|
-
# Specifies
|
375
|
+
# Specifies a retention rule for cross-Region snapshot copies created by
|
376
|
+
# snapshot or event-based policies, or cross-Region AMI copies created
|
377
|
+
# by AMI policies. After the retention period expires, the cross-Region
|
378
|
+
# copy is deleted.
|
359
379
|
#
|
360
380
|
# @note When making an API call, you may pass CrossRegionCopyRetainRule
|
361
381
|
# data as a hash:
|
@@ -366,12 +386,15 @@ module Aws::DLM
|
|
366
386
|
# }
|
367
387
|
#
|
368
388
|
# @!attribute [rw] interval
|
369
|
-
# The amount of time to retain
|
370
|
-
# years. This is equivalent to 1200 months, 5200
|
389
|
+
# The amount of time to retain a cross-Region snapshot or AMI copy.
|
390
|
+
# The maximum is 100 years. This is equivalent to 1200 months, 5200
|
391
|
+
# weeks, or 36500 days.
|
371
392
|
# @return [Integer]
|
372
393
|
#
|
373
394
|
# @!attribute [rw] interval_unit
|
374
|
-
# The unit of time for time-based retention.
|
395
|
+
# The unit of time for time-based retention. For example, to retain a
|
396
|
+
# cross-Region copy for 3 months, specify `Interval=3` and
|
397
|
+
# `IntervalUnit=MONTHS`.
|
375
398
|
# @return [String]
|
376
399
|
#
|
377
400
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CrossRegionCopyRetainRule AWS API Documentation
|
@@ -383,7 +406,13 @@ module Aws::DLM
|
|
383
406
|
include Aws::Structure
|
384
407
|
end
|
385
408
|
|
386
|
-
# Specifies a
|
409
|
+
# **\[Snapshot and AMI policies only\]** Specifies a cross-Region copy
|
410
|
+
# rule for snapshot and AMI policies.
|
411
|
+
#
|
412
|
+
# <note markdown="1"> To specify a cross-Region copy action for event-based polices, use
|
413
|
+
# CrossRegionCopyAction.
|
414
|
+
#
|
415
|
+
# </note>
|
387
416
|
#
|
388
417
|
# @note When making an API call, you may pass CrossRegionCopyRule
|
389
418
|
# data as a hash:
|
@@ -405,12 +434,14 @@ module Aws::DLM
|
|
405
434
|
# }
|
406
435
|
#
|
407
436
|
# @!attribute [rw] target_region
|
408
|
-
# Avoid using this parameter when creating new policies. Instead, use
|
437
|
+
# <note markdown="1"> Avoid using this parameter when creating new policies. Instead, use
|
409
438
|
# **Target** to specify a target Region or a target Outpost for
|
410
439
|
# snapshot copies.
|
411
440
|
#
|
412
|
-
#
|
441
|
+
# For policies created before the **Target** parameter was introduced,
|
413
442
|
# this parameter indicates the target Region for snapshot copies.
|
443
|
+
#
|
444
|
+
# </note>
|
414
445
|
# @return [String]
|
415
446
|
#
|
416
447
|
# @!attribute [rw] target
|
@@ -435,17 +466,17 @@ module Aws::DLM
|
|
435
466
|
#
|
436
467
|
# @!attribute [rw] copy_tags
|
437
468
|
# Indicates whether to copy all user-defined tags from the source
|
438
|
-
# snapshot to the cross-Region
|
469
|
+
# snapshot or AMI to the cross-Region copy.
|
439
470
|
# @return [Boolean]
|
440
471
|
#
|
441
472
|
# @!attribute [rw] retain_rule
|
442
|
-
# The retention rule that indicates how long
|
443
|
-
# retained in the destination Region.
|
473
|
+
# The retention rule that indicates how long the cross-Region snapshot
|
474
|
+
# or AMI copies are to be retained in the destination Region.
|
444
475
|
# @return [Types::CrossRegionCopyRetainRule]
|
445
476
|
#
|
446
477
|
# @!attribute [rw] deprecate_rule
|
447
|
-
# The AMI deprecation rule for cross-Region
|
448
|
-
# rule.
|
478
|
+
# **\[AMI policies only\]** The AMI deprecation rule for cross-Region
|
479
|
+
# AMI copies created by the rule.
|
449
480
|
# @return [Types::CrossRegionCopyDeprecateRule]
|
450
481
|
#
|
451
482
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CrossRegionCopyRule AWS API Documentation
|
@@ -485,7 +516,12 @@ module Aws::DLM
|
|
485
516
|
#
|
486
517
|
class DeleteLifecyclePolicyResponse < Aws::EmptyStructure; end
|
487
518
|
|
488
|
-
# Specifies an AMI deprecation rule for
|
519
|
+
# **\[AMI policies only\]** Specifies an AMI deprecation rule for AMIs
|
520
|
+
# created by an AMI lifecycle policy.
|
521
|
+
#
|
522
|
+
# For age-based schedules, you must specify **Interval** and
|
523
|
+
# **IntervalUnit**. For count-based schedules, you must specify
|
524
|
+
# **Count**.
|
489
525
|
#
|
490
526
|
# @note When making an API call, you may pass DeprecateRule
|
491
527
|
# data as a hash:
|
@@ -525,8 +561,8 @@ module Aws::DLM
|
|
525
561
|
include Aws::Structure
|
526
562
|
end
|
527
563
|
|
528
|
-
# Specifies the encryption settings
|
529
|
-
#
|
564
|
+
# **\[Event-based policies only\]** Specifies the encryption settings
|
565
|
+
# for cross-Region snapshot copies created by event-based policies.
|
530
566
|
#
|
531
567
|
# @note When making an API call, you may pass EncryptionConfiguration
|
532
568
|
# data as a hash:
|
@@ -558,7 +594,8 @@ module Aws::DLM
|
|
558
594
|
include Aws::Structure
|
559
595
|
end
|
560
596
|
|
561
|
-
# Specifies an event that
|
597
|
+
# **\[Event-based policies only\]** Specifies an event that activates an
|
598
|
+
# event-based policy.
|
562
599
|
#
|
563
600
|
# @note When making an API call, you may pass EventParameters
|
564
601
|
# data as a hash:
|
@@ -603,7 +640,8 @@ module Aws::DLM
|
|
603
640
|
include Aws::Structure
|
604
641
|
end
|
605
642
|
|
606
|
-
# Specifies an event that
|
643
|
+
# **\[Event-based policies only\]** Specifies an event that activates an
|
644
|
+
# event-based policy.
|
607
645
|
#
|
608
646
|
# @note When making an API call, you may pass EventSource
|
609
647
|
# data as a hash:
|
@@ -635,8 +673,10 @@ module Aws::DLM
|
|
635
673
|
include Aws::Structure
|
636
674
|
end
|
637
675
|
|
638
|
-
# Specifies a rule for enabling fast
|
639
|
-
#
|
676
|
+
# **\[Snapshot policies only\]** Specifies a rule for enabling fast
|
677
|
+
# snapshot restore for snapshots created by snaspshot policies. You can
|
678
|
+
# enable fast snapshot restore based on either a count or a time
|
679
|
+
# interval.
|
640
680
|
#
|
641
681
|
# @note When making an API call, you may pass FastRestoreRule
|
642
682
|
# data as a hash:
|
@@ -815,7 +855,8 @@ module Aws::DLM
|
|
815
855
|
include Aws::Structure
|
816
856
|
end
|
817
857
|
|
818
|
-
# Detailed information about a
|
858
|
+
# **\[All policy types\]** Detailed information about a snapshot, AMI,
|
859
|
+
# or event-based lifecycle policy.
|
819
860
|
#
|
820
861
|
# @!attribute [rw] policy_id
|
821
862
|
# The identifier of the lifecycle policy.
|
@@ -897,7 +938,9 @@ module Aws::DLM
|
|
897
938
|
# The type of policy. `EBS_SNAPSHOT_MANAGEMENT` indicates that the
|
898
939
|
# policy manages the lifecycle of Amazon EBS snapshots.
|
899
940
|
# `IMAGE_MANAGEMENT` indicates that the policy manages the lifecycle
|
900
|
-
# of EBS-backed AMIs.
|
941
|
+
# of EBS-backed AMIs. `EVENT_BASED_POLICY` indicates that the policy
|
942
|
+
# automates cross-account snapshot copies for snapshots that are
|
943
|
+
# shared with your account.
|
901
944
|
# @return [String]
|
902
945
|
#
|
903
946
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/LifecyclePolicySummary AWS API Documentation
|
@@ -965,9 +1008,20 @@ module Aws::DLM
|
|
965
1008
|
include Aws::Structure
|
966
1009
|
end
|
967
1010
|
|
968
|
-
#
|
969
|
-
#
|
970
|
-
# type.
|
1011
|
+
# **\[Snapshot and AMI policies only\]** Specifies optional parameters
|
1012
|
+
# for snapshot and AMI policies. The set of valid parameters depends on
|
1013
|
+
# the combination of policy type and target resource type.
|
1014
|
+
#
|
1015
|
+
# If you choose to exclude boot volumes and you specify tags that
|
1016
|
+
# consequently exclude all of the additional data volumes attached to an
|
1017
|
+
# instance, then Amazon DLM will not create any snapshots for the
|
1018
|
+
# affected instance, and it will emit a `SnapshotsCreateFailed` Amazon
|
1019
|
+
# CloudWatch metric. For more information, see [Monitor your policies
|
1020
|
+
# using Amazon CloudWatch][1].
|
1021
|
+
#
|
1022
|
+
#
|
1023
|
+
#
|
1024
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitor-dlm-cw-metrics.html
|
971
1025
|
#
|
972
1026
|
# @note When making an API call, you may pass Parameters
|
973
1027
|
# data as a hash:
|
@@ -975,36 +1029,53 @@ module Aws::DLM
|
|
975
1029
|
# {
|
976
1030
|
# exclude_boot_volume: false,
|
977
1031
|
# no_reboot: false,
|
1032
|
+
# exclude_data_volume_tags: [
|
1033
|
+
# {
|
1034
|
+
# key: "String", # required
|
1035
|
+
# value: "String", # required
|
1036
|
+
# },
|
1037
|
+
# ],
|
978
1038
|
# }
|
979
1039
|
#
|
980
1040
|
# @!attribute [rw] exclude_boot_volume
|
981
|
-
#
|
982
|
-
# whether to exclude the root volume from
|
983
|
-
#
|
984
|
-
#
|
985
|
-
#
|
986
|
-
#
|
987
|
-
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateSnapshots.html
|
1041
|
+
# **\[Snapshot policies that target instances only\]** Indicates
|
1042
|
+
# whether to exclude the root volume from multi-volume snapshot sets.
|
1043
|
+
# The default is `false`. If you specify `true`, then the root volumes
|
1044
|
+
# attached to targeted instances will be excluded from the
|
1045
|
+
# multi-volume snapshot sets created by the policy.
|
988
1046
|
# @return [Boolean]
|
989
1047
|
#
|
990
1048
|
# @!attribute [rw] no_reboot
|
991
|
-
#
|
992
|
-
#
|
993
|
-
#
|
994
|
-
#
|
995
|
-
#
|
1049
|
+
# **\[AMI policies only\]** Indicates whether targeted instances are
|
1050
|
+
# rebooted when the lifecycle policy runs. `true` indicates that
|
1051
|
+
# targeted instances are not rebooted when the policy runs. `false`
|
1052
|
+
# indicates that target instances are rebooted when the policy runs.
|
1053
|
+
# The default is `true` (instances are not rebooted).
|
996
1054
|
# @return [Boolean]
|
997
1055
|
#
|
1056
|
+
# @!attribute [rw] exclude_data_volume_tags
|
1057
|
+
# **\[Snapshot policies that target instances only\]** The tags used
|
1058
|
+
# to identify data (non-root) volumes to exclude from multi-volume
|
1059
|
+
# snapshot sets.
|
1060
|
+
#
|
1061
|
+
# If you create a snapshot lifecycle policy that targets instances and
|
1062
|
+
# you specify tags for this parameter, then data volumes with the
|
1063
|
+
# specified tags that are attached to targeted instances will be
|
1064
|
+
# excluded from the multi-volume snapshot sets created by the policy.
|
1065
|
+
# @return [Array<Types::Tag>]
|
1066
|
+
#
|
998
1067
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/Parameters AWS API Documentation
|
999
1068
|
#
|
1000
1069
|
class Parameters < Struct.new(
|
1001
1070
|
:exclude_boot_volume,
|
1002
|
-
:no_reboot
|
1071
|
+
:no_reboot,
|
1072
|
+
:exclude_data_volume_tags)
|
1003
1073
|
SENSITIVE = []
|
1004
1074
|
include Aws::Structure
|
1005
1075
|
end
|
1006
1076
|
|
1007
|
-
# Specifies the configuration of a lifecycle
|
1077
|
+
# **\[All policy types\]** Specifies the configuration of a lifecycle
|
1078
|
+
# policy.
|
1008
1079
|
#
|
1009
1080
|
# @note When making an API call, you may pass PolicyDetails
|
1010
1081
|
# data as a hash:
|
@@ -1087,6 +1158,12 @@ module Aws::DLM
|
|
1087
1158
|
# parameters: {
|
1088
1159
|
# exclude_boot_volume: false,
|
1089
1160
|
# no_reboot: false,
|
1161
|
+
# exclude_data_volume_tags: [
|
1162
|
+
# {
|
1163
|
+
# key: "String", # required
|
1164
|
+
# value: "String", # required
|
1165
|
+
# },
|
1166
|
+
# ],
|
1090
1167
|
# },
|
1091
1168
|
# event_source: {
|
1092
1169
|
# type: "MANAGED_CWE", # required, accepts MANAGED_CWE
|
@@ -1117,11 +1194,11 @@ module Aws::DLM
|
|
1117
1194
|
# }
|
1118
1195
|
#
|
1119
1196
|
# @!attribute [rw] policy_type
|
1120
|
-
# The valid target resource types and actions
|
1121
|
-
# Specify `EBS_SNAPSHOT_MANAGEMENT` to create a
|
1122
|
-
# manages the lifecycle of Amazon EBS snapshots.
|
1123
|
-
# `IMAGE_MANAGEMENT` to create a lifecycle policy that manages
|
1124
|
-
# lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY ` to
|
1197
|
+
# **\[All policy types\]** The valid target resource types and actions
|
1198
|
+
# a policy can manage. Specify `EBS_SNAPSHOT_MANAGEMENT` to create a
|
1199
|
+
# lifecycle policy that manages the lifecycle of Amazon EBS snapshots.
|
1200
|
+
# Specify `IMAGE_MANAGEMENT` to create a lifecycle policy that manages
|
1201
|
+
# the lifecycle of EBS-backed AMIs. Specify `EVENT_BASED_POLICY ` to
|
1125
1202
|
# create an event-based policy that performs specific actions when a
|
1126
1203
|
# defined event occurs in your Amazon Web Services account.
|
1127
1204
|
#
|
@@ -1129,20 +1206,17 @@ module Aws::DLM
|
|
1129
1206
|
# @return [String]
|
1130
1207
|
#
|
1131
1208
|
# @!attribute [rw] resource_types
|
1132
|
-
# The target resource type for snapshot
|
1133
|
-
# Use `VOLUME `to create snapshots of
|
1134
|
-
# `INSTANCE` to create multi-volume
|
1135
|
-
# instance.
|
1136
|
-
#
|
1137
|
-
# This parameter is required for snapshot and AMI policies only. If
|
1138
|
-
# you are creating an event-based policy, omit this parameter.
|
1209
|
+
# **\[Snapshot policies only\]** The target resource type for snapshot
|
1210
|
+
# and AMI lifecycle policies. Use `VOLUME `to create snapshots of
|
1211
|
+
# individual volumes or use `INSTANCE` to create multi-volume
|
1212
|
+
# snapshots from the volumes for an instance.
|
1139
1213
|
# @return [Array<String>]
|
1140
1214
|
#
|
1141
1215
|
# @!attribute [rw] resource_locations
|
1142
|
-
#
|
1143
|
-
#
|
1144
|
-
#
|
1145
|
-
# `OUTPOST`.
|
1216
|
+
# **\[Snapshot and AMI policies only\]** The location of the resources
|
1217
|
+
# to backup. If the source resources are located in an Amazon Web
|
1218
|
+
# Services Region, specify `CLOUD`. If the source resources are
|
1219
|
+
# located on an Outpost in your account, specify `OUTPOST`.
|
1146
1220
|
#
|
1147
1221
|
# If you specify `OUTPOST`, Amazon Data Lifecycle Manager backs up all
|
1148
1222
|
# resources of the specified type with matching target tags across all
|
@@ -1150,42 +1224,39 @@ module Aws::DLM
|
|
1150
1224
|
# @return [Array<String>]
|
1151
1225
|
#
|
1152
1226
|
# @!attribute [rw] target_tags
|
1153
|
-
#
|
1154
|
-
#
|
1155
|
-
# This parameter is required for snapshot and AMI policies only. If
|
1156
|
-
# you are creating an event-based policy, omit this parameter.
|
1227
|
+
# **\[Snapshot and AMI policies only\]** The single tag that
|
1228
|
+
# identifies targeted resources for this policy.
|
1157
1229
|
# @return [Array<Types::Tag>]
|
1158
1230
|
#
|
1159
1231
|
# @!attribute [rw] schedules
|
1160
|
-
#
|
1161
|
-
#
|
1162
|
-
#
|
1163
|
-
#
|
1164
|
-
# This parameter is required for snapshot and AMI policies only. If
|
1165
|
-
# you are creating an event-based policy, omit this parameter.
|
1232
|
+
# **\[Snapshot and AMI policies only\]** The schedules of
|
1233
|
+
# policy-defined actions for snapshot and AMI lifecycle policies. A
|
1234
|
+
# policy can have up to four schedules—one mandatory schedule and up
|
1235
|
+
# to three optional schedules.
|
1166
1236
|
# @return [Array<Types::Schedule>]
|
1167
1237
|
#
|
1168
1238
|
# @!attribute [rw] parameters
|
1169
|
-
# A set of optional parameters
|
1170
|
-
# policies.
|
1239
|
+
# **\[Snapshot and AMI policies only\]** A set of optional parameters
|
1240
|
+
# for snapshot and AMI lifecycle policies.
|
1241
|
+
#
|
1242
|
+
# <note markdown="1"> If you are modifying a policy that was created or previously
|
1243
|
+
# modified using the Amazon Data Lifecycle Manager console, then you
|
1244
|
+
# must include this parameter and specify either the default values or
|
1245
|
+
# the new values that you require. You can't omit this parameter or
|
1246
|
+
# set its values to null.
|
1171
1247
|
#
|
1172
|
-
#
|
1173
|
-
# you are creating an event-based policy, omit this parameter.
|
1248
|
+
# </note>
|
1174
1249
|
# @return [Types::Parameters]
|
1175
1250
|
#
|
1176
1251
|
# @!attribute [rw] event_source
|
1177
|
-
# The event that
|
1178
|
-
#
|
1179
|
-
# This parameter is required for event-based policies only. If you are
|
1180
|
-
# creating a snapshot or AMI policy, omit this parameter.
|
1252
|
+
# **\[Event-based policies only\]** The event that activates the
|
1253
|
+
# event-based policy.
|
1181
1254
|
# @return [Types::EventSource]
|
1182
1255
|
#
|
1183
1256
|
# @!attribute [rw] actions
|
1184
|
-
# The actions to be performed when
|
1185
|
-
#
|
1186
|
-
#
|
1187
|
-
# This parameter is required for event-based policies only. If you are
|
1188
|
-
# creating a snapshot or AMI policy, omit this parameter.
|
1257
|
+
# **\[Event-based policies only\]** The actions to be performed when
|
1258
|
+
# the event-based policy is activated. You can specify only one action
|
1259
|
+
# per policy.
|
1189
1260
|
# @return [Array<Types::Action>]
|
1190
1261
|
#
|
1191
1262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/PolicyDetails AWS API Documentation
|
@@ -1230,8 +1301,13 @@ module Aws::DLM
|
|
1230
1301
|
include Aws::Structure
|
1231
1302
|
end
|
1232
1303
|
|
1233
|
-
#
|
1234
|
-
# snapshots
|
1304
|
+
# **\[Snapshot and AMI policies only\]** Specifies a retention rule for
|
1305
|
+
# snapshots created by snapshot policies or for AMIs created by AMI
|
1306
|
+
# policies. You can retain snapshots based on either a count or a time
|
1307
|
+
# interval.
|
1308
|
+
#
|
1309
|
+
# You must specify either **Count**, or **Interval** and
|
1310
|
+
# **IntervalUnit**.
|
1235
1311
|
#
|
1236
1312
|
# @note When making an API call, you may pass RetainRule
|
1237
1313
|
# data as a hash:
|
@@ -1266,7 +1342,8 @@ module Aws::DLM
|
|
1266
1342
|
include Aws::Structure
|
1267
1343
|
end
|
1268
1344
|
|
1269
|
-
# Specifies a
|
1345
|
+
# **\[Snapshot and AMI policies only\]** Specifies a schedule for a
|
1346
|
+
# snapshot or AMI lifecycle policy.
|
1270
1347
|
#
|
1271
1348
|
# @note When making an API call, you may pass Schedule
|
1272
1349
|
# data as a hash:
|
@@ -1351,11 +1428,12 @@ module Aws::DLM
|
|
1351
1428
|
# @return [Array<Types::Tag>]
|
1352
1429
|
#
|
1353
1430
|
# @!attribute [rw] variable_tags
|
1354
|
-
#
|
1355
|
-
#
|
1356
|
-
#
|
1357
|
-
#
|
1358
|
-
#
|
1431
|
+
# **\[AMI policies and snapshot policies that target instances
|
1432
|
+
# only\]** A collection of key/value pairs with values determined
|
1433
|
+
# dynamically when the policy is executed. Keys may be any valid
|
1434
|
+
# Amazon EC2 tag key. Values must be in one of the two following
|
1435
|
+
# formats: `$(instance-id)` or `$(timestamp)`. Variable tags are only
|
1436
|
+
# valid for EBS Snapshot Management – Instance policies.
|
1359
1437
|
# @return [Array<Types::Tag>]
|
1360
1438
|
#
|
1361
1439
|
# @!attribute [rw] create_rule
|
@@ -1363,30 +1441,32 @@ module Aws::DLM
|
|
1363
1441
|
# @return [Types::CreateRule]
|
1364
1442
|
#
|
1365
1443
|
# @!attribute [rw] retain_rule
|
1366
|
-
# The retention rule.
|
1444
|
+
# The retention rule for snapshots or AMIs created by the policy.
|
1367
1445
|
# @return [Types::RetainRule]
|
1368
1446
|
#
|
1369
1447
|
# @!attribute [rw] fast_restore_rule
|
1370
|
-
# The rule for enabling fast snapshot
|
1448
|
+
# **\[Snapshot policies only\]** The rule for enabling fast snapshot
|
1449
|
+
# restore.
|
1371
1450
|
# @return [Types::FastRestoreRule]
|
1372
1451
|
#
|
1373
1452
|
# @!attribute [rw] cross_region_copy_rules
|
1374
|
-
#
|
1453
|
+
# Specifies a rule for copying snapshots or AMIs across regions.
|
1375
1454
|
#
|
1376
|
-
# You can
|
1377
|
-
#
|
1378
|
-
#
|
1379
|
-
#
|
1380
|
-
#
|
1455
|
+
# <note markdown="1"> You can't specify cross-Region copy rules for policies that create
|
1456
|
+
# snapshots on an Outpost. If the policy creates snapshots in a
|
1457
|
+
# Region, then snapshots can be copied to up to three Regions or
|
1458
|
+
# Outposts.
|
1459
|
+
#
|
1460
|
+
# </note>
|
1381
1461
|
# @return [Array<Types::CrossRegionCopyRule>]
|
1382
1462
|
#
|
1383
1463
|
# @!attribute [rw] share_rules
|
1384
|
-
# The rule for sharing snapshots with
|
1385
|
-
# accounts.
|
1464
|
+
# **\[Snapshot policies only\]** The rule for sharing snapshots with
|
1465
|
+
# other Amazon Web Services accounts.
|
1386
1466
|
# @return [Array<Types::ShareRule>]
|
1387
1467
|
#
|
1388
1468
|
# @!attribute [rw] deprecate_rule
|
1389
|
-
# The AMI deprecation rule for the schedule.
|
1469
|
+
# **\[AMI policies only\]** The AMI deprecation rule for the schedule.
|
1390
1470
|
# @return [Types::DeprecateRule]
|
1391
1471
|
#
|
1392
1472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/Schedule AWS API Documentation
|
@@ -1406,8 +1486,8 @@ module Aws::DLM
|
|
1406
1486
|
include Aws::Structure
|
1407
1487
|
end
|
1408
1488
|
|
1409
|
-
# Specifies a rule for sharing snapshots
|
1410
|
-
# accounts.
|
1489
|
+
# **\[Snapshot policies only\]** Specifies a rule for sharing snapshots
|
1490
|
+
# across Amazon Web Services accounts.
|
1411
1491
|
#
|
1412
1492
|
# @note When making an API call, you may pass ShareRule
|
1413
1493
|
# data as a hash:
|
@@ -1615,6 +1695,12 @@ module Aws::DLM
|
|
1615
1695
|
# parameters: {
|
1616
1696
|
# exclude_boot_volume: false,
|
1617
1697
|
# no_reboot: false,
|
1698
|
+
# exclude_data_volume_tags: [
|
1699
|
+
# {
|
1700
|
+
# key: "String", # required
|
1701
|
+
# value: "String", # required
|
1702
|
+
# },
|
1703
|
+
# ],
|
1618
1704
|
# },
|
1619
1705
|
# event_source: {
|
1620
1706
|
# type: "MANAGED_CWE", # required, accepts MANAGED_CWE
|
data/lib/aws-sdk-dlm.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-dlm
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.51.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2022-
|
11
|
+
date: 2022-08-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|