aws-sdk-backup 1.46.0 → 1.48.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 +13 -1
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +396 -11
- data/lib/aws-sdk-backup/client_api.rb +227 -0
- data/lib/aws-sdk-backup/endpoint_parameters.rb +3 -0
- data/lib/aws-sdk-backup/endpoint_provider.rb +35 -95
- data/lib/aws-sdk-backup/endpoints.rb +84 -0
- data/lib/aws-sdk-backup/plugins/endpoints.rb +12 -0
- data/lib/aws-sdk-backup/types.rb +643 -1007
- data/lib/aws-sdk-backup.rb +2 -2
- metadata +2 -2
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -12,16 +12,6 @@ module Aws::Backup
|
|
12
12
|
|
13
13
|
# A list of backup options for each resource type.
|
14
14
|
#
|
15
|
-
# @note When making an API call, you may pass AdvancedBackupSetting
|
16
|
-
# data as a hash:
|
17
|
-
#
|
18
|
-
# {
|
19
|
-
# resource_type: "ResourceType",
|
20
|
-
# backup_options: {
|
21
|
-
# "BackupOptionKey" => "BackupOptionValue",
|
22
|
-
# },
|
23
|
-
# }
|
24
|
-
#
|
25
15
|
# @!attribute [rw] resource_type
|
26
16
|
# Specifies an object containing resource type and backup options. The
|
27
17
|
# only supported resource type is Amazon EC2 instances with Windows
|
@@ -228,6 +218,16 @@ module Aws::Backup
|
|
228
218
|
# Represents the type of backup for a backup job.
|
229
219
|
# @return [String]
|
230
220
|
#
|
221
|
+
# @!attribute [rw] parent_job_id
|
222
|
+
# This uniquely identifies a request to Backup to back up a resource.
|
223
|
+
# The return will be the parent (composite) job ID.
|
224
|
+
# @return [String]
|
225
|
+
#
|
226
|
+
# @!attribute [rw] is_parent
|
227
|
+
# This is a boolean value indicating this is a parent (composite)
|
228
|
+
# backup job.
|
229
|
+
# @return [Boolean]
|
230
|
+
#
|
231
231
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJob AWS API Documentation
|
232
232
|
#
|
233
233
|
class BackupJob < Struct.new(
|
@@ -250,7 +250,9 @@ module Aws::Backup
|
|
250
250
|
:resource_type,
|
251
251
|
:bytes_transferred,
|
252
252
|
:backup_options,
|
253
|
-
:backup_type
|
253
|
+
:backup_type,
|
254
|
+
:parent_job_id,
|
255
|
+
:is_parent)
|
254
256
|
SENSITIVE = []
|
255
257
|
include Aws::Structure
|
256
258
|
end
|
@@ -288,47 +290,6 @@ module Aws::Backup
|
|
288
290
|
# `BackupRule` objects, each of which specifies a backup rule. Each rule
|
289
291
|
# in a backup plan is a separate scheduled task.
|
290
292
|
#
|
291
|
-
# @note When making an API call, you may pass BackupPlanInput
|
292
|
-
# data as a hash:
|
293
|
-
#
|
294
|
-
# {
|
295
|
-
# backup_plan_name: "BackupPlanName", # required
|
296
|
-
# rules: [ # required
|
297
|
-
# {
|
298
|
-
# rule_name: "BackupRuleName", # required
|
299
|
-
# target_backup_vault_name: "BackupVaultName", # required
|
300
|
-
# schedule_expression: "CronExpression",
|
301
|
-
# start_window_minutes: 1,
|
302
|
-
# completion_window_minutes: 1,
|
303
|
-
# lifecycle: {
|
304
|
-
# move_to_cold_storage_after_days: 1,
|
305
|
-
# delete_after_days: 1,
|
306
|
-
# },
|
307
|
-
# recovery_point_tags: {
|
308
|
-
# "TagKey" => "TagValue",
|
309
|
-
# },
|
310
|
-
# copy_actions: [
|
311
|
-
# {
|
312
|
-
# lifecycle: {
|
313
|
-
# move_to_cold_storage_after_days: 1,
|
314
|
-
# delete_after_days: 1,
|
315
|
-
# },
|
316
|
-
# destination_backup_vault_arn: "ARN", # required
|
317
|
-
# },
|
318
|
-
# ],
|
319
|
-
# enable_continuous_backup: false,
|
320
|
-
# },
|
321
|
-
# ],
|
322
|
-
# advanced_backup_settings: [
|
323
|
-
# {
|
324
|
-
# resource_type: "ResourceType",
|
325
|
-
# backup_options: {
|
326
|
-
# "BackupOptionKey" => "BackupOptionValue",
|
327
|
-
# },
|
328
|
-
# },
|
329
|
-
# ],
|
330
|
-
# }
|
331
|
-
#
|
332
293
|
# @!attribute [rw] backup_plan_name
|
333
294
|
# The display name of a backup plan. Must contain 1 to 50 alphanumeric
|
334
295
|
# or '-\_.' characters.
|
@@ -478,6 +439,8 @@ module Aws::Backup
|
|
478
439
|
# @!attribute [rw] start_window_minutes
|
479
440
|
# A value in minutes after a backup is scheduled before a job will be
|
480
441
|
# canceled if it doesn't start successfully. This value is optional.
|
442
|
+
# If this value is included, it must be at least 60 minutes to avoid
|
443
|
+
# errors.
|
481
444
|
# @return [Integer]
|
482
445
|
#
|
483
446
|
# @!attribute [rw] completion_window_minutes
|
@@ -548,34 +511,6 @@ module Aws::Backup
|
|
548
511
|
|
549
512
|
# Specifies a scheduled task used to back up a selection of resources.
|
550
513
|
#
|
551
|
-
# @note When making an API call, you may pass BackupRuleInput
|
552
|
-
# data as a hash:
|
553
|
-
#
|
554
|
-
# {
|
555
|
-
# rule_name: "BackupRuleName", # required
|
556
|
-
# target_backup_vault_name: "BackupVaultName", # required
|
557
|
-
# schedule_expression: "CronExpression",
|
558
|
-
# start_window_minutes: 1,
|
559
|
-
# completion_window_minutes: 1,
|
560
|
-
# lifecycle: {
|
561
|
-
# move_to_cold_storage_after_days: 1,
|
562
|
-
# delete_after_days: 1,
|
563
|
-
# },
|
564
|
-
# recovery_point_tags: {
|
565
|
-
# "TagKey" => "TagValue",
|
566
|
-
# },
|
567
|
-
# copy_actions: [
|
568
|
-
# {
|
569
|
-
# lifecycle: {
|
570
|
-
# move_to_cold_storage_after_days: 1,
|
571
|
-
# delete_after_days: 1,
|
572
|
-
# },
|
573
|
-
# destination_backup_vault_arn: "ARN", # required
|
574
|
-
# },
|
575
|
-
# ],
|
576
|
-
# enable_continuous_backup: false,
|
577
|
-
# }
|
578
|
-
#
|
579
514
|
# @!attribute [rw] rule_name
|
580
515
|
# A display name for a backup rule. Must contain 1 to 50 alphanumeric
|
581
516
|
# or '-\_.' characters.
|
@@ -596,6 +531,8 @@ module Aws::Backup
|
|
596
531
|
# @!attribute [rw] start_window_minutes
|
597
532
|
# A value in minutes after a backup is scheduled before a job will be
|
598
533
|
# canceled if it doesn't start successfully. This value is optional.
|
534
|
+
# If this value is included, it must be at least 60 minutes to avoid
|
535
|
+
# errors.
|
599
536
|
# @return [Integer]
|
600
537
|
#
|
601
538
|
# @!attribute [rw] completion_window_minutes
|
@@ -665,49 +602,6 @@ module Aws::Backup
|
|
665
602
|
# Backup will attempt to select all supported and opted-in storage
|
666
603
|
# resources, which could have unintended cost implications.
|
667
604
|
#
|
668
|
-
# @note When making an API call, you may pass BackupSelection
|
669
|
-
# data as a hash:
|
670
|
-
#
|
671
|
-
# {
|
672
|
-
# selection_name: "BackupSelectionName", # required
|
673
|
-
# iam_role_arn: "IAMRoleArn", # required
|
674
|
-
# resources: ["ARN"],
|
675
|
-
# list_of_tags: [
|
676
|
-
# {
|
677
|
-
# condition_type: "STRINGEQUALS", # required, accepts STRINGEQUALS
|
678
|
-
# condition_key: "ConditionKey", # required
|
679
|
-
# condition_value: "ConditionValue", # required
|
680
|
-
# },
|
681
|
-
# ],
|
682
|
-
# not_resources: ["ARN"],
|
683
|
-
# conditions: {
|
684
|
-
# string_equals: [
|
685
|
-
# {
|
686
|
-
# condition_key: "ConditionKey",
|
687
|
-
# condition_value: "ConditionValue",
|
688
|
-
# },
|
689
|
-
# ],
|
690
|
-
# string_not_equals: [
|
691
|
-
# {
|
692
|
-
# condition_key: "ConditionKey",
|
693
|
-
# condition_value: "ConditionValue",
|
694
|
-
# },
|
695
|
-
# ],
|
696
|
-
# string_like: [
|
697
|
-
# {
|
698
|
-
# condition_key: "ConditionKey",
|
699
|
-
# condition_value: "ConditionValue",
|
700
|
-
# },
|
701
|
-
# ],
|
702
|
-
# string_not_like: [
|
703
|
-
# {
|
704
|
-
# condition_key: "ConditionKey",
|
705
|
-
# condition_value: "ConditionValue",
|
706
|
-
# },
|
707
|
-
# ],
|
708
|
-
# },
|
709
|
-
# }
|
710
|
-
#
|
711
605
|
# @!attribute [rw] selection_name
|
712
606
|
# The display name of a resource selection document. Must contain 1 to
|
713
607
|
# 50 alphanumeric or '-\_.' characters.
|
@@ -994,19 +888,38 @@ module Aws::Backup
|
|
994
888
|
include Aws::Structure
|
995
889
|
end
|
996
890
|
|
891
|
+
# @!attribute [rw] legal_hold_id
|
892
|
+
# Legal hold ID required to remove the specified legal hold on a
|
893
|
+
# recovery point.
|
894
|
+
# @return [String]
|
895
|
+
#
|
896
|
+
# @!attribute [rw] cancel_description
|
897
|
+
# String describing the reason for removing the legal hold.
|
898
|
+
# @return [String]
|
899
|
+
#
|
900
|
+
# @!attribute [rw] retain_record_in_days
|
901
|
+
# The integer amount in days specifying amount of days after this API
|
902
|
+
# operation to remove legal hold.
|
903
|
+
# @return [Integer]
|
904
|
+
#
|
905
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CancelLegalHoldInput AWS API Documentation
|
906
|
+
#
|
907
|
+
class CancelLegalHoldInput < Struct.new(
|
908
|
+
:legal_hold_id,
|
909
|
+
:cancel_description,
|
910
|
+
:retain_record_in_days)
|
911
|
+
SENSITIVE = []
|
912
|
+
include Aws::Structure
|
913
|
+
end
|
914
|
+
|
915
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CancelLegalHoldOutput AWS API Documentation
|
916
|
+
#
|
917
|
+
class CancelLegalHoldOutput < Aws::EmptyStructure; end
|
918
|
+
|
997
919
|
# Contains an array of triplets made up of a condition type (such as
|
998
920
|
# `StringEquals`), a key, and a value. Used to filter resources using
|
999
921
|
# their tags and assign them to a backup plan. Case sensitive.
|
1000
922
|
#
|
1001
|
-
# @note When making an API call, you may pass Condition
|
1002
|
-
# data as a hash:
|
1003
|
-
#
|
1004
|
-
# {
|
1005
|
-
# condition_type: "STRINGEQUALS", # required, accepts STRINGEQUALS
|
1006
|
-
# condition_key: "ConditionKey", # required
|
1007
|
-
# condition_value: "ConditionValue", # required
|
1008
|
-
# }
|
1009
|
-
#
|
1010
923
|
# @!attribute [rw] condition_type
|
1011
924
|
# An operation applied to a key-value pair used to assign resources to
|
1012
925
|
# your backup plan. Condition only supports `StringEquals`. For more
|
@@ -1042,14 +955,6 @@ module Aws::Backup
|
|
1042
955
|
# Includes information about tags you define to assign tagged resources
|
1043
956
|
# to a backup plan.
|
1044
957
|
#
|
1045
|
-
# @note When making an API call, you may pass ConditionParameter
|
1046
|
-
# data as a hash:
|
1047
|
-
#
|
1048
|
-
# {
|
1049
|
-
# condition_key: "ConditionKey",
|
1050
|
-
# condition_value: "ConditionValue",
|
1051
|
-
# }
|
1052
|
-
#
|
1053
958
|
# @!attribute [rw] condition_key
|
1054
959
|
# The key in a key-value pair. For example, in the tag `Department:
|
1055
960
|
# Accounting`, `Department` is the key.
|
@@ -1072,36 +977,6 @@ module Aws::Backup
|
|
1072
977
|
# Contains information about which resources to include or exclude from
|
1073
978
|
# a backup plan using their tags. Conditions are case sensitive.
|
1074
979
|
#
|
1075
|
-
# @note When making an API call, you may pass Conditions
|
1076
|
-
# data as a hash:
|
1077
|
-
#
|
1078
|
-
# {
|
1079
|
-
# string_equals: [
|
1080
|
-
# {
|
1081
|
-
# condition_key: "ConditionKey",
|
1082
|
-
# condition_value: "ConditionValue",
|
1083
|
-
# },
|
1084
|
-
# ],
|
1085
|
-
# string_not_equals: [
|
1086
|
-
# {
|
1087
|
-
# condition_key: "ConditionKey",
|
1088
|
-
# condition_value: "ConditionValue",
|
1089
|
-
# },
|
1090
|
-
# ],
|
1091
|
-
# string_like: [
|
1092
|
-
# {
|
1093
|
-
# condition_key: "ConditionKey",
|
1094
|
-
# condition_value: "ConditionValue",
|
1095
|
-
# },
|
1096
|
-
# ],
|
1097
|
-
# string_not_like: [
|
1098
|
-
# {
|
1099
|
-
# condition_key: "ConditionKey",
|
1100
|
-
# condition_value: "ConditionValue",
|
1101
|
-
# },
|
1102
|
-
# ],
|
1103
|
-
# }
|
1104
|
-
#
|
1105
980
|
# @!attribute [rw] string_equals
|
1106
981
|
# Filters the values of your tagged resources for only those resources
|
1107
982
|
# that you tagged with the same value. Also called "exact matching."
|
@@ -1169,14 +1044,6 @@ module Aws::Backup
|
|
1169
1044
|
# period is at least `1 year`". The first parameter is `daily`. The
|
1170
1045
|
# second parameter is `1 year`.
|
1171
1046
|
#
|
1172
|
-
# @note When making an API call, you may pass ControlInputParameter
|
1173
|
-
# data as a hash:
|
1174
|
-
#
|
1175
|
-
# {
|
1176
|
-
# parameter_name: "ParameterName",
|
1177
|
-
# parameter_value: "ParameterValue",
|
1178
|
-
# }
|
1179
|
-
#
|
1180
1047
|
# @!attribute [rw] parameter_name
|
1181
1048
|
# The name of a parameter, for example, `BackupPlanFrequency`.
|
1182
1049
|
# @return [String]
|
@@ -1207,17 +1074,6 @@ module Aws::Backup
|
|
1207
1074
|
#
|
1208
1075
|
# </note>
|
1209
1076
|
#
|
1210
|
-
# @note When making an API call, you may pass ControlScope
|
1211
|
-
# data as a hash:
|
1212
|
-
#
|
1213
|
-
# {
|
1214
|
-
# compliance_resource_ids: ["string"],
|
1215
|
-
# compliance_resource_types: ["ARN"],
|
1216
|
-
# tags: {
|
1217
|
-
# "string" => "string",
|
1218
|
-
# },
|
1219
|
-
# }
|
1220
|
-
#
|
1221
1077
|
# @!attribute [rw] compliance_resource_ids
|
1222
1078
|
# The ID of the only Amazon Web Services resource that you want your
|
1223
1079
|
# control scope to contain.
|
@@ -1248,17 +1104,6 @@ module Aws::Backup
|
|
1248
1104
|
|
1249
1105
|
# The details of the copy operation.
|
1250
1106
|
#
|
1251
|
-
# @note When making an API call, you may pass CopyAction
|
1252
|
-
# data as a hash:
|
1253
|
-
#
|
1254
|
-
# {
|
1255
|
-
# lifecycle: {
|
1256
|
-
# move_to_cold_storage_after_days: 1,
|
1257
|
-
# delete_after_days: 1,
|
1258
|
-
# },
|
1259
|
-
# destination_backup_vault_arn: "ARN", # required
|
1260
|
-
# }
|
1261
|
-
#
|
1262
1107
|
# @!attribute [rw] lifecycle
|
1263
1108
|
# Contains an array of `Transition` objects specifying how long in
|
1264
1109
|
# days before a recovery point transitions to cold storage or is
|
@@ -1378,6 +1223,36 @@ module Aws::Backup
|
|
1378
1223
|
# Relational Database Service (Amazon RDS) database.
|
1379
1224
|
# @return [String]
|
1380
1225
|
#
|
1226
|
+
# @!attribute [rw] parent_job_id
|
1227
|
+
# This uniquely identifies a request to Backup to copy a resource. The
|
1228
|
+
# return will be the parent (composite) job ID.
|
1229
|
+
# @return [String]
|
1230
|
+
#
|
1231
|
+
# @!attribute [rw] is_parent
|
1232
|
+
# This is a boolean value indicating this is a parent (composite) copy
|
1233
|
+
# job.
|
1234
|
+
# @return [Boolean]
|
1235
|
+
#
|
1236
|
+
# @!attribute [rw] composite_member_identifier
|
1237
|
+
# This is the identifier of a resource within a composite group, such
|
1238
|
+
# as nested (child) recovery point belonging to a composite (parent)
|
1239
|
+
# stack. The ID is transferred from the [ logical ID][1] within a
|
1240
|
+
# stack.
|
1241
|
+
#
|
1242
|
+
#
|
1243
|
+
#
|
1244
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax
|
1245
|
+
# @return [String]
|
1246
|
+
#
|
1247
|
+
# @!attribute [rw] number_of_child_jobs
|
1248
|
+
# This is the number of child (nested) copy jobs.
|
1249
|
+
# @return [Integer]
|
1250
|
+
#
|
1251
|
+
# @!attribute [rw] child_jobs_in_state
|
1252
|
+
# This returns the statistics of the included child (nested) copy
|
1253
|
+
# jobs.
|
1254
|
+
# @return [Hash<String,Integer>]
|
1255
|
+
#
|
1381
1256
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyJob AWS API Documentation
|
1382
1257
|
#
|
1383
1258
|
class CopyJob < Struct.new(
|
@@ -1395,58 +1270,16 @@ module Aws::Backup
|
|
1395
1270
|
:backup_size_in_bytes,
|
1396
1271
|
:iam_role_arn,
|
1397
1272
|
:created_by,
|
1398
|
-
:resource_type
|
1273
|
+
:resource_type,
|
1274
|
+
:parent_job_id,
|
1275
|
+
:is_parent,
|
1276
|
+
:composite_member_identifier,
|
1277
|
+
:number_of_child_jobs,
|
1278
|
+
:child_jobs_in_state)
|
1399
1279
|
SENSITIVE = []
|
1400
1280
|
include Aws::Structure
|
1401
1281
|
end
|
1402
1282
|
|
1403
|
-
# @note When making an API call, you may pass CreateBackupPlanInput
|
1404
|
-
# data as a hash:
|
1405
|
-
#
|
1406
|
-
# {
|
1407
|
-
# backup_plan: { # required
|
1408
|
-
# backup_plan_name: "BackupPlanName", # required
|
1409
|
-
# rules: [ # required
|
1410
|
-
# {
|
1411
|
-
# rule_name: "BackupRuleName", # required
|
1412
|
-
# target_backup_vault_name: "BackupVaultName", # required
|
1413
|
-
# schedule_expression: "CronExpression",
|
1414
|
-
# start_window_minutes: 1,
|
1415
|
-
# completion_window_minutes: 1,
|
1416
|
-
# lifecycle: {
|
1417
|
-
# move_to_cold_storage_after_days: 1,
|
1418
|
-
# delete_after_days: 1,
|
1419
|
-
# },
|
1420
|
-
# recovery_point_tags: {
|
1421
|
-
# "TagKey" => "TagValue",
|
1422
|
-
# },
|
1423
|
-
# copy_actions: [
|
1424
|
-
# {
|
1425
|
-
# lifecycle: {
|
1426
|
-
# move_to_cold_storage_after_days: 1,
|
1427
|
-
# delete_after_days: 1,
|
1428
|
-
# },
|
1429
|
-
# destination_backup_vault_arn: "ARN", # required
|
1430
|
-
# },
|
1431
|
-
# ],
|
1432
|
-
# enable_continuous_backup: false,
|
1433
|
-
# },
|
1434
|
-
# ],
|
1435
|
-
# advanced_backup_settings: [
|
1436
|
-
# {
|
1437
|
-
# resource_type: "ResourceType",
|
1438
|
-
# backup_options: {
|
1439
|
-
# "BackupOptionKey" => "BackupOptionValue",
|
1440
|
-
# },
|
1441
|
-
# },
|
1442
|
-
# ],
|
1443
|
-
# },
|
1444
|
-
# backup_plan_tags: {
|
1445
|
-
# "TagKey" => "TagValue",
|
1446
|
-
# },
|
1447
|
-
# creator_request_id: "string",
|
1448
|
-
# }
|
1449
|
-
#
|
1450
1283
|
# @!attribute [rw] backup_plan
|
1451
1284
|
# Specifies the body of a backup plan. Includes a `BackupPlanName` and
|
1452
1285
|
# one or more sets of `Rules`.
|
@@ -1518,53 +1351,6 @@ module Aws::Backup
|
|
1518
1351
|
include Aws::Structure
|
1519
1352
|
end
|
1520
1353
|
|
1521
|
-
# @note When making an API call, you may pass CreateBackupSelectionInput
|
1522
|
-
# data as a hash:
|
1523
|
-
#
|
1524
|
-
# {
|
1525
|
-
# backup_plan_id: "string", # required
|
1526
|
-
# backup_selection: { # required
|
1527
|
-
# selection_name: "BackupSelectionName", # required
|
1528
|
-
# iam_role_arn: "IAMRoleArn", # required
|
1529
|
-
# resources: ["ARN"],
|
1530
|
-
# list_of_tags: [
|
1531
|
-
# {
|
1532
|
-
# condition_type: "STRINGEQUALS", # required, accepts STRINGEQUALS
|
1533
|
-
# condition_key: "ConditionKey", # required
|
1534
|
-
# condition_value: "ConditionValue", # required
|
1535
|
-
# },
|
1536
|
-
# ],
|
1537
|
-
# not_resources: ["ARN"],
|
1538
|
-
# conditions: {
|
1539
|
-
# string_equals: [
|
1540
|
-
# {
|
1541
|
-
# condition_key: "ConditionKey",
|
1542
|
-
# condition_value: "ConditionValue",
|
1543
|
-
# },
|
1544
|
-
# ],
|
1545
|
-
# string_not_equals: [
|
1546
|
-
# {
|
1547
|
-
# condition_key: "ConditionKey",
|
1548
|
-
# condition_value: "ConditionValue",
|
1549
|
-
# },
|
1550
|
-
# ],
|
1551
|
-
# string_like: [
|
1552
|
-
# {
|
1553
|
-
# condition_key: "ConditionKey",
|
1554
|
-
# condition_value: "ConditionValue",
|
1555
|
-
# },
|
1556
|
-
# ],
|
1557
|
-
# string_not_like: [
|
1558
|
-
# {
|
1559
|
-
# condition_key: "ConditionKey",
|
1560
|
-
# condition_value: "ConditionValue",
|
1561
|
-
# },
|
1562
|
-
# ],
|
1563
|
-
# },
|
1564
|
-
# },
|
1565
|
-
# creator_request_id: "string",
|
1566
|
-
# }
|
1567
|
-
#
|
1568
1354
|
# @!attribute [rw] backup_plan_id
|
1569
1355
|
# Uniquely identifies the backup plan to be associated with the
|
1570
1356
|
# selection of resources.
|
@@ -1620,18 +1406,6 @@ module Aws::Backup
|
|
1620
1406
|
include Aws::Structure
|
1621
1407
|
end
|
1622
1408
|
|
1623
|
-
# @note When making an API call, you may pass CreateBackupVaultInput
|
1624
|
-
# data as a hash:
|
1625
|
-
#
|
1626
|
-
# {
|
1627
|
-
# backup_vault_name: "BackupVaultName", # required
|
1628
|
-
# backup_vault_tags: {
|
1629
|
-
# "TagKey" => "TagValue",
|
1630
|
-
# },
|
1631
|
-
# encryption_key_arn: "ARN",
|
1632
|
-
# creator_request_id: "string",
|
1633
|
-
# }
|
1634
|
-
#
|
1635
1409
|
# @!attribute [rw] backup_vault_name
|
1636
1410
|
# The name of a logical container where backups are stored. Backup
|
1637
1411
|
# vaults are identified by names that are unique to the account used
|
@@ -1700,36 +1474,6 @@ module Aws::Backup
|
|
1700
1474
|
include Aws::Structure
|
1701
1475
|
end
|
1702
1476
|
|
1703
|
-
# @note When making an API call, you may pass CreateFrameworkInput
|
1704
|
-
# data as a hash:
|
1705
|
-
#
|
1706
|
-
# {
|
1707
|
-
# framework_name: "FrameworkName", # required
|
1708
|
-
# framework_description: "FrameworkDescription",
|
1709
|
-
# framework_controls: [ # required
|
1710
|
-
# {
|
1711
|
-
# control_name: "ControlName", # required
|
1712
|
-
# control_input_parameters: [
|
1713
|
-
# {
|
1714
|
-
# parameter_name: "ParameterName",
|
1715
|
-
# parameter_value: "ParameterValue",
|
1716
|
-
# },
|
1717
|
-
# ],
|
1718
|
-
# control_scope: {
|
1719
|
-
# compliance_resource_ids: ["string"],
|
1720
|
-
# compliance_resource_types: ["ARN"],
|
1721
|
-
# tags: {
|
1722
|
-
# "string" => "string",
|
1723
|
-
# },
|
1724
|
-
# },
|
1725
|
-
# },
|
1726
|
-
# ],
|
1727
|
-
# idempotency_token: "string",
|
1728
|
-
# framework_tags: {
|
1729
|
-
# "string" => "string",
|
1730
|
-
# },
|
1731
|
-
# }
|
1732
|
-
#
|
1733
1477
|
# @!attribute [rw] framework_name
|
1734
1478
|
# The unique name of the framework. The name must be between 1 and 256
|
1735
1479
|
# characters, starting with a letter, and consisting of letters (a-z,
|
@@ -1793,28 +1537,91 @@ module Aws::Backup
|
|
1793
1537
|
include Aws::Structure
|
1794
1538
|
end
|
1795
1539
|
|
1796
|
-
#
|
1797
|
-
#
|
1540
|
+
# @!attribute [rw] title
|
1541
|
+
# This is the string title of the legal hold.
|
1542
|
+
# @return [String]
|
1543
|
+
#
|
1544
|
+
# @!attribute [rw] description
|
1545
|
+
# This is the string description of the legal hold.
|
1546
|
+
# @return [String]
|
1547
|
+
#
|
1548
|
+
# @!attribute [rw] idempotency_token
|
1549
|
+
# This is a user-chosen string used to distinguish between otherwise
|
1550
|
+
# identical calls. Retrying a successful request with the same
|
1551
|
+
# idempotency token results in a success message with no action taken.
|
1552
|
+
# @return [String]
|
1553
|
+
#
|
1554
|
+
# @!attribute [rw] recovery_point_selection
|
1555
|
+
# This specifies criteria to assign a set of resources, such as
|
1556
|
+
# resource types or backup vaults.
|
1557
|
+
# @return [Types::RecoveryPointSelection]
|
1558
|
+
#
|
1559
|
+
# @!attribute [rw] tags
|
1560
|
+
# Optional tags to include. A tag is a key-value pair you can use to
|
1561
|
+
# manage, filter, and search for your resources. Allowed characters
|
1562
|
+
# include UTF-8 letters, numbers, spaces, and the following
|
1563
|
+
# characters: + - = . \_ : /.
|
1564
|
+
# @return [Hash<String,String>]
|
1565
|
+
#
|
1566
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLegalHoldInput AWS API Documentation
|
1567
|
+
#
|
1568
|
+
class CreateLegalHoldInput < Struct.new(
|
1569
|
+
:title,
|
1570
|
+
:description,
|
1571
|
+
:idempotency_token,
|
1572
|
+
:recovery_point_selection,
|
1573
|
+
:tags)
|
1574
|
+
SENSITIVE = [:tags]
|
1575
|
+
include Aws::Structure
|
1576
|
+
end
|
1577
|
+
|
1578
|
+
# @!attribute [rw] title
|
1579
|
+
# This is the string title of the legal hold returned after creating
|
1580
|
+
# the legal hold.
|
1581
|
+
# @return [String]
|
1582
|
+
#
|
1583
|
+
# @!attribute [rw] status
|
1584
|
+
# This displays the status of the legal hold returned after creating
|
1585
|
+
# the legal hold. Statuses can be `ACTIVE`, `PENDING`, `CANCELED`,
|
1586
|
+
# `CANCELING`, or `FAILED`.
|
1587
|
+
# @return [String]
|
1588
|
+
#
|
1589
|
+
# @!attribute [rw] description
|
1590
|
+
# This is the returned string description of the legal hold.
|
1591
|
+
# @return [String]
|
1592
|
+
#
|
1593
|
+
# @!attribute [rw] legal_hold_id
|
1594
|
+
# Legal hold ID returned for the specified legal hold on a recovery
|
1595
|
+
# point.
|
1596
|
+
# @return [String]
|
1597
|
+
#
|
1598
|
+
# @!attribute [rw] legal_hold_arn
|
1599
|
+
# This is the ARN (Amazon Resource Number) of the created legal hold.
|
1600
|
+
# @return [String]
|
1601
|
+
#
|
1602
|
+
# @!attribute [rw] creation_date
|
1603
|
+
# Time in number format when legal hold was created.
|
1604
|
+
# @return [Time]
|
1605
|
+
#
|
1606
|
+
# @!attribute [rw] recovery_point_selection
|
1607
|
+
# This specifies criteria to assign a set of resources, such as
|
1608
|
+
# resource types or backup vaults.
|
1609
|
+
# @return [Types::RecoveryPointSelection]
|
1798
1610
|
#
|
1799
|
-
#
|
1800
|
-
# report_plan_name: "ReportPlanName", # required
|
1801
|
-
# report_plan_description: "ReportPlanDescription",
|
1802
|
-
# report_delivery_channel: { # required
|
1803
|
-
# s3_bucket_name: "string", # required
|
1804
|
-
# s3_key_prefix: "string",
|
1805
|
-
# formats: ["string"],
|
1806
|
-
# },
|
1807
|
-
# report_setting: { # required
|
1808
|
-
# report_template: "string", # required
|
1809
|
-
# framework_arns: ["string"],
|
1810
|
-
# number_of_frameworks: 1,
|
1811
|
-
# },
|
1812
|
-
# report_plan_tags: {
|
1813
|
-
# "string" => "string",
|
1814
|
-
# },
|
1815
|
-
# idempotency_token: "string",
|
1816
|
-
# }
|
1611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLegalHoldOutput AWS API Documentation
|
1817
1612
|
#
|
1613
|
+
class CreateLegalHoldOutput < Struct.new(
|
1614
|
+
:title,
|
1615
|
+
:status,
|
1616
|
+
:description,
|
1617
|
+
:legal_hold_id,
|
1618
|
+
:legal_hold_arn,
|
1619
|
+
:creation_date,
|
1620
|
+
:recovery_point_selection)
|
1621
|
+
SENSITIVE = []
|
1622
|
+
include Aws::Structure
|
1623
|
+
end
|
1624
|
+
|
1818
1625
|
# @!attribute [rw] report_plan_name
|
1819
1626
|
# The unique name of the report plan. The name must be between 1 and
|
1820
1627
|
# 256 characters, starting with a letter, and consisting of letters
|
@@ -1898,13 +1705,40 @@ module Aws::Backup
|
|
1898
1705
|
include Aws::Structure
|
1899
1706
|
end
|
1900
1707
|
|
1901
|
-
#
|
1902
|
-
#
|
1708
|
+
# This is a resource filter containing FromDate: DateTime and ToDate:
|
1709
|
+
# DateTime. Both values are required. Future DateTime values are not
|
1710
|
+
# permitted.
|
1711
|
+
#
|
1712
|
+
# The date and time are in Unix format and Coordinated Universal Time
|
1713
|
+
# (UTC), and it is accurate to milliseconds ((milliseconds are
|
1714
|
+
# optional). For example, the value 1516925490.087 represents Friday,
|
1715
|
+
# January 26, 2018 12:11:30.087 AM.
|
1903
1716
|
#
|
1904
|
-
#
|
1905
|
-
#
|
1906
|
-
# }
|
1717
|
+
# @!attribute [rw] from_date
|
1718
|
+
# This value is the beginning date, inclusive.
|
1907
1719
|
#
|
1720
|
+
# The date and time are in Unix format and Coordinated Universal Time
|
1721
|
+
# (UTC), and it is accurate to milliseconds (milliseconds are
|
1722
|
+
# optional).
|
1723
|
+
# @return [Time]
|
1724
|
+
#
|
1725
|
+
# @!attribute [rw] to_date
|
1726
|
+
# This value is the end date, inclusive.
|
1727
|
+
#
|
1728
|
+
# The date and time are in Unix format and Coordinated Universal Time
|
1729
|
+
# (UTC), and it is accurate to milliseconds (milliseconds are
|
1730
|
+
# optional).
|
1731
|
+
# @return [Time]
|
1732
|
+
#
|
1733
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DateRange AWS API Documentation
|
1734
|
+
#
|
1735
|
+
class DateRange < Struct.new(
|
1736
|
+
:from_date,
|
1737
|
+
:to_date)
|
1738
|
+
SENSITIVE = []
|
1739
|
+
include Aws::Structure
|
1740
|
+
end
|
1741
|
+
|
1908
1742
|
# @!attribute [rw] backup_plan_id
|
1909
1743
|
# Uniquely identifies a backup plan.
|
1910
1744
|
# @return [String]
|
@@ -1950,14 +1784,6 @@ module Aws::Backup
|
|
1950
1784
|
include Aws::Structure
|
1951
1785
|
end
|
1952
1786
|
|
1953
|
-
# @note When making an API call, you may pass DeleteBackupSelectionInput
|
1954
|
-
# data as a hash:
|
1955
|
-
#
|
1956
|
-
# {
|
1957
|
-
# backup_plan_id: "string", # required
|
1958
|
-
# selection_id: "string", # required
|
1959
|
-
# }
|
1960
|
-
#
|
1961
1787
|
# @!attribute [rw] backup_plan_id
|
1962
1788
|
# Uniquely identifies a backup plan.
|
1963
1789
|
# @return [String]
|
@@ -1976,13 +1802,6 @@ module Aws::Backup
|
|
1976
1802
|
include Aws::Structure
|
1977
1803
|
end
|
1978
1804
|
|
1979
|
-
# @note When making an API call, you may pass DeleteBackupVaultAccessPolicyInput
|
1980
|
-
# data as a hash:
|
1981
|
-
#
|
1982
|
-
# {
|
1983
|
-
# backup_vault_name: "BackupVaultName", # required
|
1984
|
-
# }
|
1985
|
-
#
|
1986
1805
|
# @!attribute [rw] backup_vault_name
|
1987
1806
|
# The name of a logical container where backups are stored. Backup
|
1988
1807
|
# vaults are identified by names that are unique to the account used
|
@@ -1998,13 +1817,6 @@ module Aws::Backup
|
|
1998
1817
|
include Aws::Structure
|
1999
1818
|
end
|
2000
1819
|
|
2001
|
-
# @note When making an API call, you may pass DeleteBackupVaultInput
|
2002
|
-
# data as a hash:
|
2003
|
-
#
|
2004
|
-
# {
|
2005
|
-
# backup_vault_name: "string", # required
|
2006
|
-
# }
|
2007
|
-
#
|
2008
1820
|
# @!attribute [rw] backup_vault_name
|
2009
1821
|
# The name of a logical container where backups are stored. Backup
|
2010
1822
|
# vaults are identified by names that are unique to the account used
|
@@ -2020,13 +1832,6 @@ module Aws::Backup
|
|
2020
1832
|
include Aws::Structure
|
2021
1833
|
end
|
2022
1834
|
|
2023
|
-
# @note When making an API call, you may pass DeleteBackupVaultLockConfigurationInput
|
2024
|
-
# data as a hash:
|
2025
|
-
#
|
2026
|
-
# {
|
2027
|
-
# backup_vault_name: "BackupVaultName", # required
|
2028
|
-
# }
|
2029
|
-
#
|
2030
1835
|
# @!attribute [rw] backup_vault_name
|
2031
1836
|
# The name of the backup vault from which to delete Backup Vault Lock.
|
2032
1837
|
# @return [String]
|
@@ -2039,13 +1844,6 @@ module Aws::Backup
|
|
2039
1844
|
include Aws::Structure
|
2040
1845
|
end
|
2041
1846
|
|
2042
|
-
# @note When making an API call, you may pass DeleteBackupVaultNotificationsInput
|
2043
|
-
# data as a hash:
|
2044
|
-
#
|
2045
|
-
# {
|
2046
|
-
# backup_vault_name: "BackupVaultName", # required
|
2047
|
-
# }
|
2048
|
-
#
|
2049
1847
|
# @!attribute [rw] backup_vault_name
|
2050
1848
|
# The name of a logical container where backups are stored. Backup
|
2051
1849
|
# vaults are identified by names that are unique to the account used
|
@@ -2061,13 +1859,6 @@ module Aws::Backup
|
|
2061
1859
|
include Aws::Structure
|
2062
1860
|
end
|
2063
1861
|
|
2064
|
-
# @note When making an API call, you may pass DeleteFrameworkInput
|
2065
|
-
# data as a hash:
|
2066
|
-
#
|
2067
|
-
# {
|
2068
|
-
# framework_name: "FrameworkName", # required
|
2069
|
-
# }
|
2070
|
-
#
|
2071
1862
|
# @!attribute [rw] framework_name
|
2072
1863
|
# The unique name of a framework.
|
2073
1864
|
# @return [String]
|
@@ -2080,14 +1871,6 @@ module Aws::Backup
|
|
2080
1871
|
include Aws::Structure
|
2081
1872
|
end
|
2082
1873
|
|
2083
|
-
# @note When making an API call, you may pass DeleteRecoveryPointInput
|
2084
|
-
# data as a hash:
|
2085
|
-
#
|
2086
|
-
# {
|
2087
|
-
# backup_vault_name: "BackupVaultName", # required
|
2088
|
-
# recovery_point_arn: "ARN", # required
|
2089
|
-
# }
|
2090
|
-
#
|
2091
1874
|
# @!attribute [rw] backup_vault_name
|
2092
1875
|
# The name of a logical container where backups are stored. Backup
|
2093
1876
|
# vaults are identified by names that are unique to the account used
|
@@ -2110,13 +1893,6 @@ module Aws::Backup
|
|
2110
1893
|
include Aws::Structure
|
2111
1894
|
end
|
2112
1895
|
|
2113
|
-
# @note When making an API call, you may pass DeleteReportPlanInput
|
2114
|
-
# data as a hash:
|
2115
|
-
#
|
2116
|
-
# {
|
2117
|
-
# report_plan_name: "ReportPlanName", # required
|
2118
|
-
# }
|
2119
|
-
#
|
2120
1896
|
# @!attribute [rw] report_plan_name
|
2121
1897
|
# The unique name of a report plan.
|
2122
1898
|
# @return [String]
|
@@ -2155,13 +1931,6 @@ module Aws::Backup
|
|
2155
1931
|
include Aws::Structure
|
2156
1932
|
end
|
2157
1933
|
|
2158
|
-
# @note When making an API call, you may pass DescribeBackupJobInput
|
2159
|
-
# data as a hash:
|
2160
|
-
#
|
2161
|
-
# {
|
2162
|
-
# backup_job_id: "string", # required
|
2163
|
-
# }
|
2164
|
-
#
|
2165
1934
|
# @!attribute [rw] backup_job_id
|
2166
1935
|
# Uniquely identifies a request to Backup to back up a resource.
|
2167
1936
|
# @return [String]
|
@@ -2290,6 +2059,24 @@ module Aws::Backup
|
|
2290
2059
|
# `BackupType` is empty, then the backup type was a regular backup.
|
2291
2060
|
# @return [String]
|
2292
2061
|
#
|
2062
|
+
# @!attribute [rw] parent_job_id
|
2063
|
+
# This returns the parent (composite) resource backup job ID.
|
2064
|
+
# @return [String]
|
2065
|
+
#
|
2066
|
+
# @!attribute [rw] is_parent
|
2067
|
+
# This returns the boolean value that a backup job is a parent
|
2068
|
+
# (composite) job.
|
2069
|
+
# @return [Boolean]
|
2070
|
+
#
|
2071
|
+
# @!attribute [rw] number_of_child_jobs
|
2072
|
+
# This returns the number of child (nested) backup jobs.
|
2073
|
+
# @return [Integer]
|
2074
|
+
#
|
2075
|
+
# @!attribute [rw] child_jobs_in_state
|
2076
|
+
# This returns the statistics of the included child (nested) backup
|
2077
|
+
# jobs.
|
2078
|
+
# @return [Hash<String,Integer>]
|
2079
|
+
#
|
2293
2080
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJobOutput AWS API Documentation
|
2294
2081
|
#
|
2295
2082
|
class DescribeBackupJobOutput < Struct.new(
|
@@ -2312,18 +2099,15 @@ module Aws::Backup
|
|
2312
2099
|
:expected_completion_date,
|
2313
2100
|
:start_by,
|
2314
2101
|
:backup_options,
|
2315
|
-
:backup_type
|
2102
|
+
:backup_type,
|
2103
|
+
:parent_job_id,
|
2104
|
+
:is_parent,
|
2105
|
+
:number_of_child_jobs,
|
2106
|
+
:child_jobs_in_state)
|
2316
2107
|
SENSITIVE = []
|
2317
2108
|
include Aws::Structure
|
2318
2109
|
end
|
2319
2110
|
|
2320
|
-
# @note When making an API call, you may pass DescribeBackupVaultInput
|
2321
|
-
# data as a hash:
|
2322
|
-
#
|
2323
|
-
# {
|
2324
|
-
# backup_vault_name: "string", # required
|
2325
|
-
# }
|
2326
|
-
#
|
2327
2111
|
# @!attribute [rw] backup_vault_name
|
2328
2112
|
# The name of a logical container where backups are stored. Backup
|
2329
2113
|
# vaults are identified by names that are unique to the account used
|
@@ -2443,13 +2227,6 @@ module Aws::Backup
|
|
2443
2227
|
include Aws::Structure
|
2444
2228
|
end
|
2445
2229
|
|
2446
|
-
# @note When making an API call, you may pass DescribeCopyJobInput
|
2447
|
-
# data as a hash:
|
2448
|
-
#
|
2449
|
-
# {
|
2450
|
-
# copy_job_id: "string", # required
|
2451
|
-
# }
|
2452
|
-
#
|
2453
2230
|
# @!attribute [rw] copy_job_id
|
2454
2231
|
# Uniquely identifies a copy job.
|
2455
2232
|
# @return [String]
|
@@ -2474,13 +2251,6 @@ module Aws::Backup
|
|
2474
2251
|
include Aws::Structure
|
2475
2252
|
end
|
2476
2253
|
|
2477
|
-
# @note When making an API call, you may pass DescribeFrameworkInput
|
2478
|
-
# data as a hash:
|
2479
|
-
#
|
2480
|
-
# {
|
2481
|
-
# framework_name: "FrameworkName", # required
|
2482
|
-
# }
|
2483
|
-
#
|
2484
2254
|
# @!attribute [rw] framework_name
|
2485
2255
|
# The unique name of a framework.
|
2486
2256
|
# @return [String]
|
@@ -2512,10 +2282,10 @@ module Aws::Backup
|
|
2512
2282
|
# @return [Array<Types::FrameworkControl>]
|
2513
2283
|
#
|
2514
2284
|
# @!attribute [rw] creation_time
|
2515
|
-
# The date and time that a framework is created, in
|
2516
|
-
#
|
2517
|
-
#
|
2518
|
-
#
|
2285
|
+
# The date and time that a framework is created, in ISO 8601
|
2286
|
+
# representation. The value of `CreationTime` is accurate to
|
2287
|
+
# milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents
|
2288
|
+
# the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
|
2519
2289
|
# @return [Time]
|
2520
2290
|
#
|
2521
2291
|
# @!attribute [rw] deployment_status
|
@@ -2593,13 +2363,6 @@ module Aws::Backup
|
|
2593
2363
|
include Aws::Structure
|
2594
2364
|
end
|
2595
2365
|
|
2596
|
-
# @note When making an API call, you may pass DescribeProtectedResourceInput
|
2597
|
-
# data as a hash:
|
2598
|
-
#
|
2599
|
-
# {
|
2600
|
-
# resource_arn: "ARN", # required
|
2601
|
-
# }
|
2602
|
-
#
|
2603
2366
|
# @!attribute [rw] resource_arn
|
2604
2367
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
2605
2368
|
# The format of the ARN depends on the resource type.
|
@@ -2640,14 +2403,6 @@ module Aws::Backup
|
|
2640
2403
|
include Aws::Structure
|
2641
2404
|
end
|
2642
2405
|
|
2643
|
-
# @note When making an API call, you may pass DescribeRecoveryPointInput
|
2644
|
-
# data as a hash:
|
2645
|
-
#
|
2646
|
-
# {
|
2647
|
-
# backup_vault_name: "BackupVaultName", # required
|
2648
|
-
# recovery_point_arn: "ARN", # required
|
2649
|
-
# }
|
2650
|
-
#
|
2651
2406
|
# @!attribute [rw] backup_vault_name
|
2652
2407
|
# The name of a logical container where backups are stored. Backup
|
2653
2408
|
# vaults are identified by names that are unique to the account used
|
@@ -2734,6 +2489,18 @@ module Aws::Backup
|
|
2734
2489
|
# 3: Delete the recovery points][2] in the *Clean up resources*
|
2735
2490
|
# section of *Getting started*.
|
2736
2491
|
#
|
2492
|
+
# `STOPPED` status occurs on a continuous backup where a user has
|
2493
|
+
# taken some action that causes the continuous backup to be disabled.
|
2494
|
+
# This can be caused by the removal of permissions, turning off
|
2495
|
+
# versioning, turning off events being sent to EventBridge, or
|
2496
|
+
# disabling the EventBridge rules that are put in place by Backup.
|
2497
|
+
#
|
2498
|
+
# To resolve `STOPPED` status, ensure that all requested permissions
|
2499
|
+
# are in place and that versioning is enabled on the S3 bucket. Once
|
2500
|
+
# these conditions are met, the next instance of a backup rule running
|
2501
|
+
# will result in a new continuous recovery point being created. The
|
2502
|
+
# recovery points with STOPPED status do not need to be deleted.
|
2503
|
+
#
|
2737
2504
|
#
|
2738
2505
|
#
|
2739
2506
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html
|
@@ -2815,6 +2582,28 @@ module Aws::Backup
|
|
2815
2582
|
# 12:11:30.087 AM.
|
2816
2583
|
# @return [Time]
|
2817
2584
|
#
|
2585
|
+
# @!attribute [rw] parent_recovery_point_arn
|
2586
|
+
# This is an ARN that uniquely identifies a parent (composite)
|
2587
|
+
# recovery point; for example,
|
2588
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
2589
|
+
# @return [String]
|
2590
|
+
#
|
2591
|
+
# @!attribute [rw] composite_member_identifier
|
2592
|
+
# This is the identifier of a resource within a composite group, such
|
2593
|
+
# as nested (child) recovery point belonging to a composite (parent)
|
2594
|
+
# stack. The ID is transferred from the [ logical ID][1] within a
|
2595
|
+
# stack.
|
2596
|
+
#
|
2597
|
+
#
|
2598
|
+
#
|
2599
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax
|
2600
|
+
# @return [String]
|
2601
|
+
#
|
2602
|
+
# @!attribute [rw] is_parent
|
2603
|
+
# This returns the boolean value that a recovery point is a parent
|
2604
|
+
# (composite) job.
|
2605
|
+
# @return [Boolean]
|
2606
|
+
#
|
2818
2607
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointOutput AWS API Documentation
|
2819
2608
|
#
|
2820
2609
|
class DescribeRecoveryPointOutput < Struct.new(
|
@@ -2836,7 +2625,10 @@ module Aws::Backup
|
|
2836
2625
|
:encryption_key_arn,
|
2837
2626
|
:is_encrypted,
|
2838
2627
|
:storage_class,
|
2839
|
-
:last_restore_time
|
2628
|
+
:last_restore_time,
|
2629
|
+
:parent_recovery_point_arn,
|
2630
|
+
:composite_member_identifier,
|
2631
|
+
:is_parent)
|
2840
2632
|
SENSITIVE = []
|
2841
2633
|
include Aws::Structure
|
2842
2634
|
end
|
@@ -2882,13 +2674,6 @@ module Aws::Backup
|
|
2882
2674
|
include Aws::Structure
|
2883
2675
|
end
|
2884
2676
|
|
2885
|
-
# @note When making an API call, you may pass DescribeReportJobInput
|
2886
|
-
# data as a hash:
|
2887
|
-
#
|
2888
|
-
# {
|
2889
|
-
# report_job_id: "ReportJobId", # required
|
2890
|
-
# }
|
2891
|
-
#
|
2892
2677
|
# @!attribute [rw] report_job_id
|
2893
2678
|
# The identifier of the report job. A unique, randomly generated,
|
2894
2679
|
# Unicode, UTF-8 encoded string that is at most 1,024 bytes long. The
|
@@ -2917,13 +2702,6 @@ module Aws::Backup
|
|
2917
2702
|
include Aws::Structure
|
2918
2703
|
end
|
2919
2704
|
|
2920
|
-
# @note When making an API call, you may pass DescribeReportPlanInput
|
2921
|
-
# data as a hash:
|
2922
|
-
#
|
2923
|
-
# {
|
2924
|
-
# report_plan_name: "ReportPlanName", # required
|
2925
|
-
# }
|
2926
|
-
#
|
2927
2705
|
# @!attribute [rw] report_plan_name
|
2928
2706
|
# The unique name of a report plan.
|
2929
2707
|
# @return [String]
|
@@ -2951,13 +2729,6 @@ module Aws::Backup
|
|
2951
2729
|
include Aws::Structure
|
2952
2730
|
end
|
2953
2731
|
|
2954
|
-
# @note When making an API call, you may pass DescribeRestoreJobInput
|
2955
|
-
# data as a hash:
|
2956
|
-
#
|
2957
|
-
# {
|
2958
|
-
# restore_job_id: "RestoreJobId", # required
|
2959
|
-
# }
|
2960
|
-
#
|
2961
2732
|
# @!attribute [rw] restore_job_id
|
2962
2733
|
# Uniquely identifies the job that restores a recovery point.
|
2963
2734
|
# @return [String]
|
@@ -3057,14 +2828,29 @@ module Aws::Backup
|
|
3057
2828
|
include Aws::Structure
|
3058
2829
|
end
|
3059
2830
|
|
3060
|
-
#
|
3061
|
-
#
|
2831
|
+
# @!attribute [rw] backup_vault_name
|
2832
|
+
# This is the name of a logical container where the child (nested)
|
2833
|
+
# recovery point is stored. Backup vaults are identified by names that
|
2834
|
+
# are unique to the account used to create them and the Amazon Web
|
2835
|
+
# Services Region where they are created. They consist of lowercase
|
2836
|
+
# letters, numbers, and hyphens.
|
2837
|
+
# @return [String]
|
3062
2838
|
#
|
3063
|
-
#
|
3064
|
-
#
|
3065
|
-
#
|
3066
|
-
#
|
2839
|
+
# @!attribute [rw] recovery_point_arn
|
2840
|
+
# This is the Amazon Resource Name (ARN) that uniquely identifies the
|
2841
|
+
# child (nested) recovery point; for example,
|
2842
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
|
2843
|
+
# @return [String]
|
3067
2844
|
#
|
2845
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateRecoveryPointFromParentInput AWS API Documentation
|
2846
|
+
#
|
2847
|
+
class DisassociateRecoveryPointFromParentInput < Struct.new(
|
2848
|
+
:backup_vault_name,
|
2849
|
+
:recovery_point_arn)
|
2850
|
+
SENSITIVE = []
|
2851
|
+
include Aws::Structure
|
2852
|
+
end
|
2853
|
+
|
3068
2854
|
# @!attribute [rw] backup_vault_name
|
3069
2855
|
# The unique name of an Backup vault.
|
3070
2856
|
# @return [String]
|
@@ -3083,13 +2869,6 @@ module Aws::Backup
|
|
3083
2869
|
include Aws::Structure
|
3084
2870
|
end
|
3085
2871
|
|
3086
|
-
# @note When making an API call, you may pass ExportBackupPlanTemplateInput
|
3087
|
-
# data as a hash:
|
3088
|
-
#
|
3089
|
-
# {
|
3090
|
-
# backup_plan_id: "string", # required
|
3091
|
-
# }
|
3092
|
-
#
|
3093
2872
|
# @!attribute [rw] backup_plan_id
|
3094
2873
|
# Uniquely identifies a backup plan.
|
3095
2874
|
# @return [String]
|
@@ -3144,10 +2923,10 @@ module Aws::Backup
|
|
3144
2923
|
# @return [Integer]
|
3145
2924
|
#
|
3146
2925
|
# @!attribute [rw] creation_time
|
3147
|
-
# The date and time that a framework is created, in
|
3148
|
-
#
|
3149
|
-
#
|
3150
|
-
#
|
2926
|
+
# The date and time that a framework is created, in ISO 8601
|
2927
|
+
# representation. The value of `CreationTime` is accurate to
|
2928
|
+
# milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents
|
2929
|
+
# the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
|
3151
2930
|
# @return [Time]
|
3152
2931
|
#
|
3153
2932
|
# @!attribute [rw] deployment_status
|
@@ -3173,26 +2952,6 @@ module Aws::Backup
|
|
3173
2952
|
# Contains detailed information about all of the controls of a
|
3174
2953
|
# framework. Each framework must contain at least one control.
|
3175
2954
|
#
|
3176
|
-
# @note When making an API call, you may pass FrameworkControl
|
3177
|
-
# data as a hash:
|
3178
|
-
#
|
3179
|
-
# {
|
3180
|
-
# control_name: "ControlName", # required
|
3181
|
-
# control_input_parameters: [
|
3182
|
-
# {
|
3183
|
-
# parameter_name: "ParameterName",
|
3184
|
-
# parameter_value: "ParameterValue",
|
3185
|
-
# },
|
3186
|
-
# ],
|
3187
|
-
# control_scope: {
|
3188
|
-
# compliance_resource_ids: ["string"],
|
3189
|
-
# compliance_resource_types: ["ARN"],
|
3190
|
-
# tags: {
|
3191
|
-
# "string" => "string",
|
3192
|
-
# },
|
3193
|
-
# },
|
3194
|
-
# }
|
3195
|
-
#
|
3196
2955
|
# @!attribute [rw] control_name
|
3197
2956
|
# The name of a control. This name is between 1 and 256 characters.
|
3198
2957
|
# @return [String]
|
@@ -3219,13 +2978,6 @@ module Aws::Backup
|
|
3219
2978
|
include Aws::Structure
|
3220
2979
|
end
|
3221
2980
|
|
3222
|
-
# @note When making an API call, you may pass GetBackupPlanFromJSONInput
|
3223
|
-
# data as a hash:
|
3224
|
-
#
|
3225
|
-
# {
|
3226
|
-
# backup_plan_template_json: "string", # required
|
3227
|
-
# }
|
3228
|
-
#
|
3229
2981
|
# @!attribute [rw] backup_plan_template_json
|
3230
2982
|
# A customer-supplied backup plan document in JSON format.
|
3231
2983
|
# @return [String]
|
@@ -3251,13 +3003,6 @@ module Aws::Backup
|
|
3251
3003
|
include Aws::Structure
|
3252
3004
|
end
|
3253
3005
|
|
3254
|
-
# @note When making an API call, you may pass GetBackupPlanFromTemplateInput
|
3255
|
-
# data as a hash:
|
3256
|
-
#
|
3257
|
-
# {
|
3258
|
-
# backup_plan_template_id: "string", # required
|
3259
|
-
# }
|
3260
|
-
#
|
3261
3006
|
# @!attribute [rw] backup_plan_template_id
|
3262
3007
|
# Uniquely identifies a stored backup plan template.
|
3263
3008
|
# @return [String]
|
@@ -3283,14 +3028,6 @@ module Aws::Backup
|
|
3283
3028
|
include Aws::Structure
|
3284
3029
|
end
|
3285
3030
|
|
3286
|
-
# @note When making an API call, you may pass GetBackupPlanInput
|
3287
|
-
# data as a hash:
|
3288
|
-
#
|
3289
|
-
# {
|
3290
|
-
# backup_plan_id: "string", # required
|
3291
|
-
# version_id: "string",
|
3292
|
-
# }
|
3293
|
-
#
|
3294
3031
|
# @!attribute [rw] backup_plan_id
|
3295
3032
|
# Uniquely identifies a backup plan.
|
3296
3033
|
# @return [String]
|
@@ -3378,14 +3115,6 @@ module Aws::Backup
|
|
3378
3115
|
include Aws::Structure
|
3379
3116
|
end
|
3380
3117
|
|
3381
|
-
# @note When making an API call, you may pass GetBackupSelectionInput
|
3382
|
-
# data as a hash:
|
3383
|
-
#
|
3384
|
-
# {
|
3385
|
-
# backup_plan_id: "string", # required
|
3386
|
-
# selection_id: "string", # required
|
3387
|
-
# }
|
3388
|
-
#
|
3389
3118
|
# @!attribute [rw] backup_plan_id
|
3390
3119
|
# Uniquely identifies a backup plan.
|
3391
3120
|
# @return [String]
|
@@ -3443,13 +3172,6 @@ module Aws::Backup
|
|
3443
3172
|
include Aws::Structure
|
3444
3173
|
end
|
3445
3174
|
|
3446
|
-
# @note When making an API call, you may pass GetBackupVaultAccessPolicyInput
|
3447
|
-
# data as a hash:
|
3448
|
-
#
|
3449
|
-
# {
|
3450
|
-
# backup_vault_name: "BackupVaultName", # required
|
3451
|
-
# }
|
3452
|
-
#
|
3453
3175
|
# @!attribute [rw] backup_vault_name
|
3454
3176
|
# The name of a logical container where backups are stored. Backup
|
3455
3177
|
# vaults are identified by names that are unique to the account used
|
@@ -3492,13 +3214,6 @@ module Aws::Backup
|
|
3492
3214
|
include Aws::Structure
|
3493
3215
|
end
|
3494
3216
|
|
3495
|
-
# @note When making an API call, you may pass GetBackupVaultNotificationsInput
|
3496
|
-
# data as a hash:
|
3497
|
-
#
|
3498
|
-
# {
|
3499
|
-
# backup_vault_name: "BackupVaultName", # required
|
3500
|
-
# }
|
3501
|
-
#
|
3502
3217
|
# @!attribute [rw] backup_vault_name
|
3503
3218
|
# The name of a logical container where backups are stored. Backup
|
3504
3219
|
# vaults are identified by names that are unique to the account used
|
@@ -3549,14 +3264,81 @@ module Aws::Backup
|
|
3549
3264
|
include Aws::Structure
|
3550
3265
|
end
|
3551
3266
|
|
3552
|
-
#
|
3553
|
-
#
|
3267
|
+
# @!attribute [rw] legal_hold_id
|
3268
|
+
# This is the ID required to use `GetLegalHold`. This unique ID is
|
3269
|
+
# associated with a specific legal hold.
|
3270
|
+
# @return [String]
|
3271
|
+
#
|
3272
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetLegalHoldInput AWS API Documentation
|
3273
|
+
#
|
3274
|
+
class GetLegalHoldInput < Struct.new(
|
3275
|
+
:legal_hold_id)
|
3276
|
+
SENSITIVE = []
|
3277
|
+
include Aws::Structure
|
3278
|
+
end
|
3279
|
+
|
3280
|
+
# @!attribute [rw] title
|
3281
|
+
# This is the string title of the legal hold.
|
3282
|
+
# @return [String]
|
3283
|
+
#
|
3284
|
+
# @!attribute [rw] status
|
3285
|
+
# This is the status of the legal hold. Statuses can be `ACTIVE`,
|
3286
|
+
# `CREATING`, `CANCELED`, and `CANCELING`.
|
3287
|
+
# @return [String]
|
3554
3288
|
#
|
3555
|
-
#
|
3556
|
-
#
|
3557
|
-
#
|
3558
|
-
#
|
3289
|
+
# @!attribute [rw] description
|
3290
|
+
# This is the returned string description of the legal hold.
|
3291
|
+
# @return [String]
|
3292
|
+
#
|
3293
|
+
# @!attribute [rw] cancel_description
|
3294
|
+
# String describing the reason for removing the legal hold.
|
3295
|
+
# @return [String]
|
3296
|
+
#
|
3297
|
+
# @!attribute [rw] legal_hold_id
|
3298
|
+
# This is the returned ID associated with a specified legal hold.
|
3299
|
+
# @return [String]
|
3300
|
+
#
|
3301
|
+
# @!attribute [rw] legal_hold_arn
|
3302
|
+
# This is the returned framework ARN for the specified legal hold. An
|
3303
|
+
# Amazon Resource Name (ARN) uniquely identifies a resource. The
|
3304
|
+
# format of the ARN depends on the resource type.
|
3305
|
+
# @return [String]
|
3559
3306
|
#
|
3307
|
+
# @!attribute [rw] creation_date
|
3308
|
+
# Time in number format when legal hold was created.
|
3309
|
+
# @return [Time]
|
3310
|
+
#
|
3311
|
+
# @!attribute [rw] cancellation_date
|
3312
|
+
# Time in number when legal hold was cancelled.
|
3313
|
+
# @return [Time]
|
3314
|
+
#
|
3315
|
+
# @!attribute [rw] retain_record_until
|
3316
|
+
# This is the date and time until which the legal hold record will be
|
3317
|
+
# retained.
|
3318
|
+
# @return [Time]
|
3319
|
+
#
|
3320
|
+
# @!attribute [rw] recovery_point_selection
|
3321
|
+
# This specifies criteria to assign a set of resources, such as
|
3322
|
+
# resource types or backup vaults.
|
3323
|
+
# @return [Types::RecoveryPointSelection]
|
3324
|
+
#
|
3325
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetLegalHoldOutput AWS API Documentation
|
3326
|
+
#
|
3327
|
+
class GetLegalHoldOutput < Struct.new(
|
3328
|
+
:title,
|
3329
|
+
:status,
|
3330
|
+
:description,
|
3331
|
+
:cancel_description,
|
3332
|
+
:legal_hold_id,
|
3333
|
+
:legal_hold_arn,
|
3334
|
+
:creation_date,
|
3335
|
+
:cancellation_date,
|
3336
|
+
:retain_record_until,
|
3337
|
+
:recovery_point_selection)
|
3338
|
+
SENSITIVE = []
|
3339
|
+
include Aws::Structure
|
3340
|
+
end
|
3341
|
+
|
3560
3342
|
# @!attribute [rw] backup_vault_name
|
3561
3343
|
# The name of a logical container where backups are stored. Backup
|
3562
3344
|
# vaults are identified by names that are unique to the account used
|
@@ -3717,6 +3499,60 @@ module Aws::Backup
|
|
3717
3499
|
include Aws::Structure
|
3718
3500
|
end
|
3719
3501
|
|
3502
|
+
# A legal hold is an administrative tool that helps prevent backups from
|
3503
|
+
# being deleted while under a hold. While the hold is in place, backups
|
3504
|
+
# under a hold cannot be deleted and lifecycle policies that would alter
|
3505
|
+
# the backup status (such as transition to cold storage) are delayed
|
3506
|
+
# until the legal hold is removed. A backup can have more than one legal
|
3507
|
+
# hold. Legal holds are applied to one or more backups (also known as
|
3508
|
+
# recovery points). These backups can be filtered by resource types and
|
3509
|
+
# by resource IDs.
|
3510
|
+
#
|
3511
|
+
# @!attribute [rw] title
|
3512
|
+
# This is the title of a legal hold.
|
3513
|
+
# @return [String]
|
3514
|
+
#
|
3515
|
+
# @!attribute [rw] status
|
3516
|
+
# This is the status of the legal hold. Statuses can be `ACTIVE`,
|
3517
|
+
# `CREATING`, `CANCELED`, and `CANCELING`.
|
3518
|
+
# @return [String]
|
3519
|
+
#
|
3520
|
+
# @!attribute [rw] description
|
3521
|
+
# This is the description of a legal hold.
|
3522
|
+
# @return [String]
|
3523
|
+
#
|
3524
|
+
# @!attribute [rw] legal_hold_id
|
3525
|
+
# ID of specific legal hold on one or more recovery points.
|
3526
|
+
# @return [String]
|
3527
|
+
#
|
3528
|
+
# @!attribute [rw] legal_hold_arn
|
3529
|
+
# This is an Amazon Resource Number (ARN) that uniquely identifies the
|
3530
|
+
# legal hold; for example,
|
3531
|
+
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
3532
|
+
# @return [String]
|
3533
|
+
#
|
3534
|
+
# @!attribute [rw] creation_date
|
3535
|
+
# This is the time in number format when legal hold was created.
|
3536
|
+
# @return [Time]
|
3537
|
+
#
|
3538
|
+
# @!attribute [rw] cancellation_date
|
3539
|
+
# This is the time in number format when legal hold was cancelled.
|
3540
|
+
# @return [Time]
|
3541
|
+
#
|
3542
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/LegalHold AWS API Documentation
|
3543
|
+
#
|
3544
|
+
class LegalHold < Struct.new(
|
3545
|
+
:title,
|
3546
|
+
:status,
|
3547
|
+
:description,
|
3548
|
+
:legal_hold_id,
|
3549
|
+
:legal_hold_arn,
|
3550
|
+
:creation_date,
|
3551
|
+
:cancellation_date)
|
3552
|
+
SENSITIVE = []
|
3553
|
+
include Aws::Structure
|
3554
|
+
end
|
3555
|
+
|
3720
3556
|
# Contains an array of `Transition` objects specifying how long in days
|
3721
3557
|
# before a recovery point transitions to cold storage or is deleted.
|
3722
3558
|
#
|
@@ -3735,14 +3571,6 @@ module Aws::Backup
|
|
3735
3571
|
#
|
3736
3572
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
|
3737
3573
|
#
|
3738
|
-
# @note When making an API call, you may pass Lifecycle
|
3739
|
-
# data as a hash:
|
3740
|
-
#
|
3741
|
-
# {
|
3742
|
-
# move_to_cold_storage_after_days: 1,
|
3743
|
-
# delete_after_days: 1,
|
3744
|
-
# }
|
3745
|
-
#
|
3746
3574
|
# @!attribute [rw] move_to_cold_storage_after_days
|
3747
3575
|
# Specifies the number of days after creation that a recovery point is
|
3748
3576
|
# moved to cold storage.
|
@@ -3789,23 +3617,6 @@ module Aws::Backup
|
|
3789
3617
|
include Aws::Structure
|
3790
3618
|
end
|
3791
3619
|
|
3792
|
-
# @note When making an API call, you may pass ListBackupJobsInput
|
3793
|
-
# data as a hash:
|
3794
|
-
#
|
3795
|
-
# {
|
3796
|
-
# next_token: "string",
|
3797
|
-
# max_results: 1,
|
3798
|
-
# by_resource_arn: "ARN",
|
3799
|
-
# by_state: "CREATED", # accepts CREATED, PENDING, RUNNING, ABORTING, ABORTED, COMPLETED, FAILED, EXPIRED
|
3800
|
-
# by_backup_vault_name: "BackupVaultName",
|
3801
|
-
# by_created_before: Time.now,
|
3802
|
-
# by_created_after: Time.now,
|
3803
|
-
# by_resource_type: "ResourceType",
|
3804
|
-
# by_account_id: "AccountId",
|
3805
|
-
# by_complete_after: Time.now,
|
3806
|
-
# by_complete_before: Time.now,
|
3807
|
-
# }
|
3808
|
-
#
|
3809
3620
|
# @!attribute [rw] next_token
|
3810
3621
|
# The next item following a partial list of returned items. For
|
3811
3622
|
# example, if a request is made to return `maxResults` number of
|
@@ -3889,6 +3700,10 @@ module Aws::Backup
|
|
3889
3700
|
# format and Coordinated Universal Time (UTC).
|
3890
3701
|
# @return [Time]
|
3891
3702
|
#
|
3703
|
+
# @!attribute [rw] by_parent_job_id
|
3704
|
+
# This is a filter to list child (nested) jobs based on parent job ID.
|
3705
|
+
# @return [String]
|
3706
|
+
#
|
3892
3707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobsInput AWS API Documentation
|
3893
3708
|
#
|
3894
3709
|
class ListBackupJobsInput < Struct.new(
|
@@ -3902,7 +3717,8 @@ module Aws::Backup
|
|
3902
3717
|
:by_resource_type,
|
3903
3718
|
:by_account_id,
|
3904
3719
|
:by_complete_after,
|
3905
|
-
:by_complete_before
|
3720
|
+
:by_complete_before,
|
3721
|
+
:by_parent_job_id)
|
3906
3722
|
SENSITIVE = []
|
3907
3723
|
include Aws::Structure
|
3908
3724
|
end
|
@@ -3928,14 +3744,6 @@ module Aws::Backup
|
|
3928
3744
|
include Aws::Structure
|
3929
3745
|
end
|
3930
3746
|
|
3931
|
-
# @note When making an API call, you may pass ListBackupPlanTemplatesInput
|
3932
|
-
# data as a hash:
|
3933
|
-
#
|
3934
|
-
# {
|
3935
|
-
# next_token: "string",
|
3936
|
-
# max_results: 1,
|
3937
|
-
# }
|
3938
|
-
#
|
3939
3747
|
# @!attribute [rw] next_token
|
3940
3748
|
# The next item following a partial list of returned items. For
|
3941
3749
|
# example, if a request is made to return `maxResults` number of
|
@@ -3977,15 +3785,6 @@ module Aws::Backup
|
|
3977
3785
|
include Aws::Structure
|
3978
3786
|
end
|
3979
3787
|
|
3980
|
-
# @note When making an API call, you may pass ListBackupPlanVersionsInput
|
3981
|
-
# data as a hash:
|
3982
|
-
#
|
3983
|
-
# {
|
3984
|
-
# backup_plan_id: "string", # required
|
3985
|
-
# next_token: "string",
|
3986
|
-
# max_results: 1,
|
3987
|
-
# }
|
3988
|
-
#
|
3989
3788
|
# @!attribute [rw] backup_plan_id
|
3990
3789
|
# Uniquely identifies a backup plan.
|
3991
3790
|
# @return [String]
|
@@ -4032,15 +3831,6 @@ module Aws::Backup
|
|
4032
3831
|
include Aws::Structure
|
4033
3832
|
end
|
4034
3833
|
|
4035
|
-
# @note When making an API call, you may pass ListBackupPlansInput
|
4036
|
-
# data as a hash:
|
4037
|
-
#
|
4038
|
-
# {
|
4039
|
-
# next_token: "string",
|
4040
|
-
# max_results: 1,
|
4041
|
-
# include_deleted: false,
|
4042
|
-
# }
|
4043
|
-
#
|
4044
3834
|
# @!attribute [rw] next_token
|
4045
3835
|
# The next item following a partial list of returned items. For
|
4046
3836
|
# example, if a request is made to return `maxResults` number of
|
@@ -4088,15 +3878,6 @@ module Aws::Backup
|
|
4088
3878
|
include Aws::Structure
|
4089
3879
|
end
|
4090
3880
|
|
4091
|
-
# @note When making an API call, you may pass ListBackupSelectionsInput
|
4092
|
-
# data as a hash:
|
4093
|
-
#
|
4094
|
-
# {
|
4095
|
-
# backup_plan_id: "string", # required
|
4096
|
-
# next_token: "string",
|
4097
|
-
# max_results: 1,
|
4098
|
-
# }
|
4099
|
-
#
|
4100
3881
|
# @!attribute [rw] backup_plan_id
|
4101
3882
|
# Uniquely identifies a backup plan.
|
4102
3883
|
# @return [String]
|
@@ -4143,14 +3924,6 @@ module Aws::Backup
|
|
4143
3924
|
include Aws::Structure
|
4144
3925
|
end
|
4145
3926
|
|
4146
|
-
# @note When making an API call, you may pass ListBackupVaultsInput
|
4147
|
-
# data as a hash:
|
4148
|
-
#
|
4149
|
-
# {
|
4150
|
-
# next_token: "string",
|
4151
|
-
# max_results: 1,
|
4152
|
-
# }
|
4153
|
-
#
|
4154
3927
|
# @!attribute [rw] next_token
|
4155
3928
|
# The next item following a partial list of returned items. For
|
4156
3929
|
# example, if a request is made to return `maxResults` number of
|
@@ -4194,23 +3967,6 @@ module Aws::Backup
|
|
4194
3967
|
include Aws::Structure
|
4195
3968
|
end
|
4196
3969
|
|
4197
|
-
# @note When making an API call, you may pass ListCopyJobsInput
|
4198
|
-
# data as a hash:
|
4199
|
-
#
|
4200
|
-
# {
|
4201
|
-
# next_token: "string",
|
4202
|
-
# max_results: 1,
|
4203
|
-
# by_resource_arn: "ARN",
|
4204
|
-
# by_state: "CREATED", # accepts CREATED, RUNNING, COMPLETED, FAILED
|
4205
|
-
# by_created_before: Time.now,
|
4206
|
-
# by_created_after: Time.now,
|
4207
|
-
# by_resource_type: "ResourceType",
|
4208
|
-
# by_destination_vault_arn: "string",
|
4209
|
-
# by_account_id: "AccountId",
|
4210
|
-
# by_complete_before: Time.now,
|
4211
|
-
# by_complete_after: Time.now,
|
4212
|
-
# }
|
4213
|
-
#
|
4214
3970
|
# @!attribute [rw] next_token
|
4215
3971
|
# The next item following a partial list of returned items. For
|
4216
3972
|
# example, if a request is made to return maxResults number of items,
|
@@ -4288,6 +4044,10 @@ module Aws::Backup
|
|
4288
4044
|
# format and Coordinated Universal Time (UTC).
|
4289
4045
|
# @return [Time]
|
4290
4046
|
#
|
4047
|
+
# @!attribute [rw] by_parent_job_id
|
4048
|
+
# This is a filter to list child (nested) jobs based on parent job ID.
|
4049
|
+
# @return [String]
|
4050
|
+
#
|
4291
4051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobsInput AWS API Documentation
|
4292
4052
|
#
|
4293
4053
|
class ListCopyJobsInput < Struct.new(
|
@@ -4301,7 +4061,8 @@ module Aws::Backup
|
|
4301
4061
|
:by_destination_vault_arn,
|
4302
4062
|
:by_account_id,
|
4303
4063
|
:by_complete_before,
|
4304
|
-
:by_complete_after
|
4064
|
+
:by_complete_after,
|
4065
|
+
:by_parent_job_id)
|
4305
4066
|
SENSITIVE = []
|
4306
4067
|
include Aws::Structure
|
4307
4068
|
end
|
@@ -4327,14 +4088,6 @@ module Aws::Backup
|
|
4327
4088
|
include Aws::Structure
|
4328
4089
|
end
|
4329
4090
|
|
4330
|
-
# @note When making an API call, you may pass ListFrameworksInput
|
4331
|
-
# data as a hash:
|
4332
|
-
#
|
4333
|
-
# {
|
4334
|
-
# max_results: 1,
|
4335
|
-
# next_token: "string",
|
4336
|
-
# }
|
4337
|
-
#
|
4338
4091
|
# @!attribute [rw] max_results
|
4339
4092
|
# The number of desired results from 1 to 1000. Optional. If
|
4340
4093
|
# unspecified, the query will return 1 MB of data.
|
@@ -4376,14 +4129,46 @@ module Aws::Backup
|
|
4376
4129
|
include Aws::Structure
|
4377
4130
|
end
|
4378
4131
|
|
4379
|
-
#
|
4380
|
-
#
|
4132
|
+
# @!attribute [rw] next_token
|
4133
|
+
# The next item following a partial list of returned resources. For
|
4134
|
+
# example, if a request is made to return `maxResults` number of
|
4135
|
+
# resources, `NextToken` allows you to return more items in your list
|
4136
|
+
# starting at the location pointed to by the next token.
|
4137
|
+
# @return [String]
|
4381
4138
|
#
|
4382
|
-
#
|
4383
|
-
#
|
4384
|
-
#
|
4385
|
-
# }
|
4139
|
+
# @!attribute [rw] max_results
|
4140
|
+
# The maximum number of resource list items to be returned.
|
4141
|
+
# @return [Integer]
|
4386
4142
|
#
|
4143
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListLegalHoldsInput AWS API Documentation
|
4144
|
+
#
|
4145
|
+
class ListLegalHoldsInput < Struct.new(
|
4146
|
+
:next_token,
|
4147
|
+
:max_results)
|
4148
|
+
SENSITIVE = []
|
4149
|
+
include Aws::Structure
|
4150
|
+
end
|
4151
|
+
|
4152
|
+
# @!attribute [rw] next_token
|
4153
|
+
# The next item following a partial list of returned resources. For
|
4154
|
+
# example, if a request is made to return `maxResults` number of
|
4155
|
+
# resources, `NextToken` allows you to return more items in your list
|
4156
|
+
# starting at the location pointed to by the next token.
|
4157
|
+
# @return [String]
|
4158
|
+
#
|
4159
|
+
# @!attribute [rw] legal_holds
|
4160
|
+
# This is an array of returned legal holds, both active and previous.
|
4161
|
+
# @return [Array<Types::LegalHold>]
|
4162
|
+
#
|
4163
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListLegalHoldsOutput AWS API Documentation
|
4164
|
+
#
|
4165
|
+
class ListLegalHoldsOutput < Struct.new(
|
4166
|
+
:next_token,
|
4167
|
+
:legal_holds)
|
4168
|
+
SENSITIVE = []
|
4169
|
+
include Aws::Structure
|
4170
|
+
end
|
4171
|
+
|
4387
4172
|
# @!attribute [rw] next_token
|
4388
4173
|
# The next item following a partial list of returned items. For
|
4389
4174
|
# example, if a request is made to return `maxResults` number of
|
@@ -4426,20 +4211,6 @@ module Aws::Backup
|
|
4426
4211
|
include Aws::Structure
|
4427
4212
|
end
|
4428
4213
|
|
4429
|
-
# @note When making an API call, you may pass ListRecoveryPointsByBackupVaultInput
|
4430
|
-
# data as a hash:
|
4431
|
-
#
|
4432
|
-
# {
|
4433
|
-
# backup_vault_name: "BackupVaultName", # required
|
4434
|
-
# next_token: "string",
|
4435
|
-
# max_results: 1,
|
4436
|
-
# by_resource_arn: "ARN",
|
4437
|
-
# by_resource_type: "ResourceType",
|
4438
|
-
# by_backup_plan_id: "string",
|
4439
|
-
# by_created_before: Time.now,
|
4440
|
-
# by_created_after: Time.now,
|
4441
|
-
# }
|
4442
|
-
#
|
4443
4214
|
# @!attribute [rw] backup_vault_name
|
4444
4215
|
# The name of a logical container where backups are stored. Backup
|
4445
4216
|
# vaults are identified by names that are unique to the account used
|
@@ -4487,6 +4258,11 @@ module Aws::Backup
|
|
4487
4258
|
# timestamp.
|
4488
4259
|
# @return [Time]
|
4489
4260
|
#
|
4261
|
+
# @!attribute [rw] by_parent_recovery_point_arn
|
4262
|
+
# This returns only recovery points that match the specified parent
|
4263
|
+
# (composite) recovery point Amazon Resource Name (ARN).
|
4264
|
+
# @return [String]
|
4265
|
+
#
|
4490
4266
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByBackupVaultInput AWS API Documentation
|
4491
4267
|
#
|
4492
4268
|
class ListRecoveryPointsByBackupVaultInput < Struct.new(
|
@@ -4497,7 +4273,8 @@ module Aws::Backup
|
|
4497
4273
|
:by_resource_type,
|
4498
4274
|
:by_backup_plan_id,
|
4499
4275
|
:by_created_before,
|
4500
|
-
:by_created_after
|
4276
|
+
:by_created_after,
|
4277
|
+
:by_parent_recovery_point_arn)
|
4501
4278
|
SENSITIVE = []
|
4502
4279
|
include Aws::Structure
|
4503
4280
|
end
|
@@ -4523,15 +4300,50 @@ module Aws::Backup
|
|
4523
4300
|
include Aws::Structure
|
4524
4301
|
end
|
4525
4302
|
|
4526
|
-
#
|
4527
|
-
#
|
4303
|
+
# @!attribute [rw] legal_hold_id
|
4304
|
+
# This is the ID of the legal hold.
|
4305
|
+
# @return [String]
|
4306
|
+
#
|
4307
|
+
# @!attribute [rw] next_token
|
4308
|
+
# This is the next item following a partial list of returned
|
4309
|
+
# resources. For example, if a request is made to return `maxResults`
|
4310
|
+
# number of resources, `NextToken` allows you to return more items in
|
4311
|
+
# your list starting at the location pointed to by the next token.
|
4312
|
+
# @return [String]
|
4313
|
+
#
|
4314
|
+
# @!attribute [rw] max_results
|
4315
|
+
# This is the maximum number of resource list items to be returned.
|
4316
|
+
# @return [Integer]
|
4317
|
+
#
|
4318
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHoldInput AWS API Documentation
|
4319
|
+
#
|
4320
|
+
class ListRecoveryPointsByLegalHoldInput < Struct.new(
|
4321
|
+
:legal_hold_id,
|
4322
|
+
:next_token,
|
4323
|
+
:max_results)
|
4324
|
+
SENSITIVE = []
|
4325
|
+
include Aws::Structure
|
4326
|
+
end
|
4327
|
+
|
4328
|
+
# @!attribute [rw] recovery_points
|
4329
|
+
# This is a list of the recovery points returned by
|
4330
|
+
# `ListRecoveryPointsByLegalHold`.
|
4331
|
+
# @return [Array<Types::RecoveryPointMember>]
|
4332
|
+
#
|
4333
|
+
# @!attribute [rw] next_token
|
4334
|
+
# This return is the next item following a partial list of returned
|
4335
|
+
# resources.
|
4336
|
+
# @return [String]
|
4528
4337
|
#
|
4529
|
-
#
|
4530
|
-
# resource_arn: "ARN", # required
|
4531
|
-
# next_token: "string",
|
4532
|
-
# max_results: 1,
|
4533
|
-
# }
|
4338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHoldOutput AWS API Documentation
|
4534
4339
|
#
|
4340
|
+
class ListRecoveryPointsByLegalHoldOutput < Struct.new(
|
4341
|
+
:recovery_points,
|
4342
|
+
:next_token)
|
4343
|
+
SENSITIVE = []
|
4344
|
+
include Aws::Structure
|
4345
|
+
end
|
4346
|
+
|
4535
4347
|
# @!attribute [rw] resource_arn
|
4536
4348
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
4537
4349
|
# depends on the resource type.
|
@@ -4588,18 +4400,6 @@ module Aws::Backup
|
|
4588
4400
|
include Aws::Structure
|
4589
4401
|
end
|
4590
4402
|
|
4591
|
-
# @note When making an API call, you may pass ListReportJobsInput
|
4592
|
-
# data as a hash:
|
4593
|
-
#
|
4594
|
-
# {
|
4595
|
-
# by_report_plan_name: "ReportPlanName",
|
4596
|
-
# by_creation_before: Time.now,
|
4597
|
-
# by_creation_after: Time.now,
|
4598
|
-
# by_status: "string",
|
4599
|
-
# max_results: 1,
|
4600
|
-
# next_token: "string",
|
4601
|
-
# }
|
4602
|
-
#
|
4603
4403
|
# @!attribute [rw] by_report_plan_name
|
4604
4404
|
# Returns only report jobs with the specified report plan name.
|
4605
4405
|
# @return [String]
|
@@ -4668,14 +4468,6 @@ module Aws::Backup
|
|
4668
4468
|
include Aws::Structure
|
4669
4469
|
end
|
4670
4470
|
|
4671
|
-
# @note When making an API call, you may pass ListReportPlansInput
|
4672
|
-
# data as a hash:
|
4673
|
-
#
|
4674
|
-
# {
|
4675
|
-
# max_results: 1,
|
4676
|
-
# next_token: "string",
|
4677
|
-
# }
|
4678
|
-
#
|
4679
4471
|
# @!attribute [rw] max_results
|
4680
4472
|
# The number of desired results from 1 to 1000. Optional. If
|
4681
4473
|
# unspecified, the query will return 1 MB of data.
|
@@ -4719,20 +4511,6 @@ module Aws::Backup
|
|
4719
4511
|
include Aws::Structure
|
4720
4512
|
end
|
4721
4513
|
|
4722
|
-
# @note When making an API call, you may pass ListRestoreJobsInput
|
4723
|
-
# data as a hash:
|
4724
|
-
#
|
4725
|
-
# {
|
4726
|
-
# next_token: "string",
|
4727
|
-
# max_results: 1,
|
4728
|
-
# by_account_id: "AccountId",
|
4729
|
-
# by_created_before: Time.now,
|
4730
|
-
# by_created_after: Time.now,
|
4731
|
-
# by_status: "PENDING", # accepts PENDING, RUNNING, COMPLETED, ABORTED, FAILED
|
4732
|
-
# by_complete_before: Time.now,
|
4733
|
-
# by_complete_after: Time.now,
|
4734
|
-
# }
|
4735
|
-
#
|
4736
4514
|
# @!attribute [rw] next_token
|
4737
4515
|
# The next item following a partial list of returned items. For
|
4738
4516
|
# example, if a request is made to return `maxResults` number of
|
@@ -4809,15 +4587,6 @@ module Aws::Backup
|
|
4809
4587
|
include Aws::Structure
|
4810
4588
|
end
|
4811
4589
|
|
4812
|
-
# @note When making an API call, you may pass ListTagsInput
|
4813
|
-
# data as a hash:
|
4814
|
-
#
|
4815
|
-
# {
|
4816
|
-
# resource_arn: "ARN", # required
|
4817
|
-
# next_token: "string",
|
4818
|
-
# max_results: 1,
|
4819
|
-
# }
|
4820
|
-
#
|
4821
4590
|
# @!attribute [rw] resource_arn
|
4822
4591
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource.
|
4823
4592
|
# The format of the ARN depends on the type of resource. Valid targets
|
@@ -4923,14 +4692,6 @@ module Aws::Backup
|
|
4923
4692
|
include Aws::Structure
|
4924
4693
|
end
|
4925
4694
|
|
4926
|
-
# @note When making an API call, you may pass PutBackupVaultAccessPolicyInput
|
4927
|
-
# data as a hash:
|
4928
|
-
#
|
4929
|
-
# {
|
4930
|
-
# backup_vault_name: "BackupVaultName", # required
|
4931
|
-
# policy: "IAMPolicy",
|
4932
|
-
# }
|
4933
|
-
#
|
4934
4695
|
# @!attribute [rw] backup_vault_name
|
4935
4696
|
# The name of a logical container where backups are stored. Backup
|
4936
4697
|
# vaults are identified by names that are unique to the account used
|
@@ -4951,16 +4712,6 @@ module Aws::Backup
|
|
4951
4712
|
include Aws::Structure
|
4952
4713
|
end
|
4953
4714
|
|
4954
|
-
# @note When making an API call, you may pass PutBackupVaultLockConfigurationInput
|
4955
|
-
# data as a hash:
|
4956
|
-
#
|
4957
|
-
# {
|
4958
|
-
# backup_vault_name: "BackupVaultName", # required
|
4959
|
-
# min_retention_days: 1,
|
4960
|
-
# max_retention_days: 1,
|
4961
|
-
# changeable_for_days: 1,
|
4962
|
-
# }
|
4963
|
-
#
|
4964
4715
|
# @!attribute [rw] backup_vault_name
|
4965
4716
|
# The Backup Vault Lock configuration that specifies the name of the
|
4966
4717
|
# backup vault it protects.
|
@@ -5042,15 +4793,6 @@ module Aws::Backup
|
|
5042
4793
|
include Aws::Structure
|
5043
4794
|
end
|
5044
4795
|
|
5045
|
-
# @note When making an API call, you may pass PutBackupVaultNotificationsInput
|
5046
|
-
# data as a hash:
|
5047
|
-
#
|
5048
|
-
# {
|
5049
|
-
# backup_vault_name: "BackupVaultName", # required
|
5050
|
-
# sns_topic_arn: "ARN", # required
|
5051
|
-
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED, S3_BACKUP_OBJECT_FAILED, S3_RESTORE_OBJECT_FAILED
|
5052
|
-
# }
|
5053
|
-
#
|
5054
4796
|
# @!attribute [rw] backup_vault_name
|
5055
4797
|
# The name of a logical container where backups are stored. Backup
|
5056
4798
|
# vaults are identified by names that are unique to the account used
|
@@ -5082,8 +4824,10 @@ module Aws::Backup
|
|
5082
4824
|
#
|
5083
4825
|
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
5084
4826
|
#
|
5085
|
-
# <note markdown="1">
|
5086
|
-
#
|
4827
|
+
# <note markdown="1"> The list below shows items that are deprecated events (for
|
4828
|
+
# reference) and are no longer in use. They are no longer supported
|
4829
|
+
# and will not return statuses or notifications. Refer to the list
|
4830
|
+
# above for current supported events.
|
5087
4831
|
#
|
5088
4832
|
# </note>
|
5089
4833
|
#
|
@@ -5226,6 +4970,27 @@ module Aws::Backup
|
|
5226
4970
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
5227
4971
|
# @return [Time]
|
5228
4972
|
#
|
4973
|
+
# @!attribute [rw] parent_recovery_point_arn
|
4974
|
+
# This is the Amazon Resource Name (ARN) of the parent (composite)
|
4975
|
+
# recovery point.
|
4976
|
+
# @return [String]
|
4977
|
+
#
|
4978
|
+
# @!attribute [rw] composite_member_identifier
|
4979
|
+
# This is the identifier of a resource within a composite group, such
|
4980
|
+
# as nested (child) recovery point belonging to a composite (parent)
|
4981
|
+
# stack. The ID is transferred from the [ logical ID][1] within a
|
4982
|
+
# stack.
|
4983
|
+
#
|
4984
|
+
#
|
4985
|
+
#
|
4986
|
+
# [1]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax
|
4987
|
+
# @return [String]
|
4988
|
+
#
|
4989
|
+
# @!attribute [rw] is_parent
|
4990
|
+
# This is a boolean value indicating this is a parent (composite)
|
4991
|
+
# recovery point.
|
4992
|
+
# @return [Boolean]
|
4993
|
+
#
|
5229
4994
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByBackupVault AWS API Documentation
|
5230
4995
|
#
|
5231
4996
|
class RecoveryPointByBackupVault < Struct.new(
|
@@ -5246,7 +5011,10 @@ module Aws::Backup
|
|
5246
5011
|
:lifecycle,
|
5247
5012
|
:encryption_key_arn,
|
5248
5013
|
:is_encrypted,
|
5249
|
-
:last_restore_time
|
5014
|
+
:last_restore_time,
|
5015
|
+
:parent_recovery_point_arn,
|
5016
|
+
:composite_member_identifier,
|
5017
|
+
:is_parent)
|
5250
5018
|
SENSITIVE = []
|
5251
5019
|
include Aws::Structure
|
5252
5020
|
end
|
@@ -5292,6 +5060,16 @@ module Aws::Backup
|
|
5292
5060
|
# created. They consist of lowercase letters, numbers, and hyphens.
|
5293
5061
|
# @return [String]
|
5294
5062
|
#
|
5063
|
+
# @!attribute [rw] is_parent
|
5064
|
+
# This is a boolean value indicating this is a parent (composite)
|
5065
|
+
# recovery point.
|
5066
|
+
# @return [Boolean]
|
5067
|
+
#
|
5068
|
+
# @!attribute [rw] parent_recovery_point_arn
|
5069
|
+
# This is the Amazon Resource Name (ARN) of the parent (composite)
|
5070
|
+
# recovery point.
|
5071
|
+
# @return [String]
|
5072
|
+
#
|
5295
5073
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByResource AWS API Documentation
|
5296
5074
|
#
|
5297
5075
|
class RecoveryPointByResource < Struct.new(
|
@@ -5301,7 +5079,9 @@ module Aws::Backup
|
|
5301
5079
|
:status_message,
|
5302
5080
|
:encryption_key_arn,
|
5303
5081
|
:backup_size_bytes,
|
5304
|
-
:backup_vault_name
|
5082
|
+
:backup_vault_name,
|
5083
|
+
:is_parent,
|
5084
|
+
:parent_recovery_point_arn)
|
5305
5085
|
SENSITIVE = []
|
5306
5086
|
include Aws::Structure
|
5307
5087
|
end
|
@@ -5340,19 +5120,62 @@ module Aws::Backup
|
|
5340
5120
|
include Aws::Structure
|
5341
5121
|
end
|
5342
5122
|
|
5123
|
+
# This is a recovery point which is a child (nested) recovery point of a
|
5124
|
+
# parent (composite) recovery point. These recovery points can be
|
5125
|
+
# disassociated from their parent (composite) recovery point, in which
|
5126
|
+
# case they will no longer be a member.
|
5127
|
+
#
|
5128
|
+
# @!attribute [rw] recovery_point_arn
|
5129
|
+
# This is the Amazon Resource Name (ARN) of the parent (composite)
|
5130
|
+
# recovery point.
|
5131
|
+
# @return [String]
|
5132
|
+
#
|
5133
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointMember AWS API Documentation
|
5134
|
+
#
|
5135
|
+
class RecoveryPointMember < Struct.new(
|
5136
|
+
:recovery_point_arn)
|
5137
|
+
SENSITIVE = []
|
5138
|
+
include Aws::Structure
|
5139
|
+
end
|
5140
|
+
|
5141
|
+
# This specifies criteria to assign a set of resources, such as resource
|
5142
|
+
# types or backup vaults.
|
5143
|
+
#
|
5144
|
+
# @!attribute [rw] vault_names
|
5145
|
+
# These are the names of the vaults in which the selected recovery
|
5146
|
+
# points are contained.
|
5147
|
+
# @return [Array<String>]
|
5148
|
+
#
|
5149
|
+
# @!attribute [rw] resource_identifiers
|
5150
|
+
# These are the resources included in the resource selection
|
5151
|
+
# (including type of resources and vaults).
|
5152
|
+
# @return [Array<String>]
|
5153
|
+
#
|
5154
|
+
# @!attribute [rw] date_range
|
5155
|
+
# This is a resource filter containing FromDate: DateTime and ToDate:
|
5156
|
+
# DateTime. Both values are required. Future DateTime values are not
|
5157
|
+
# permitted.
|
5158
|
+
#
|
5159
|
+
# The date and time are in Unix format and Coordinated Universal Time
|
5160
|
+
# (UTC), and it is accurate to milliseconds ((milliseconds are
|
5161
|
+
# optional). For example, the value 1516925490.087 represents Friday,
|
5162
|
+
# January 26, 2018 12:11:30.087 AM.
|
5163
|
+
# @return [Types::DateRange]
|
5164
|
+
#
|
5165
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointSelection AWS API Documentation
|
5166
|
+
#
|
5167
|
+
class RecoveryPointSelection < Struct.new(
|
5168
|
+
:vault_names,
|
5169
|
+
:resource_identifiers,
|
5170
|
+
:date_range)
|
5171
|
+
SENSITIVE = []
|
5172
|
+
include Aws::Structure
|
5173
|
+
end
|
5174
|
+
|
5343
5175
|
# Contains information from your report plan about where to deliver your
|
5344
5176
|
# reports, specifically your Amazon S3 bucket name, S3 key prefix, and
|
5345
5177
|
# the formats of your reports.
|
5346
5178
|
#
|
5347
|
-
# @note When making an API call, you may pass ReportDeliveryChannel
|
5348
|
-
# data as a hash:
|
5349
|
-
#
|
5350
|
-
# {
|
5351
|
-
# s3_bucket_name: "string", # required
|
5352
|
-
# s3_key_prefix: "string",
|
5353
|
-
# formats: ["string"],
|
5354
|
-
# }
|
5355
|
-
#
|
5356
5179
|
# @!attribute [rw] s3_bucket_name
|
5357
5180
|
# The unique name of the S3 bucket that receives your reports.
|
5358
5181
|
# @return [String]
|
@@ -5555,15 +5378,6 @@ module Aws::Backup
|
|
5555
5378
|
|
5556
5379
|
# Contains detailed information about a report setting.
|
5557
5380
|
#
|
5558
|
-
# @note When making an API call, you may pass ReportSetting
|
5559
|
-
# data as a hash:
|
5560
|
-
#
|
5561
|
-
# {
|
5562
|
-
# report_template: "string", # required
|
5563
|
-
# framework_arns: ["string"],
|
5564
|
-
# number_of_frameworks: 1,
|
5565
|
-
# }
|
5566
|
-
#
|
5567
5381
|
# @!attribute [rw] report_template
|
5568
5382
|
# Identifies the report template for the report. Reports are built
|
5569
5383
|
# using a report template. The report templates are:
|
@@ -5580,12 +5394,27 @@ module Aws::Backup
|
|
5580
5394
|
# The number of frameworks a report covers.
|
5581
5395
|
# @return [Integer]
|
5582
5396
|
#
|
5397
|
+
# @!attribute [rw] accounts
|
5398
|
+
# These are the accounts to be included in the report.
|
5399
|
+
# @return [Array<String>]
|
5400
|
+
#
|
5401
|
+
# @!attribute [rw] organization_units
|
5402
|
+
# These are the Organizational Units to be included in the report.
|
5403
|
+
# @return [Array<String>]
|
5404
|
+
#
|
5405
|
+
# @!attribute [rw] regions
|
5406
|
+
# These are the Regions to be included in the report.
|
5407
|
+
# @return [Array<String>]
|
5408
|
+
#
|
5583
5409
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ReportSetting AWS API Documentation
|
5584
5410
|
#
|
5585
5411
|
class ReportSetting < Struct.new(
|
5586
5412
|
:report_template,
|
5587
5413
|
:framework_arns,
|
5588
|
-
:number_of_frameworks
|
5414
|
+
:number_of_frameworks,
|
5415
|
+
:accounts,
|
5416
|
+
:organization_units,
|
5417
|
+
:regions)
|
5589
5418
|
SENSITIVE = []
|
5590
5419
|
include Aws::Structure
|
5591
5420
|
end
|
@@ -5731,28 +5560,6 @@ module Aws::Backup
|
|
5731
5560
|
include Aws::Structure
|
5732
5561
|
end
|
5733
5562
|
|
5734
|
-
# @note When making an API call, you may pass StartBackupJobInput
|
5735
|
-
# data as a hash:
|
5736
|
-
#
|
5737
|
-
# {
|
5738
|
-
# backup_vault_name: "BackupVaultName", # required
|
5739
|
-
# resource_arn: "ARN", # required
|
5740
|
-
# iam_role_arn: "IAMRoleArn", # required
|
5741
|
-
# idempotency_token: "string",
|
5742
|
-
# start_window_minutes: 1,
|
5743
|
-
# complete_window_minutes: 1,
|
5744
|
-
# lifecycle: {
|
5745
|
-
# move_to_cold_storage_after_days: 1,
|
5746
|
-
# delete_after_days: 1,
|
5747
|
-
# },
|
5748
|
-
# recovery_point_tags: {
|
5749
|
-
# "TagKey" => "TagValue",
|
5750
|
-
# },
|
5751
|
-
# backup_options: {
|
5752
|
-
# "BackupOptionKey" => "BackupOptionValue",
|
5753
|
-
# },
|
5754
|
-
# }
|
5755
|
-
#
|
5756
5563
|
# @!attribute [rw] backup_vault_name
|
5757
5564
|
# The name of a logical container where backups are stored. Backup
|
5758
5565
|
# vaults are identified by names that are unique to the account used
|
@@ -5780,7 +5587,8 @@ module Aws::Backup
|
|
5780
5587
|
# @!attribute [rw] start_window_minutes
|
5781
5588
|
# A value in minutes after a backup is scheduled before a job will be
|
5782
5589
|
# canceled if it doesn't start successfully. This value is optional,
|
5783
|
-
# and the default is 8 hours.
|
5590
|
+
# and the default is 8 hours. If this value is included, it must be at
|
5591
|
+
# least 60 minutes to avoid errors.
|
5784
5592
|
# @return [Integer]
|
5785
5593
|
#
|
5786
5594
|
# @!attribute [rw] complete_window_minutes
|
@@ -5860,31 +5668,22 @@ module Aws::Backup
|
|
5860
5668
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
5861
5669
|
# @return [Time]
|
5862
5670
|
#
|
5671
|
+
# @!attribute [rw] is_parent
|
5672
|
+
# This is a returned boolean value indicating this is a parent
|
5673
|
+
# (composite) backup job.
|
5674
|
+
# @return [Boolean]
|
5675
|
+
#
|
5863
5676
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJobOutput AWS API Documentation
|
5864
5677
|
#
|
5865
5678
|
class StartBackupJobOutput < Struct.new(
|
5866
5679
|
:backup_job_id,
|
5867
5680
|
:recovery_point_arn,
|
5868
|
-
:creation_date
|
5681
|
+
:creation_date,
|
5682
|
+
:is_parent)
|
5869
5683
|
SENSITIVE = []
|
5870
5684
|
include Aws::Structure
|
5871
5685
|
end
|
5872
5686
|
|
5873
|
-
# @note When making an API call, you may pass StartCopyJobInput
|
5874
|
-
# data as a hash:
|
5875
|
-
#
|
5876
|
-
# {
|
5877
|
-
# recovery_point_arn: "ARN", # required
|
5878
|
-
# source_backup_vault_name: "BackupVaultName", # required
|
5879
|
-
# destination_backup_vault_arn: "ARN", # required
|
5880
|
-
# iam_role_arn: "IAMRoleArn", # required
|
5881
|
-
# idempotency_token: "string",
|
5882
|
-
# lifecycle: {
|
5883
|
-
# move_to_cold_storage_after_days: 1,
|
5884
|
-
# delete_after_days: 1,
|
5885
|
-
# },
|
5886
|
-
# }
|
5887
|
-
#
|
5888
5687
|
# @!attribute [rw] recovery_point_arn
|
5889
5688
|
# An ARN that uniquely identifies a recovery point to use for the copy
|
5890
5689
|
# job; for example,
|
@@ -5962,23 +5761,21 @@ module Aws::Backup
|
|
5962
5761
|
# represents Friday, January 26, 2018 12:11:30.087 AM.
|
5963
5762
|
# @return [Time]
|
5964
5763
|
#
|
5764
|
+
# @!attribute [rw] is_parent
|
5765
|
+
# This is a returned boolean value indicating this is a parent
|
5766
|
+
# (composite) copy job.
|
5767
|
+
# @return [Boolean]
|
5768
|
+
#
|
5965
5769
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJobOutput AWS API Documentation
|
5966
5770
|
#
|
5967
5771
|
class StartCopyJobOutput < Struct.new(
|
5968
5772
|
:copy_job_id,
|
5969
|
-
:creation_date
|
5773
|
+
:creation_date,
|
5774
|
+
:is_parent)
|
5970
5775
|
SENSITIVE = []
|
5971
5776
|
include Aws::Structure
|
5972
5777
|
end
|
5973
5778
|
|
5974
|
-
# @note When making an API call, you may pass StartReportJobInput
|
5975
|
-
# data as a hash:
|
5976
|
-
#
|
5977
|
-
# {
|
5978
|
-
# report_plan_name: "ReportPlanName", # required
|
5979
|
-
# idempotency_token: "string",
|
5980
|
-
# }
|
5981
|
-
#
|
5982
5779
|
# @!attribute [rw] report_plan_name
|
5983
5780
|
# The unique name of a report plan.
|
5984
5781
|
# @return [String]
|
@@ -6016,19 +5813,6 @@ module Aws::Backup
|
|
6016
5813
|
include Aws::Structure
|
6017
5814
|
end
|
6018
5815
|
|
6019
|
-
# @note When making an API call, you may pass StartRestoreJobInput
|
6020
|
-
# data as a hash:
|
6021
|
-
#
|
6022
|
-
# {
|
6023
|
-
# recovery_point_arn: "ARN", # required
|
6024
|
-
# metadata: { # required
|
6025
|
-
# "MetadataKey" => "MetadataValue",
|
6026
|
-
# },
|
6027
|
-
# iam_role_arn: "IAMRoleArn",
|
6028
|
-
# idempotency_token: "string",
|
6029
|
-
# resource_type: "ResourceType",
|
6030
|
-
# }
|
6031
|
-
#
|
6032
5816
|
# @!attribute [rw] recovery_point_arn
|
6033
5817
|
# An ARN that uniquely identifies a recovery point; for example,
|
6034
5818
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
@@ -6079,7 +5863,7 @@ module Aws::Backup
|
|
6079
5863
|
#
|
6080
5864
|
# @!attribute [rw] iam_role_arn
|
6081
5865
|
# The Amazon Resource Name (ARN) of the IAM role that Backup uses to
|
6082
|
-
# create the target
|
5866
|
+
# create the target resource; for example:
|
6083
5867
|
# `arn:aws:iam::123456789012:role/S3Access`.
|
6084
5868
|
# @return [String]
|
6085
5869
|
#
|
@@ -6143,13 +5927,6 @@ module Aws::Backup
|
|
6143
5927
|
include Aws::Structure
|
6144
5928
|
end
|
6145
5929
|
|
6146
|
-
# @note When making an API call, you may pass StopBackupJobInput
|
6147
|
-
# data as a hash:
|
6148
|
-
#
|
6149
|
-
# {
|
6150
|
-
# backup_job_id: "string", # required
|
6151
|
-
# }
|
6152
|
-
#
|
6153
5930
|
# @!attribute [rw] backup_job_id
|
6154
5931
|
# Uniquely identifies a request to Backup to back up a resource.
|
6155
5932
|
# @return [String]
|
@@ -6162,16 +5939,6 @@ module Aws::Backup
|
|
6162
5939
|
include Aws::Structure
|
6163
5940
|
end
|
6164
5941
|
|
6165
|
-
# @note When making an API call, you may pass TagResourceInput
|
6166
|
-
# data as a hash:
|
6167
|
-
#
|
6168
|
-
# {
|
6169
|
-
# resource_arn: "ARN", # required
|
6170
|
-
# tags: { # required
|
6171
|
-
# "TagKey" => "TagValue",
|
6172
|
-
# },
|
6173
|
-
# }
|
6174
|
-
#
|
6175
5942
|
# @!attribute [rw] resource_arn
|
6176
5943
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
6177
5944
|
# depends on the type of the tagged resource.
|
@@ -6193,14 +5960,6 @@ module Aws::Backup
|
|
6193
5960
|
include Aws::Structure
|
6194
5961
|
end
|
6195
5962
|
|
6196
|
-
# @note When making an API call, you may pass UntagResourceInput
|
6197
|
-
# data as a hash:
|
6198
|
-
#
|
6199
|
-
# {
|
6200
|
-
# resource_arn: "ARN", # required
|
6201
|
-
# tag_key_list: ["string"], # required
|
6202
|
-
# }
|
6203
|
-
#
|
6204
5963
|
# @!attribute [rw] resource_arn
|
6205
5964
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
6206
5965
|
# depends on the type of the tagged resource.
|
@@ -6220,50 +5979,6 @@ module Aws::Backup
|
|
6220
5979
|
include Aws::Structure
|
6221
5980
|
end
|
6222
5981
|
|
6223
|
-
# @note When making an API call, you may pass UpdateBackupPlanInput
|
6224
|
-
# data as a hash:
|
6225
|
-
#
|
6226
|
-
# {
|
6227
|
-
# backup_plan_id: "string", # required
|
6228
|
-
# backup_plan: { # required
|
6229
|
-
# backup_plan_name: "BackupPlanName", # required
|
6230
|
-
# rules: [ # required
|
6231
|
-
# {
|
6232
|
-
# rule_name: "BackupRuleName", # required
|
6233
|
-
# target_backup_vault_name: "BackupVaultName", # required
|
6234
|
-
# schedule_expression: "CronExpression",
|
6235
|
-
# start_window_minutes: 1,
|
6236
|
-
# completion_window_minutes: 1,
|
6237
|
-
# lifecycle: {
|
6238
|
-
# move_to_cold_storage_after_days: 1,
|
6239
|
-
# delete_after_days: 1,
|
6240
|
-
# },
|
6241
|
-
# recovery_point_tags: {
|
6242
|
-
# "TagKey" => "TagValue",
|
6243
|
-
# },
|
6244
|
-
# copy_actions: [
|
6245
|
-
# {
|
6246
|
-
# lifecycle: {
|
6247
|
-
# move_to_cold_storage_after_days: 1,
|
6248
|
-
# delete_after_days: 1,
|
6249
|
-
# },
|
6250
|
-
# destination_backup_vault_arn: "ARN", # required
|
6251
|
-
# },
|
6252
|
-
# ],
|
6253
|
-
# enable_continuous_backup: false,
|
6254
|
-
# },
|
6255
|
-
# ],
|
6256
|
-
# advanced_backup_settings: [
|
6257
|
-
# {
|
6258
|
-
# resource_type: "ResourceType",
|
6259
|
-
# backup_options: {
|
6260
|
-
# "BackupOptionKey" => "BackupOptionValue",
|
6261
|
-
# },
|
6262
|
-
# },
|
6263
|
-
# ],
|
6264
|
-
# },
|
6265
|
-
# }
|
6266
|
-
#
|
6267
5982
|
# @!attribute [rw] backup_plan_id
|
6268
5983
|
# Uniquely identifies a backup plan.
|
6269
5984
|
# @return [String]
|
@@ -6320,33 +6035,6 @@ module Aws::Backup
|
|
6320
6035
|
include Aws::Structure
|
6321
6036
|
end
|
6322
6037
|
|
6323
|
-
# @note When making an API call, you may pass UpdateFrameworkInput
|
6324
|
-
# data as a hash:
|
6325
|
-
#
|
6326
|
-
# {
|
6327
|
-
# framework_name: "FrameworkName", # required
|
6328
|
-
# framework_description: "FrameworkDescription",
|
6329
|
-
# framework_controls: [
|
6330
|
-
# {
|
6331
|
-
# control_name: "ControlName", # required
|
6332
|
-
# control_input_parameters: [
|
6333
|
-
# {
|
6334
|
-
# parameter_name: "ParameterName",
|
6335
|
-
# parameter_value: "ParameterValue",
|
6336
|
-
# },
|
6337
|
-
# ],
|
6338
|
-
# control_scope: {
|
6339
|
-
# compliance_resource_ids: ["string"],
|
6340
|
-
# compliance_resource_types: ["ARN"],
|
6341
|
-
# tags: {
|
6342
|
-
# "string" => "string",
|
6343
|
-
# },
|
6344
|
-
# },
|
6345
|
-
# },
|
6346
|
-
# ],
|
6347
|
-
# idempotency_token: "string",
|
6348
|
-
# }
|
6349
|
-
#
|
6350
6038
|
# @!attribute [rw] framework_name
|
6351
6039
|
# The unique name of a framework. This name is between 1 and 256
|
6352
6040
|
# characters, starting with a letter, and consisting of letters (a-z,
|
@@ -6396,10 +6084,10 @@ module Aws::Backup
|
|
6396
6084
|
# @return [String]
|
6397
6085
|
#
|
6398
6086
|
# @!attribute [rw] creation_time
|
6399
|
-
# The date and time that a framework is created, in
|
6400
|
-
#
|
6401
|
-
#
|
6402
|
-
#
|
6087
|
+
# The date and time that a framework is created, in ISO 8601
|
6088
|
+
# representation. The value of `CreationTime` is accurate to
|
6089
|
+
# milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents
|
6090
|
+
# the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
|
6403
6091
|
# @return [Time]
|
6404
6092
|
#
|
6405
6093
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateFrameworkOutput AWS API Documentation
|
@@ -6412,15 +6100,6 @@ module Aws::Backup
|
|
6412
6100
|
include Aws::Structure
|
6413
6101
|
end
|
6414
6102
|
|
6415
|
-
# @note When making an API call, you may pass UpdateGlobalSettingsInput
|
6416
|
-
# data as a hash:
|
6417
|
-
#
|
6418
|
-
# {
|
6419
|
-
# global_settings: {
|
6420
|
-
# "GlobalSettingsName" => "GlobalSettingsValue",
|
6421
|
-
# },
|
6422
|
-
# }
|
6423
|
-
#
|
6424
6103
|
# @!attribute [rw] global_settings
|
6425
6104
|
# A value for `isCrossAccountBackupEnabled` and a Region. Example:
|
6426
6105
|
# `update-global-settings --global-settings
|
@@ -6435,18 +6114,6 @@ module Aws::Backup
|
|
6435
6114
|
include Aws::Structure
|
6436
6115
|
end
|
6437
6116
|
|
6438
|
-
# @note When making an API call, you may pass UpdateRecoveryPointLifecycleInput
|
6439
|
-
# data as a hash:
|
6440
|
-
#
|
6441
|
-
# {
|
6442
|
-
# backup_vault_name: "BackupVaultName", # required
|
6443
|
-
# recovery_point_arn: "ARN", # required
|
6444
|
-
# lifecycle: {
|
6445
|
-
# move_to_cold_storage_after_days: 1,
|
6446
|
-
# delete_after_days: 1,
|
6447
|
-
# },
|
6448
|
-
# }
|
6449
|
-
#
|
6450
6117
|
# @!attribute [rw] backup_vault_name
|
6451
6118
|
# The name of a logical container where backups are stored. Backup
|
6452
6119
|
# vaults are identified by names that are unique to the account used
|
@@ -6530,18 +6197,6 @@ module Aws::Backup
|
|
6530
6197
|
include Aws::Structure
|
6531
6198
|
end
|
6532
6199
|
|
6533
|
-
# @note When making an API call, you may pass UpdateRegionSettingsInput
|
6534
|
-
# data as a hash:
|
6535
|
-
#
|
6536
|
-
# {
|
6537
|
-
# resource_type_opt_in_preference: {
|
6538
|
-
# "ResourceType" => false,
|
6539
|
-
# },
|
6540
|
-
# resource_type_management_preference: {
|
6541
|
-
# "ResourceType" => false,
|
6542
|
-
# },
|
6543
|
-
# }
|
6544
|
-
#
|
6545
6200
|
# @!attribute [rw] resource_type_opt_in_preference
|
6546
6201
|
# Updates the list of services along with the opt-in preferences for
|
6547
6202
|
# the Region.
|
@@ -6568,25 +6223,6 @@ module Aws::Backup
|
|
6568
6223
|
include Aws::Structure
|
6569
6224
|
end
|
6570
6225
|
|
6571
|
-
# @note When making an API call, you may pass UpdateReportPlanInput
|
6572
|
-
# data as a hash:
|
6573
|
-
#
|
6574
|
-
# {
|
6575
|
-
# report_plan_name: "ReportPlanName", # required
|
6576
|
-
# report_plan_description: "ReportPlanDescription",
|
6577
|
-
# report_delivery_channel: {
|
6578
|
-
# s3_bucket_name: "string", # required
|
6579
|
-
# s3_key_prefix: "string",
|
6580
|
-
# formats: ["string"],
|
6581
|
-
# },
|
6582
|
-
# report_setting: {
|
6583
|
-
# report_template: "string", # required
|
6584
|
-
# framework_arns: ["string"],
|
6585
|
-
# number_of_frameworks: 1,
|
6586
|
-
# },
|
6587
|
-
# idempotency_token: "string",
|
6588
|
-
# }
|
6589
|
-
#
|
6590
6226
|
# @!attribute [rw] report_plan_name
|
6591
6227
|
# The unique name of the report plan. This name is between 1 and 256
|
6592
6228
|
# characters, starting with a letter, and consisting of letters (a-z,
|