aws-sdk-dlm 1.62.0 → 1.63.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-dlm/client.rb +35 -2
- data/lib/aws-sdk-dlm/client_api.rb +22 -0
- data/lib/aws-sdk-dlm/endpoint_provider.rb +2 -2
- data/lib/aws-sdk-dlm/types.rb +195 -29
- 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: 5d6d103595c15e7c2f064df901df357c68acf87443a13935694199fc3a1081d5
|
4
|
+
data.tar.gz: 2f24057ce0905a3f7da2337030c9c68add1dfb2506858d2e19b198a34d18eebe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: de0b7aee90998fe2fd31d4899ce695ed73e051ee28b9766a05628599bb3437d49e3897f5f6380d5d13728bf8314e38b0a5b6c539dbbe14c4d34275ab3b482f48
|
7
|
+
data.tar.gz: 81ee9777e509a29210cc2687bc5bac3b7ba64bad1237daba77dae10314082275192bfa46e877dd30b8a6133da2b1f3269b05f72959306d9e31a1df5d8fb58725
|
data/CHANGELOG.md
CHANGED
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.63.0
|
data/lib/aws-sdk-dlm/client.rb
CHANGED
@@ -450,6 +450,16 @@ module Aws::DLM
|
|
450
450
|
# interval_unit: "HOURS", # accepts HOURS
|
451
451
|
# times: ["Time"],
|
452
452
|
# cron_expression: "CronExpression",
|
453
|
+
# scripts: [
|
454
|
+
# {
|
455
|
+
# stages: ["PRE"], # accepts PRE, POST
|
456
|
+
# execution_handler_service: "AWS_SYSTEMS_MANAGER", # accepts AWS_SYSTEMS_MANAGER
|
457
|
+
# execution_handler: "ExecutionHandler", # required
|
458
|
+
# execute_operation_on_script_failure: false,
|
459
|
+
# execution_timeout: 1,
|
460
|
+
# maximum_retry_count: 1,
|
461
|
+
# },
|
462
|
+
# ],
|
453
463
|
# },
|
454
464
|
# retain_rule: {
|
455
465
|
# count: 1,
|
@@ -590,7 +600,12 @@ module Aws::DLM
|
|
590
600
|
# Gets summary information about all or the specified data lifecycle
|
591
601
|
# policies.
|
592
602
|
#
|
593
|
-
# To get complete information about a policy, use
|
603
|
+
# To get complete information about a policy, use
|
604
|
+
# [GetLifecyclePolicy][1].
|
605
|
+
#
|
606
|
+
#
|
607
|
+
#
|
608
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_GetLifecyclePolicy.html
|
594
609
|
#
|
595
610
|
# @option params [Array<String>] :policy_ids
|
596
611
|
# The identifiers of the data lifecycle policies.
|
@@ -694,6 +709,14 @@ module Aws::DLM
|
|
694
709
|
# resp.policy.policy_details.schedules[0].create_rule.times #=> Array
|
695
710
|
# resp.policy.policy_details.schedules[0].create_rule.times[0] #=> String
|
696
711
|
# resp.policy.policy_details.schedules[0].create_rule.cron_expression #=> String
|
712
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts #=> Array
|
713
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].stages #=> Array
|
714
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].stages[0] #=> String, one of "PRE", "POST"
|
715
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].execution_handler_service #=> String, one of "AWS_SYSTEMS_MANAGER"
|
716
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].execution_handler #=> String
|
717
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].execute_operation_on_script_failure #=> Boolean
|
718
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].execution_timeout #=> Integer
|
719
|
+
# resp.policy.policy_details.schedules[0].create_rule.scripts[0].maximum_retry_count #=> Integer
|
697
720
|
# resp.policy.policy_details.schedules[0].retain_rule.count #=> Integer
|
698
721
|
# resp.policy.policy_details.schedules[0].retain_rule.interval #=> Integer
|
699
722
|
# resp.policy.policy_details.schedules[0].retain_rule.interval_unit #=> String, one of "DAYS", "WEEKS", "MONTHS", "YEARS"
|
@@ -904,6 +927,16 @@ module Aws::DLM
|
|
904
927
|
# interval_unit: "HOURS", # accepts HOURS
|
905
928
|
# times: ["Time"],
|
906
929
|
# cron_expression: "CronExpression",
|
930
|
+
# scripts: [
|
931
|
+
# {
|
932
|
+
# stages: ["PRE"], # accepts PRE, POST
|
933
|
+
# execution_handler_service: "AWS_SYSTEMS_MANAGER", # accepts AWS_SYSTEMS_MANAGER
|
934
|
+
# execution_handler: "ExecutionHandler", # required
|
935
|
+
# execute_operation_on_script_failure: false,
|
936
|
+
# execution_timeout: 1,
|
937
|
+
# maximum_retry_count: 1,
|
938
|
+
# },
|
939
|
+
# ],
|
907
940
|
# },
|
908
941
|
# retain_rule: {
|
909
942
|
# count: 1,
|
@@ -1017,7 +1050,7 @@ module Aws::DLM
|
|
1017
1050
|
params: params,
|
1018
1051
|
config: config)
|
1019
1052
|
context[:gem_name] = 'aws-sdk-dlm'
|
1020
|
-
context[:gem_version] = '1.
|
1053
|
+
context[:gem_version] = '1.63.0'
|
1021
1054
|
Seahorse::Client::Request.new(handlers, context)
|
1022
1055
|
end
|
1023
1056
|
|
@@ -49,6 +49,9 @@ module Aws::DLM
|
|
49
49
|
EventTypeValues = Shapes::StringShape.new(name: 'EventTypeValues')
|
50
50
|
ExcludeBootVolume = Shapes::BooleanShape.new(name: 'ExcludeBootVolume')
|
51
51
|
ExcludeDataVolumeTagList = Shapes::ListShape.new(name: 'ExcludeDataVolumeTagList')
|
52
|
+
ExecuteOperationOnScriptFailure = Shapes::BooleanShape.new(name: 'ExecuteOperationOnScriptFailure')
|
53
|
+
ExecutionHandler = Shapes::StringShape.new(name: 'ExecutionHandler')
|
54
|
+
ExecutionHandlerServiceValues = Shapes::StringShape.new(name: 'ExecutionHandlerServiceValues')
|
52
55
|
ExecutionRoleArn = Shapes::StringShape.new(name: 'ExecutionRoleArn')
|
53
56
|
FastRestoreRule = Shapes::StructureShape.new(name: 'FastRestoreRule')
|
54
57
|
GetLifecyclePoliciesRequest = Shapes::StructureShape.new(name: 'GetLifecyclePoliciesRequest')
|
@@ -88,11 +91,17 @@ module Aws::DLM
|
|
88
91
|
Schedule = Shapes::StructureShape.new(name: 'Schedule')
|
89
92
|
ScheduleList = Shapes::ListShape.new(name: 'ScheduleList')
|
90
93
|
ScheduleName = Shapes::StringShape.new(name: 'ScheduleName')
|
94
|
+
Script = Shapes::StructureShape.new(name: 'Script')
|
95
|
+
ScriptExecutionTimeout = Shapes::IntegerShape.new(name: 'ScriptExecutionTimeout')
|
96
|
+
ScriptMaximumRetryCount = Shapes::IntegerShape.new(name: 'ScriptMaximumRetryCount')
|
97
|
+
ScriptsList = Shapes::ListShape.new(name: 'ScriptsList')
|
91
98
|
SettablePolicyStateValues = Shapes::StringShape.new(name: 'SettablePolicyStateValues')
|
92
99
|
ShareRule = Shapes::StructureShape.new(name: 'ShareRule')
|
93
100
|
ShareRules = Shapes::ListShape.new(name: 'ShareRules')
|
94
101
|
ShareTargetAccountList = Shapes::ListShape.new(name: 'ShareTargetAccountList')
|
95
102
|
SnapshotOwnerList = Shapes::ListShape.new(name: 'SnapshotOwnerList')
|
103
|
+
StageValues = Shapes::StringShape.new(name: 'StageValues')
|
104
|
+
StagesList = Shapes::ListShape.new(name: 'StagesList')
|
96
105
|
StandardTierRetainRuleCount = Shapes::IntegerShape.new(name: 'StandardTierRetainRuleCount')
|
97
106
|
StandardTierRetainRuleInterval = Shapes::IntegerShape.new(name: 'StandardTierRetainRuleInterval')
|
98
107
|
StatusMessage = Shapes::StringShape.new(name: 'StatusMessage')
|
@@ -149,6 +158,7 @@ module Aws::DLM
|
|
149
158
|
CreateRule.add_member(:interval_unit, Shapes::ShapeRef.new(shape: IntervalUnitValues, location_name: "IntervalUnit"))
|
150
159
|
CreateRule.add_member(:times, Shapes::ShapeRef.new(shape: TimesList, location_name: "Times"))
|
151
160
|
CreateRule.add_member(:cron_expression, Shapes::ShapeRef.new(shape: CronExpression, location_name: "CronExpression"))
|
161
|
+
CreateRule.add_member(:scripts, Shapes::ShapeRef.new(shape: ScriptsList, location_name: "Scripts"))
|
152
162
|
CreateRule.struct_class = Types::CreateRule
|
153
163
|
|
154
164
|
CrossRegionCopyAction.add_member(:target, Shapes::ShapeRef.new(shape: Target, required: true, location_name: "Target"))
|
@@ -320,6 +330,16 @@ module Aws::DLM
|
|
320
330
|
|
321
331
|
ScheduleList.member = Shapes::ShapeRef.new(shape: Schedule)
|
322
332
|
|
333
|
+
Script.add_member(:stages, Shapes::ShapeRef.new(shape: StagesList, location_name: "Stages"))
|
334
|
+
Script.add_member(:execution_handler_service, Shapes::ShapeRef.new(shape: ExecutionHandlerServiceValues, location_name: "ExecutionHandlerService"))
|
335
|
+
Script.add_member(:execution_handler, Shapes::ShapeRef.new(shape: ExecutionHandler, required: true, location_name: "ExecutionHandler"))
|
336
|
+
Script.add_member(:execute_operation_on_script_failure, Shapes::ShapeRef.new(shape: ExecuteOperationOnScriptFailure, location_name: "ExecuteOperationOnScriptFailure"))
|
337
|
+
Script.add_member(:execution_timeout, Shapes::ShapeRef.new(shape: ScriptExecutionTimeout, location_name: "ExecutionTimeout"))
|
338
|
+
Script.add_member(:maximum_retry_count, Shapes::ShapeRef.new(shape: ScriptMaximumRetryCount, location_name: "MaximumRetryCount"))
|
339
|
+
Script.struct_class = Types::Script
|
340
|
+
|
341
|
+
ScriptsList.member = Shapes::ShapeRef.new(shape: Script)
|
342
|
+
|
323
343
|
ShareRule.add_member(:target_accounts, Shapes::ShapeRef.new(shape: ShareTargetAccountList, required: true, location_name: "TargetAccounts"))
|
324
344
|
ShareRule.add_member(:unshare_interval, Shapes::ShapeRef.new(shape: Interval, location_name: "UnshareInterval"))
|
325
345
|
ShareRule.add_member(:unshare_interval_unit, Shapes::ShapeRef.new(shape: RetentionIntervalUnitValues, location_name: "UnshareIntervalUnit"))
|
@@ -331,6 +351,8 @@ module Aws::DLM
|
|
331
351
|
|
332
352
|
SnapshotOwnerList.member = Shapes::ShapeRef.new(shape: AwsAccountId)
|
333
353
|
|
354
|
+
StagesList.member = Shapes::ShapeRef.new(shape: StageValues)
|
355
|
+
|
334
356
|
Tag.add_member(:key, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Key"))
|
335
357
|
Tag.add_member(:value, Shapes::ShapeRef.new(shape: String, required: true, location_name: "Value"))
|
336
358
|
Tag.struct_class = Types::Tag
|
@@ -32,8 +32,8 @@ module Aws::DLM
|
|
32
32
|
raise ArgumentError, "FIPS and DualStack are enabled, but this partition does not support one or both"
|
33
33
|
end
|
34
34
|
if Aws::Endpoints::Matchers.boolean_equals?(use_fips, true)
|
35
|
-
if Aws::Endpoints::Matchers.boolean_equals?(
|
36
|
-
if Aws::Endpoints::Matchers.string_equals?(
|
35
|
+
if Aws::Endpoints::Matchers.boolean_equals?(Aws::Endpoints::Matchers.attr(partition_result, "supportsFIPS"), true)
|
36
|
+
if Aws::Endpoints::Matchers.string_equals?(Aws::Endpoints::Matchers.attr(partition_result, "name"), "aws-us-gov")
|
37
37
|
return Aws::Endpoints::Endpoint.new(url: "https://dlm.#{region}.amazonaws.com", headers: {}, properties: {})
|
38
38
|
end
|
39
39
|
return Aws::Endpoints::Endpoint.new(url: "https://dlm-fips.#{region}.#{partition_result['dnsSuffix']}", headers: {}, properties: {})
|
data/lib/aws-sdk-dlm/types.rb
CHANGED
@@ -119,11 +119,15 @@ module Aws::DLM
|
|
119
119
|
# <note markdown="1"> * You must specify either **CronExpression**, or **Interval**,
|
120
120
|
# **IntervalUnit**, and **Times**.
|
121
121
|
#
|
122
|
-
# * If you need to specify an ArchiveRule for the schedule, then
|
123
|
-
# must specify a creation frequency of at least 28 days.
|
122
|
+
# * If you need to specify an [ArchiveRule][1] for the schedule, then
|
123
|
+
# you must specify a creation frequency of at least 28 days.
|
124
124
|
#
|
125
125
|
# </note>
|
126
126
|
#
|
127
|
+
#
|
128
|
+
#
|
129
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
130
|
+
#
|
127
131
|
# @!attribute [rw] location
|
128
132
|
# **\[Snapshot policies only\]** Specifies the destination for
|
129
133
|
# snapshots created by the policy. To create snapshots in the same
|
@@ -166,6 +170,21 @@ module Aws::DLM
|
|
166
170
|
# [1]: https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions
|
167
171
|
# @return [String]
|
168
172
|
#
|
173
|
+
# @!attribute [rw] scripts
|
174
|
+
# **\[Snapshot policies that target instances only\]** Specifies pre
|
175
|
+
# and/or post scripts for a snapshot lifecycle policy that targets
|
176
|
+
# instances. This is useful for creating application-consistent
|
177
|
+
# snapshots, or for performing specific administrative tasks before or
|
178
|
+
# after Amazon Data Lifecycle Manager initiates snapshot creation.
|
179
|
+
#
|
180
|
+
# For more information, see [Automating application-consistent
|
181
|
+
# snapshots with pre and post scripts][1].
|
182
|
+
#
|
183
|
+
#
|
184
|
+
#
|
185
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html
|
186
|
+
# @return [Array<Types::Script>]
|
187
|
+
#
|
169
188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/CreateRule AWS API Documentation
|
170
189
|
#
|
171
190
|
class CreateRule < Struct.new(
|
@@ -173,7 +192,8 @@ module Aws::DLM
|
|
173
192
|
:interval,
|
174
193
|
:interval_unit,
|
175
194
|
:times,
|
176
|
-
:cron_expression
|
195
|
+
:cron_expression,
|
196
|
+
:scripts)
|
177
197
|
SENSITIVE = []
|
178
198
|
include Aws::Structure
|
179
199
|
end
|
@@ -182,10 +202,14 @@ module Aws::DLM
|
|
182
202
|
# for event-based policies.
|
183
203
|
#
|
184
204
|
# <note markdown="1"> To specify a cross-Region copy rule for snapshot and AMI policies, use
|
185
|
-
# CrossRegionCopyRule.
|
205
|
+
# [CrossRegionCopyRule][1].
|
186
206
|
#
|
187
207
|
# </note>
|
188
208
|
#
|
209
|
+
#
|
210
|
+
#
|
211
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html
|
212
|
+
#
|
189
213
|
# @!attribute [rw] target
|
190
214
|
# The target Region.
|
191
215
|
# @return [String]
|
@@ -263,29 +287,39 @@ module Aws::DLM
|
|
263
287
|
end
|
264
288
|
|
265
289
|
# **\[Snapshot and AMI policies only\]** Specifies a cross-Region copy
|
266
|
-
# rule for snapshot and AMI policies.
|
290
|
+
# rule for a snapshot and AMI policies.
|
267
291
|
#
|
268
292
|
# <note markdown="1"> To specify a cross-Region copy action for event-based polices, use
|
269
|
-
# CrossRegionCopyAction.
|
293
|
+
# [CrossRegionCopyAction][1].
|
270
294
|
#
|
271
295
|
# </note>
|
272
296
|
#
|
297
|
+
#
|
298
|
+
#
|
299
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyAction.html
|
300
|
+
#
|
273
301
|
# @!attribute [rw] target_region
|
274
|
-
# <note markdown="1">
|
275
|
-
# **Target**
|
276
|
-
#
|
302
|
+
# <note markdown="1"> Use this parameter for AMI policies only. For snapshot policies, use
|
303
|
+
# **Target** instead. For snapshot policies created before the
|
304
|
+
# **Target** parameter was introduced, this parameter indicates the
|
305
|
+
# target Region for snapshot copies.
|
306
|
+
#
|
277
307
|
#
|
278
|
-
# For policies created before the **Target** parameter was introduced,
|
279
|
-
# this parameter indicates the target Region for snapshot copies.
|
280
308
|
#
|
281
309
|
# </note>
|
310
|
+
#
|
311
|
+
# **\[AMI policies only\]** The target Region or the Amazon Resource
|
312
|
+
# Name (ARN) of the target Outpost for the snapshot copies.
|
282
313
|
# @return [String]
|
283
314
|
#
|
284
315
|
# @!attribute [rw] target
|
285
|
-
#
|
286
|
-
#
|
316
|
+
# <note markdown="1"> Use this parameter for snapshot policies only. For AMI policies, use
|
317
|
+
# **TargetRegion** instead.
|
318
|
+
#
|
319
|
+
# </note>
|
287
320
|
#
|
288
|
-
#
|
321
|
+
# **\[Snapshot policies only\]** The target Region or the Amazon
|
322
|
+
# Resource Name (ARN) of the target Outpost for the snapshot copies.
|
289
323
|
# @return [String]
|
290
324
|
#
|
291
325
|
# @!attribute [rw] encrypted
|
@@ -932,9 +966,9 @@ module Aws::DLM
|
|
932
966
|
# snapshots created by snapshot policies, or for AMIs created by AMI
|
933
967
|
# policies.
|
934
968
|
#
|
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.
|
969
|
+
# <note markdown="1"> For snapshot policies that have an [ArchiveRule][1], this retention
|
970
|
+
# rule applies to standard tier retention. When the retention threshold
|
971
|
+
# is met, snapshots are moved from the standard to the archive tier.
|
938
972
|
#
|
939
973
|
# For snapshot policies that do not have an **ArchiveRule**, snapshots
|
940
974
|
# are permanently deleted when this retention threshold is met.
|
@@ -945,27 +979,38 @@ module Aws::DLM
|
|
945
979
|
#
|
946
980
|
# * **Count-based retention**
|
947
981
|
#
|
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.
|
982
|
+
# You must specify **Count**. If you specify an [ArchiveRule][1] for
|
983
|
+
# the schedule, then you can specify a retention count of `0` to
|
984
|
+
# archive snapshots immediately after creation. If you specify a
|
985
|
+
# [FastRestoreRule][2], [ShareRule][3], or a [CrossRegionCopyRule][4],
|
986
|
+
# then you must specify a retention count of `1` or more.
|
953
987
|
#
|
954
988
|
# * **Age-based retention**
|
955
989
|
#
|
956
990
|
# 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.
|
991
|
+
# an [ArchiveRule][1] for the schedule, then you can specify a
|
992
|
+
# retention interval of `0` days to archive snapshots immediately
|
993
|
+
# after creation. If you specify a [FastRestoreRule][2],
|
994
|
+
# [ShareRule][3], or a [CrossRegionCopyRule][4], then you must specify
|
995
|
+
# a retention interval of `1` day or more.
|
996
|
+
#
|
997
|
+
#
|
998
|
+
#
|
999
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
1000
|
+
# [2]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_FastRestoreRule.html
|
1001
|
+
# [3]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ShareRule.html
|
1002
|
+
# [4]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_CrossRegionCopyRule.html
|
962
1003
|
#
|
963
1004
|
# @!attribute [rw] count
|
964
1005
|
# The number of snapshots to retain for each volume, up to a maximum
|
965
1006
|
# of 1000. For example if you want to retain a maximum of three
|
966
1007
|
# snapshots, specify `3`. When the fourth snapshot is created, the
|
967
1008
|
# oldest retained snapshot is deleted, or it is moved to the archive
|
968
|
-
# tier if you have specified an ArchiveRule.
|
1009
|
+
# tier if you have specified an [ArchiveRule][1].
|
1010
|
+
#
|
1011
|
+
#
|
1012
|
+
#
|
1013
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
969
1014
|
# @return [Integer]
|
970
1015
|
#
|
971
1016
|
# @!attribute [rw] interval
|
@@ -978,7 +1023,11 @@ module Aws::DLM
|
|
978
1023
|
# snapshots for 3 months, specify `Interval=3` and
|
979
1024
|
# `IntervalUnit=MONTHS`. Once the snapshot has been retained for 3
|
980
1025
|
# months, it is deleted, or it is moved to the archive tier if you
|
981
|
-
# have specified an ArchiveRule.
|
1026
|
+
# have specified an [ArchiveRule][1].
|
1027
|
+
#
|
1028
|
+
#
|
1029
|
+
#
|
1030
|
+
# [1]: https://docs.aws.amazon.com/dlm/latest/APIReference/API_ArchiveRule.html
|
982
1031
|
# @return [String]
|
983
1032
|
#
|
984
1033
|
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/RetainRule AWS API Documentation
|
@@ -1136,6 +1185,123 @@ module Aws::DLM
|
|
1136
1185
|
include Aws::Structure
|
1137
1186
|
end
|
1138
1187
|
|
1188
|
+
# **\[Snapshot policies that target instances only\]** Information about
|
1189
|
+
# pre and/or post scripts for a snapshot lifecycle policy that targets
|
1190
|
+
# instances. For more information, see [ Automating
|
1191
|
+
# application-consistent snapshots with pre and post scripts][1].
|
1192
|
+
#
|
1193
|
+
#
|
1194
|
+
#
|
1195
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/automate-app-consistent-backups.html
|
1196
|
+
#
|
1197
|
+
# @!attribute [rw] stages
|
1198
|
+
# Indicate which scripts Amazon Data Lifecycle Manager should run on
|
1199
|
+
# target instances. Pre scripts run before Amazon Data Lifecycle
|
1200
|
+
# Manager initiates snapshot creation. Post scripts run after Amazon
|
1201
|
+
# Data Lifecycle Manager initiates snapshot creation.
|
1202
|
+
#
|
1203
|
+
# * To run a pre script only, specify `PRE`. In this case, Amazon Data
|
1204
|
+
# Lifecycle Manager calls the SSM document with the `pre-script`
|
1205
|
+
# parameter before initiating snapshot creation.
|
1206
|
+
#
|
1207
|
+
# * To run a post script only, specify `POST`. In this case, Amazon
|
1208
|
+
# Data Lifecycle Manager calls the SSM document with the
|
1209
|
+
# `post-script` parameter after initiating snapshot creation.
|
1210
|
+
#
|
1211
|
+
# * To run both pre and post scripts, specify both `PRE` and `POST`.
|
1212
|
+
# In this case, Amazon Data Lifecycle Manager calls the SSM document
|
1213
|
+
# with the `pre-script` parameter before initiating snapshot
|
1214
|
+
# creation, and then it calls the SSM document again with the
|
1215
|
+
# `post-script` parameter after initiating snapshot creation.
|
1216
|
+
#
|
1217
|
+
# If you are automating VSS Backups, omit this parameter.
|
1218
|
+
#
|
1219
|
+
# Default: PRE and POST
|
1220
|
+
# @return [Array<String>]
|
1221
|
+
#
|
1222
|
+
# @!attribute [rw] execution_handler_service
|
1223
|
+
# Indicates the service used to execute the pre and/or post scripts.
|
1224
|
+
#
|
1225
|
+
# * If you are using custom SSM documents, specify
|
1226
|
+
# `AWS_SYSTEMS_MANAGER`.
|
1227
|
+
#
|
1228
|
+
# * If you are automating VSS Backups, omit this parameter.
|
1229
|
+
#
|
1230
|
+
# Default: AWS\_SYSTEMS\_MANAGER
|
1231
|
+
# @return [String]
|
1232
|
+
#
|
1233
|
+
# @!attribute [rw] execution_handler
|
1234
|
+
# The SSM document that includes the pre and/or post scripts to run.
|
1235
|
+
#
|
1236
|
+
# * If you are automating VSS backups, specify `AWS_VSS_BACKUP`. In
|
1237
|
+
# this case, Amazon Data Lifecycle Manager automatically uses the
|
1238
|
+
# `AWSEC2-CreateVssSnapshot` SSM document.
|
1239
|
+
#
|
1240
|
+
# * If you are using a custom SSM document that you own, specify
|
1241
|
+
# either the name or ARN of the SSM document. If you are using a
|
1242
|
+
# custom SSM document that is shared with you, specify the ARN of
|
1243
|
+
# the SSM document.
|
1244
|
+
# @return [String]
|
1245
|
+
#
|
1246
|
+
# @!attribute [rw] execute_operation_on_script_failure
|
1247
|
+
# Indicates whether Amazon Data Lifecycle Manager should default to
|
1248
|
+
# crash-consistent snapshots if the pre script fails.
|
1249
|
+
#
|
1250
|
+
# * To default to crash consistent snapshot if the pre script fails,
|
1251
|
+
# specify `true`.
|
1252
|
+
#
|
1253
|
+
# * To skip the instance for snapshot creation if the pre script
|
1254
|
+
# fails, specify `false`.
|
1255
|
+
#
|
1256
|
+
# This parameter is supported only if you run a pre script. If you run
|
1257
|
+
# a post script only, omit this parameter.
|
1258
|
+
#
|
1259
|
+
# Default: true
|
1260
|
+
# @return [Boolean]
|
1261
|
+
#
|
1262
|
+
# @!attribute [rw] execution_timeout
|
1263
|
+
# Specifies a timeout period, in seconds, after which Amazon Data
|
1264
|
+
# Lifecycle Manager fails the script run attempt if it has not
|
1265
|
+
# completed. If a script does not complete within its timeout period,
|
1266
|
+
# Amazon Data Lifecycle Manager fails the attempt. The timeout period
|
1267
|
+
# applies to the pre and post scripts individually.
|
1268
|
+
#
|
1269
|
+
# If you are automating VSS Backups, omit this parameter.
|
1270
|
+
#
|
1271
|
+
# Default: 10
|
1272
|
+
# @return [Integer]
|
1273
|
+
#
|
1274
|
+
# @!attribute [rw] maximum_retry_count
|
1275
|
+
# Specifies the number of times Amazon Data Lifecycle Manager should
|
1276
|
+
# retry scripts that fail.
|
1277
|
+
#
|
1278
|
+
# * If the pre script fails, Amazon Data Lifecycle Manager retries the
|
1279
|
+
# entire snapshot creation process, including running the pre and
|
1280
|
+
# post scripts.
|
1281
|
+
#
|
1282
|
+
# * If the post script fails, Amazon Data Lifecycle Manager retries
|
1283
|
+
# the post script only; in this case, the pre script will have
|
1284
|
+
# completed and the snapshot might have been created.
|
1285
|
+
#
|
1286
|
+
# If you do not want Amazon Data Lifecycle Manager to retry failed
|
1287
|
+
# scripts, specify `0`.
|
1288
|
+
#
|
1289
|
+
# Default: 0
|
1290
|
+
# @return [Integer]
|
1291
|
+
#
|
1292
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/dlm-2018-01-12/Script AWS API Documentation
|
1293
|
+
#
|
1294
|
+
class Script < Struct.new(
|
1295
|
+
:stages,
|
1296
|
+
:execution_handler_service,
|
1297
|
+
:execution_handler,
|
1298
|
+
:execute_operation_on_script_failure,
|
1299
|
+
:execution_timeout,
|
1300
|
+
:maximum_retry_count)
|
1301
|
+
SENSITIVE = []
|
1302
|
+
include Aws::Structure
|
1303
|
+
end
|
1304
|
+
|
1139
1305
|
# **\[Snapshot policies only\]** Specifies a rule for sharing snapshots
|
1140
1306
|
# across Amazon Web Services accounts.
|
1141
1307
|
#
|
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.63.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: 2023-
|
11
|
+
date: 2023-11-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|