aws-sdk-backup 1.72.0 → 1.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +266 -261
- data/lib/aws-sdk-backup/client_api.rb +3 -0
- data/lib/aws-sdk-backup/types.rb +641 -582
- data/lib/aws-sdk-backup.rb +1 -1
- data/sig/client.rbs +2 -0
- data/sig/resource.rbs +1 -0
- data/sig/types.rbs +3 -0
- metadata +6 -6
@@ -312,6 +312,15 @@ module Aws::Backup
|
|
312
312
|
#
|
313
313
|
# @option options [String] :session_token
|
314
314
|
#
|
315
|
+
# @option options [Array] :sigv4a_signing_region_set
|
316
|
+
# A list of regions that should be signed with SigV4a signing. When
|
317
|
+
# not passed, a default `:sigv4a_signing_region_set` is searched for
|
318
|
+
# in the following locations:
|
319
|
+
#
|
320
|
+
# * `Aws.config[:sigv4a_signing_region_set]`
|
321
|
+
# * `ENV['AWS_SIGV4A_SIGNING_REGION_SET']`
|
322
|
+
# * `~/.aws/config`
|
323
|
+
#
|
315
324
|
# @option options [Boolean] :stub_responses (false)
|
316
325
|
# Causes the client to return stubbed responses. By default
|
317
326
|
# fake responses are generated and returned. You can specify
|
@@ -416,19 +425,17 @@ module Aws::Backup
|
|
416
425
|
|
417
426
|
# @!group API Operations
|
418
427
|
|
419
|
-
#
|
420
|
-
#
|
428
|
+
# Removes the specified legal hold on a recovery point. This action can
|
429
|
+
# only be performed by a user with sufficient permissions.
|
421
430
|
#
|
422
431
|
# @option params [required, String] :legal_hold_id
|
423
|
-
#
|
424
|
-
# recovery point.
|
432
|
+
# The ID of the legal hold.
|
425
433
|
#
|
426
434
|
# @option params [required, String] :cancel_description
|
427
|
-
#
|
435
|
+
# A string the describes the reason for removing the legal hold.
|
428
436
|
#
|
429
437
|
# @option params [Integer] :retain_record_in_days
|
430
|
-
# The integer amount in days
|
431
|
-
# operation to remove legal hold.
|
438
|
+
# The integer amount, in days, after which to remove legal hold.
|
432
439
|
#
|
433
440
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
434
441
|
#
|
@@ -457,13 +464,11 @@ module Aws::Backup
|
|
457
464
|
# receive an `AlreadyExistsException` exception.
|
458
465
|
#
|
459
466
|
# @option params [required, Types::BackupPlanInput] :backup_plan
|
460
|
-
#
|
461
|
-
#
|
467
|
+
# The body of a backup plan. Includes a `BackupPlanName` and one or more
|
468
|
+
# sets of `Rules`.
|
462
469
|
#
|
463
470
|
# @option params [Hash<String,String>] :backup_plan_tags
|
464
|
-
#
|
465
|
-
# the resources that you create. Each tag is a key-value pair. The
|
466
|
-
# specified tags are assigned to all backups created with this plan.
|
471
|
+
# The tags to assign to the backup plan.
|
467
472
|
#
|
468
473
|
# @option params [String] :creator_request_id
|
469
474
|
# Identifies the request and allows failed requests to be retried
|
@@ -560,12 +565,10 @@ module Aws::Backup
|
|
560
565
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json
|
561
566
|
#
|
562
567
|
# @option params [required, String] :backup_plan_id
|
563
|
-
#
|
564
|
-
# selection of resources.
|
568
|
+
# The ID of the backup plan.
|
565
569
|
#
|
566
570
|
# @option params [required, Types::BackupSelection] :backup_selection
|
567
|
-
#
|
568
|
-
# backup plan.
|
571
|
+
# The body of a request to assign a set of resources to a backup plan.
|
569
572
|
#
|
570
573
|
# @option params [String] :creator_request_id
|
571
574
|
# A unique string that identifies the request and allows failed requests
|
@@ -658,8 +661,7 @@ module Aws::Backup
|
|
658
661
|
# They consist of letters, numbers, and hyphens.
|
659
662
|
#
|
660
663
|
# @option params [Hash<String,String>] :backup_vault_tags
|
661
|
-
#
|
662
|
-
# create. Each tag is a key-value pair.
|
664
|
+
# The tags to assign to the backup vault.
|
663
665
|
#
|
664
666
|
# @option params [String] :encryption_key_arn
|
665
667
|
# The server-side encryption key that is used to protect your backups;
|
@@ -722,8 +724,8 @@ module Aws::Backup
|
|
722
724
|
# characters.
|
723
725
|
#
|
724
726
|
# @option params [required, Array<Types::FrameworkControl>] :framework_controls
|
725
|
-
#
|
726
|
-
#
|
727
|
+
# The controls that make up the framework. Each control in the list has
|
728
|
+
# a name, input parameters, and scope.
|
727
729
|
#
|
728
730
|
# @option params [String] :idempotency_token
|
729
731
|
# A customer-chosen string that you can use to distinguish between
|
@@ -735,8 +737,7 @@ module Aws::Backup
|
|
735
737
|
# not need to pass this option.**
|
736
738
|
#
|
737
739
|
# @option params [Hash<String,String>] :framework_tags
|
738
|
-
#
|
739
|
-
# create. Each tag is a key-value pair.
|
740
|
+
# The tags to assign to the framework.
|
740
741
|
#
|
741
742
|
# @return [Types::CreateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
742
743
|
#
|
@@ -786,17 +787,17 @@ module Aws::Backup
|
|
786
787
|
req.send_request(options)
|
787
788
|
end
|
788
789
|
|
789
|
-
#
|
790
|
-
#
|
791
|
-
#
|
792
|
-
#
|
793
|
-
#
|
790
|
+
# Creates a legal hold on a recovery point (backup). A legal hold is a
|
791
|
+
# restraint on altering or deleting a backup until an authorized user
|
792
|
+
# cancels the legal hold. Any actions to delete or disassociate a
|
793
|
+
# recovery point will fail with an error if one or more active legal
|
794
|
+
# holds are on the recovery point.
|
794
795
|
#
|
795
796
|
# @option params [required, String] :title
|
796
|
-
#
|
797
|
+
# The title of the legal hold.
|
797
798
|
#
|
798
799
|
# @option params [required, String] :description
|
799
|
-
#
|
800
|
+
# The description of the legal hold.
|
800
801
|
#
|
801
802
|
# @option params [String] :idempotency_token
|
802
803
|
# This is a user-chosen string used to distinguish between otherwise
|
@@ -804,8 +805,8 @@ module Aws::Backup
|
|
804
805
|
# idempotency token results in a success message with no action taken.
|
805
806
|
#
|
806
807
|
# @option params [Types::RecoveryPointSelection] :recovery_point_selection
|
807
|
-
#
|
808
|
-
#
|
808
|
+
# The criteria to assign a set of resources, such as resource types or
|
809
|
+
# backup vaults.
|
809
810
|
#
|
810
811
|
# @option params [Hash<String,String>] :tags
|
811
812
|
# Optional tags to include. A tag is a key-value pair you can use to
|
@@ -866,8 +867,7 @@ module Aws::Backup
|
|
866
867
|
req.send_request(options)
|
867
868
|
end
|
868
869
|
|
869
|
-
#
|
870
|
-
# copied.
|
870
|
+
# Creates a logical container to where backups may be copied.
|
871
871
|
#
|
872
872
|
# This request includes a name, the Region, the maximum number of
|
873
873
|
# retention days, the minimum number of retention days, and optionally
|
@@ -879,41 +879,28 @@ module Aws::Backup
|
|
879
879
|
# </note>
|
880
880
|
#
|
881
881
|
# @option params [required, String] :backup_vault_name
|
882
|
-
#
|
882
|
+
# The name of a logical container where backups are stored. Logically
|
883
|
+
# air-gapped backup vaults are identified by names that are unique to
|
884
|
+
# the account used to create them and the Region where they are created.
|
883
885
|
#
|
884
886
|
# @option params [Hash<String,String>] :backup_vault_tags
|
885
|
-
#
|
887
|
+
# The tags to assign to the vault.
|
886
888
|
#
|
887
889
|
# @option params [String] :creator_request_id
|
888
|
-
#
|
890
|
+
# The ID of the creation request.
|
889
891
|
#
|
890
892
|
# This parameter is optional. If used, this parameter must contain 1 to
|
891
893
|
# 50 alphanumeric or '-\_.' characters.
|
892
894
|
#
|
893
895
|
# @option params [required, Integer] :min_retention_days
|
894
896
|
# This setting specifies the minimum retention period that the vault
|
895
|
-
# retains its recovery points.
|
896
|
-
# minimum retention period is enforced.
|
897
|
+
# retains its recovery points.
|
897
898
|
#
|
898
|
-
#
|
899
|
-
# lifecycle policy with a retention period equal to or longer than the
|
900
|
-
# minimum retention period. If a job retention period is shorter than
|
901
|
-
# that minimum retention period, then the vault fails the backup or copy
|
902
|
-
# job, and you should either modify your lifecycle settings or use a
|
903
|
-
# different vault.
|
899
|
+
# The minimum value accepted is 7 days.
|
904
900
|
#
|
905
901
|
# @option params [required, Integer] :max_retention_days
|
906
|
-
#
|
907
|
-
#
|
908
|
-
# specified, Backup does not enforce a maximum retention period on the
|
909
|
-
# recovery points in the vault (allowing indefinite storage).
|
910
|
-
#
|
911
|
-
# If specified, any backup or copy job to the vault must have a
|
912
|
-
# lifecycle policy with a retention period equal to or shorter than the
|
913
|
-
# maximum retention period. If the job retention period is longer than
|
914
|
-
# that maximum retention period, then the vault fails the backup or copy
|
915
|
-
# job, and you should either modify your lifecycle settings or use a
|
916
|
-
# different vault.
|
902
|
+
# The maximum retention period that the vault retains its recovery
|
903
|
+
# points.
|
917
904
|
#
|
918
905
|
# @return [Types::CreateLogicallyAirGappedBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
919
906
|
#
|
@@ -983,8 +970,7 @@ module Aws::Backup
|
|
983
970
|
# report coverage by Amazon Web Services Regions and frameworks.
|
984
971
|
#
|
985
972
|
# @option params [Hash<String,String>] :report_plan_tags
|
986
|
-
#
|
987
|
-
# you create. Each tag is a key-value pair.
|
973
|
+
# The tags to assign to the report plan.
|
988
974
|
#
|
989
975
|
# @option params [String] :idempotency_token
|
990
976
|
# A customer-chosen string that you can use to distinguish between
|
@@ -1040,12 +1026,11 @@ module Aws::Backup
|
|
1040
1026
|
req.send_request(options)
|
1041
1027
|
end
|
1042
1028
|
|
1043
|
-
#
|
1044
|
-
# this request is successful, finish the procedure with request
|
1045
|
-
# CreateRestoreTestingSelection.
|
1029
|
+
# Creates a restore testing plan.
|
1046
1030
|
#
|
1047
|
-
#
|
1048
|
-
#
|
1031
|
+
# The first of two steps to create a restore testing plan. After this
|
1032
|
+
# request is successful, finish the procedure using
|
1033
|
+
# CreateRestoreTestingSelection.
|
1049
1034
|
#
|
1050
1035
|
# @option params [String] :creator_request_id
|
1051
1036
|
# This is a unique string that identifies the request and allows failed
|
@@ -1064,10 +1049,7 @@ module Aws::Backup
|
|
1064
1049
|
# it must consist of only alphanumeric characters and underscores.
|
1065
1050
|
#
|
1066
1051
|
# @option params [Hash<String,String>] :tags
|
1067
|
-
#
|
1068
|
-
# manage, filter, and search for your resources. Allowed characters
|
1069
|
-
# include UTF-8 letters,numbers, spaces, and the following characters: +
|
1070
|
-
# - = . \_ : /.
|
1052
|
+
# The tags to assign to the restore testing plan.
|
1071
1053
|
#
|
1072
1054
|
# @return [Types::CreateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1073
1055
|
#
|
@@ -1284,7 +1266,6 @@ module Aws::Backup
|
|
1284
1266
|
# The name of a logical container where backups are stored. Backup
|
1285
1267
|
# vaults are identified by names that are unique to the account used to
|
1286
1268
|
# create them and the Amazon Web Services Region where they are created.
|
1287
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1288
1269
|
#
|
1289
1270
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1290
1271
|
#
|
@@ -1366,8 +1347,7 @@ module Aws::Backup
|
|
1366
1347
|
# @option params [required, String] :backup_vault_name
|
1367
1348
|
# The name of a logical container where backups are stored. Backup
|
1368
1349
|
# vaults are identified by names that are unique to the account used to
|
1369
|
-
# create them and the Region where they are created.
|
1370
|
-
# lowercase letters, numbers, and hyphens.
|
1350
|
+
# create them and the Region where they are created.
|
1371
1351
|
#
|
1372
1352
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1373
1353
|
#
|
@@ -1435,7 +1415,6 @@ module Aws::Backup
|
|
1435
1415
|
# The name of a logical container where backups are stored. Backup
|
1436
1416
|
# vaults are identified by names that are unique to the account used to
|
1437
1417
|
# create them and the Amazon Web Services Region where they are created.
|
1438
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1439
1418
|
#
|
1440
1419
|
# @option params [required, String] :recovery_point_arn
|
1441
1420
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -1630,16 +1609,16 @@ module Aws::Backup
|
|
1630
1609
|
# The name of a logical container where backups are stored. Backup
|
1631
1610
|
# vaults are identified by names that are unique to the account used to
|
1632
1611
|
# create them and the Amazon Web Services Region where they are created.
|
1633
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1634
1612
|
#
|
1635
1613
|
# @option params [String] :backup_vault_account_id
|
1636
|
-
#
|
1614
|
+
# The account ID of the specified backup vault.
|
1637
1615
|
#
|
1638
1616
|
# @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1639
1617
|
#
|
1640
1618
|
# * {Types::DescribeBackupVaultOutput#backup_vault_name #backup_vault_name} => String
|
1641
1619
|
# * {Types::DescribeBackupVaultOutput#backup_vault_arn #backup_vault_arn} => String
|
1642
1620
|
# * {Types::DescribeBackupVaultOutput#vault_type #vault_type} => String
|
1621
|
+
# * {Types::DescribeBackupVaultOutput#vault_state #vault_state} => String
|
1643
1622
|
# * {Types::DescribeBackupVaultOutput#encryption_key_arn #encryption_key_arn} => String
|
1644
1623
|
# * {Types::DescribeBackupVaultOutput#creation_date #creation_date} => Time
|
1645
1624
|
# * {Types::DescribeBackupVaultOutput#creator_request_id #creator_request_id} => String
|
@@ -1661,6 +1640,7 @@ module Aws::Backup
|
|
1661
1640
|
# resp.backup_vault_name #=> String
|
1662
1641
|
# resp.backup_vault_arn #=> String
|
1663
1642
|
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
1643
|
+
# resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
1664
1644
|
# resp.encryption_key_arn #=> String
|
1665
1645
|
# resp.creation_date #=> Time
|
1666
1646
|
# resp.creator_request_id #=> String
|
@@ -1863,7 +1843,6 @@ module Aws::Backup
|
|
1863
1843
|
# The name of a logical container where backups are stored. Backup
|
1864
1844
|
# vaults are identified by names that are unique to the account used to
|
1865
1845
|
# create them and the Amazon Web Services Region where they are created.
|
1866
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1867
1846
|
#
|
1868
1847
|
# @option params [required, String] :recovery_point_arn
|
1869
1848
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -1871,7 +1850,7 @@ module Aws::Backup
|
|
1871
1850
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
1872
1851
|
#
|
1873
1852
|
# @option params [String] :backup_vault_account_id
|
1874
|
-
#
|
1853
|
+
# The account ID of the specified backup vault.
|
1875
1854
|
#
|
1876
1855
|
# @return [Types::DescribeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1877
1856
|
#
|
@@ -2169,15 +2148,14 @@ module Aws::Backup
|
|
2169
2148
|
# (composite) recovery point.
|
2170
2149
|
#
|
2171
2150
|
# @option params [required, String] :backup_vault_name
|
2172
|
-
#
|
2173
|
-
#
|
2174
|
-
#
|
2175
|
-
#
|
2176
|
-
# letters, numbers, and hyphens.
|
2151
|
+
# The name of a logical container where the child (nested) recovery
|
2152
|
+
# point is stored. Backup vaults are identified by names that are unique
|
2153
|
+
# to the account used to create them and the Amazon Web Services Region
|
2154
|
+
# where they are created.
|
2177
2155
|
#
|
2178
2156
|
# @option params [required, String] :recovery_point_arn
|
2179
|
-
#
|
2180
|
-
#
|
2157
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the child
|
2158
|
+
# (nested) recovery point; for example,
|
2181
2159
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
|
2182
2160
|
#
|
2183
2161
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2476,7 +2454,6 @@ module Aws::Backup
|
|
2476
2454
|
# The name of a logical container where backups are stored. Backup
|
2477
2455
|
# vaults are identified by names that are unique to the account used to
|
2478
2456
|
# create them and the Amazon Web Services Region where they are created.
|
2479
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
2480
2457
|
#
|
2481
2458
|
# @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2482
2459
|
#
|
@@ -2511,7 +2488,6 @@ module Aws::Backup
|
|
2511
2488
|
# The name of a logical container where backups are stored. Backup
|
2512
2489
|
# vaults are identified by names that are unique to the account used to
|
2513
2490
|
# create them and the Amazon Web Services Region where they are created.
|
2514
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
2515
2491
|
#
|
2516
2492
|
# @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2517
2493
|
#
|
@@ -2547,8 +2523,7 @@ module Aws::Backup
|
|
2547
2523
|
# are the body of a legal hold in JSON format, in addition to metadata.
|
2548
2524
|
#
|
2549
2525
|
# @option params [required, String] :legal_hold_id
|
2550
|
-
#
|
2551
|
-
# associated with a specific legal hold.
|
2526
|
+
# The ID of the legal hold.
|
2552
2527
|
#
|
2553
2528
|
# @return [Types::GetLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2554
2529
|
#
|
@@ -2603,7 +2578,6 @@ module Aws::Backup
|
|
2603
2578
|
# The name of a logical container where backups are stored. Backup
|
2604
2579
|
# vaults are identified by names that are unique to the account used to
|
2605
2580
|
# create them and the Amazon Web Services Region where they are created.
|
2606
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
2607
2581
|
#
|
2608
2582
|
# @option params [required, String] :recovery_point_arn
|
2609
2583
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -2611,7 +2585,7 @@ module Aws::Backup
|
|
2611
2585
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
2612
2586
|
#
|
2613
2587
|
# @option params [String] :backup_vault_account_id
|
2614
|
-
#
|
2588
|
+
# The account ID of the specified backup vault.
|
2615
2589
|
#
|
2616
2590
|
# @return [Types::GetRecoveryPointRestoreMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2617
2591
|
#
|
@@ -2682,7 +2656,7 @@ module Aws::Backup
|
|
2682
2656
|
# is an optional parameter.
|
2683
2657
|
#
|
2684
2658
|
# @option params [String] :backup_vault_account_id
|
2685
|
-
#
|
2659
|
+
# The account ID of the specified backup vault.
|
2686
2660
|
#
|
2687
2661
|
# @option params [required, String] :backup_vault_name
|
2688
2662
|
# The name of a logical container where backups are stored. Backup
|
@@ -2912,18 +2886,16 @@ module Aws::Backup
|
|
2912
2886
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
2913
2887
|
#
|
2914
2888
|
# @option params [String] :aggregation_period
|
2915
|
-
#
|
2916
|
-
#
|
2917
|
-
# Acceptable values include
|
2889
|
+
# The period for the returned results.
|
2918
2890
|
#
|
2919
|
-
# * `ONE_DAY`
|
2891
|
+
# * `ONE_DAY` - The daily job count for the prior 14 days.
|
2920
2892
|
#
|
2921
|
-
# * `SEVEN_DAYS`
|
2893
|
+
# * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
|
2922
2894
|
#
|
2923
|
-
# * `FOURTEEN_DAYS`
|
2895
|
+
# * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
|
2924
2896
|
#
|
2925
2897
|
# @option params [Integer] :max_results
|
2926
|
-
#
|
2898
|
+
# The maximum number of items to be returned.
|
2927
2899
|
#
|
2928
2900
|
# The value is an integer. Range of accepted values is from 1 to 500.
|
2929
2901
|
#
|
@@ -3016,8 +2988,7 @@ module Aws::Backup
|
|
3016
2988
|
# Returns only backup jobs that will be stored in the specified backup
|
3017
2989
|
# vault. Backup vaults are identified by names that are unique to the
|
3018
2990
|
# account used to create them and the Amazon Web Services Region where
|
3019
|
-
# they are created.
|
3020
|
-
# hyphens.
|
2991
|
+
# they are created.
|
3021
2992
|
#
|
3022
2993
|
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
3023
2994
|
# Returns only backup jobs that were created before the specified date.
|
@@ -3046,19 +3017,20 @@ module Aws::Backup
|
|
3046
3017
|
#
|
3047
3018
|
# * `Neptune` for Amazon Neptune
|
3048
3019
|
#
|
3020
|
+
# * `RDS` for Amazon Relational Database Service
|
3021
|
+
#
|
3049
3022
|
# * `Redshift` for Amazon Redshift
|
3050
3023
|
#
|
3051
|
-
# * `
|
3024
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
3052
3025
|
#
|
3053
|
-
# * `SAP HANA on Amazon EC2` for SAP HANA databases
|
3026
|
+
# * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
|
3027
|
+
# Compute Cloud instances
|
3054
3028
|
#
|
3055
3029
|
# * `Storage Gateway` for Storage Gateway
|
3056
3030
|
#
|
3057
|
-
# * `S3` for Amazon S3
|
3058
|
-
#
|
3059
3031
|
# * `Timestream` for Amazon Timestream
|
3060
3032
|
#
|
3061
|
-
# * `VirtualMachine` for virtual machines
|
3033
|
+
# * `VirtualMachine` for VMware virtual machines
|
3062
3034
|
#
|
3063
3035
|
# @option params [String] :by_account_id
|
3064
3036
|
# The account ID to list the jobs from. Returns only backup jobs
|
@@ -3164,8 +3136,7 @@ module Aws::Backup
|
|
3164
3136
|
req.send_request(options)
|
3165
3137
|
end
|
3166
3138
|
|
3167
|
-
#
|
3168
|
-
# template ID, name, and the creation and deletion dates.
|
3139
|
+
# Lists the backup plan templates.
|
3169
3140
|
#
|
3170
3141
|
# @option params [String] :next_token
|
3171
3142
|
# The next item following a partial list of returned items. For example,
|
@@ -3174,7 +3145,7 @@ module Aws::Backup
|
|
3174
3145
|
# the location pointed to by the next token.
|
3175
3146
|
#
|
3176
3147
|
# @option params [Integer] :max_results
|
3177
|
-
# The maximum number of items to
|
3148
|
+
# The maximum number of items to return.
|
3178
3149
|
#
|
3179
3150
|
# @return [Types::ListBackupPlanTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3180
3151
|
#
|
@@ -3263,10 +3234,7 @@ module Aws::Backup
|
|
3263
3234
|
req.send_request(options)
|
3264
3235
|
end
|
3265
3236
|
|
3266
|
-
#
|
3267
|
-
# account. The list contains information such as Amazon Resource Names
|
3268
|
-
# (ARNs), plan IDs, creation and deletion dates, version IDs, plan
|
3269
|
-
# names, and creator request IDs.
|
3237
|
+
# Lists the active backup plans for the account.
|
3270
3238
|
#
|
3271
3239
|
# @option params [String] :next_token
|
3272
3240
|
# The next item following a partial list of returned items. For example,
|
@@ -3411,6 +3379,8 @@ module Aws::Backup
|
|
3411
3379
|
# resp.backup_vault_list #=> Array
|
3412
3380
|
# resp.backup_vault_list[0].backup_vault_name #=> String
|
3413
3381
|
# resp.backup_vault_list[0].backup_vault_arn #=> String
|
3382
|
+
# resp.backup_vault_list[0].vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
3383
|
+
# resp.backup_vault_list[0].vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
3414
3384
|
# resp.backup_vault_list[0].creation_date #=> Time
|
3415
3385
|
# resp.backup_vault_list[0].encryption_key_arn #=> String
|
3416
3386
|
# resp.backup_vault_list[0].creator_request_id #=> String
|
@@ -3493,13 +3463,13 @@ module Aws::Backup
|
|
3493
3463
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
3494
3464
|
#
|
3495
3465
|
# @option params [String] :aggregation_period
|
3496
|
-
#
|
3466
|
+
# The period for the returned results.
|
3497
3467
|
#
|
3498
|
-
# * `ONE_DAY`
|
3468
|
+
# * `ONE_DAY` - The daily job count for the prior 14 days.
|
3499
3469
|
#
|
3500
|
-
# * `SEVEN_DAYS`
|
3470
|
+
# * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
|
3501
3471
|
#
|
3502
|
-
# * `FOURTEEN_DAYS`
|
3472
|
+
# * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
|
3503
3473
|
#
|
3504
3474
|
# @option params [Integer] :max_results
|
3505
3475
|
# This parameter sets the maximum number of items to be returned.
|
@@ -3600,24 +3570,25 @@ module Aws::Backup
|
|
3600
3570
|
#
|
3601
3571
|
# * `Neptune` for Amazon Neptune
|
3602
3572
|
#
|
3573
|
+
# * `RDS` for Amazon Relational Database Service
|
3574
|
+
#
|
3603
3575
|
# * `Redshift` for Amazon Redshift
|
3604
3576
|
#
|
3605
|
-
# * `
|
3577
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
3606
3578
|
#
|
3607
|
-
# * `SAP HANA on Amazon EC2` for SAP HANA databases
|
3579
|
+
# * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
|
3580
|
+
# Compute Cloud instances
|
3608
3581
|
#
|
3609
3582
|
# * `Storage Gateway` for Storage Gateway
|
3610
3583
|
#
|
3611
|
-
# * `S3` for Amazon S3
|
3612
|
-
#
|
3613
3584
|
# * `Timestream` for Amazon Timestream
|
3614
3585
|
#
|
3615
|
-
# * `VirtualMachine` for virtual machines
|
3586
|
+
# * `VirtualMachine` for VMware virtual machines
|
3616
3587
|
#
|
3617
3588
|
# @option params [String] :by_destination_vault_arn
|
3618
3589
|
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
3619
3590
|
# vault to copy from; for example,
|
3620
|
-
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
3591
|
+
# `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
|
3621
3592
|
#
|
3622
3593
|
# @option params [String] :by_account_id
|
3623
3594
|
# The account ID to list the jobs from. Returns only copy jobs
|
@@ -3860,12 +3831,12 @@ module Aws::Backup
|
|
3860
3831
|
# backup vault.
|
3861
3832
|
#
|
3862
3833
|
# @option params [required, String] :backup_vault_name
|
3863
|
-
#
|
3864
|
-
#
|
3834
|
+
# The list of protected resources by backup vault within the vault(s)
|
3835
|
+
# you specify by name.
|
3865
3836
|
#
|
3866
3837
|
# @option params [String] :backup_vault_account_id
|
3867
|
-
#
|
3868
|
-
#
|
3838
|
+
# The list of protected resources by backup vault within the vault(s)
|
3839
|
+
# you specify by account ID.
|
3869
3840
|
#
|
3870
3841
|
# @option params [String] :next_token
|
3871
3842
|
# The next item following a partial list of returned items. For example,
|
@@ -3919,7 +3890,6 @@ module Aws::Backup
|
|
3919
3890
|
# The name of a logical container where backups are stored. Backup
|
3920
3891
|
# vaults are identified by names that are unique to the account used to
|
3921
3892
|
# create them and the Amazon Web Services Region where they are created.
|
3922
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
3923
3893
|
#
|
3924
3894
|
# <note markdown="1"> Backup vault name might not be available when a supported service
|
3925
3895
|
# creates the backup.
|
@@ -3964,19 +3934,20 @@ module Aws::Backup
|
|
3964
3934
|
#
|
3965
3935
|
# * `Neptune` for Amazon Neptune
|
3966
3936
|
#
|
3937
|
+
# * `RDS` for Amazon Relational Database Service
|
3938
|
+
#
|
3967
3939
|
# * `Redshift` for Amazon Redshift
|
3968
3940
|
#
|
3969
|
-
# * `
|
3941
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
3970
3942
|
#
|
3971
|
-
# * `SAP HANA on Amazon EC2` for SAP HANA databases
|
3943
|
+
# * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
|
3944
|
+
# Compute Cloud instances
|
3972
3945
|
#
|
3973
3946
|
# * `Storage Gateway` for Storage Gateway
|
3974
3947
|
#
|
3975
|
-
# * `S3` for Amazon S3
|
3976
|
-
#
|
3977
3948
|
# * `Timestream` for Amazon Timestream
|
3978
3949
|
#
|
3979
|
-
# * `VirtualMachine` for virtual machines
|
3950
|
+
# * `VirtualMachine` for VMware virtual machines
|
3980
3951
|
#
|
3981
3952
|
# @option params [String] :by_backup_plan_id
|
3982
3953
|
# Returns only recovery points that match the specified backup plan ID.
|
@@ -4062,16 +4033,16 @@ module Aws::Backup
|
|
4062
4033
|
# specified legal hold.
|
4063
4034
|
#
|
4064
4035
|
# @option params [required, String] :legal_hold_id
|
4065
|
-
#
|
4036
|
+
# The ID of the legal hold.
|
4066
4037
|
#
|
4067
4038
|
# @option params [String] :next_token
|
4068
|
-
#
|
4069
|
-
#
|
4039
|
+
# The next item following a partial list of returned resources. For
|
4040
|
+
# example, if a request is made to return `MaxResults` number of
|
4070
4041
|
# resources, `NextToken` allows you to return more items in your list
|
4071
4042
|
# starting at the location pointed to by the next token.
|
4072
4043
|
#
|
4073
4044
|
# @option params [Integer] :max_results
|
4074
|
-
#
|
4045
|
+
# The maximum number of resource list items to be returned.
|
4075
4046
|
#
|
4076
4047
|
# @return [Types::ListRecoveryPointsByLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4077
4048
|
#
|
@@ -4106,8 +4077,8 @@ module Aws::Backup
|
|
4106
4077
|
req.send_request(options)
|
4107
4078
|
end
|
4108
4079
|
|
4109
|
-
#
|
4110
|
-
#
|
4080
|
+
# The information about the recovery points of the type specified by a
|
4081
|
+
# resource Amazon Resource Name (ARN).
|
4111
4082
|
#
|
4112
4083
|
# <note markdown="1"> For Amazon EFS and Amazon EC2, this action only lists recovery points
|
4113
4084
|
# created by Backup.
|
@@ -4364,15 +4335,13 @@ module Aws::Backup
|
|
4364
4335
|
# Relational Database Service (Amazon RDS) database.
|
4365
4336
|
#
|
4366
4337
|
# @option params [String] :aggregation_period
|
4367
|
-
#
|
4338
|
+
# The period for the returned results.
|
4368
4339
|
#
|
4369
|
-
#
|
4340
|
+
# * `ONE_DAY` - The daily job count for the prior 14 days.
|
4370
4341
|
#
|
4371
|
-
# * `
|
4342
|
+
# * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
|
4372
4343
|
#
|
4373
|
-
# * `
|
4374
|
-
#
|
4375
|
-
# * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
|
4344
|
+
# * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
|
4376
4345
|
#
|
4377
4346
|
# @option params [Integer] :max_results
|
4378
4347
|
# This parameter sets the maximum number of items to be returned.
|
@@ -4464,19 +4433,20 @@ module Aws::Backup
|
|
4464
4433
|
#
|
4465
4434
|
# * `Neptune` for Amazon Neptune
|
4466
4435
|
#
|
4436
|
+
# * `RDS` for Amazon Relational Database Service
|
4437
|
+
#
|
4467
4438
|
# * `Redshift` for Amazon Redshift
|
4468
4439
|
#
|
4469
|
-
# * `
|
4440
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
4470
4441
|
#
|
4471
|
-
# * `SAP HANA on Amazon EC2` for SAP HANA databases
|
4442
|
+
# * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
|
4443
|
+
# Compute Cloud instances
|
4472
4444
|
#
|
4473
4445
|
# * `Storage Gateway` for Storage Gateway
|
4474
4446
|
#
|
4475
|
-
# * `S3` for Amazon S3
|
4476
|
-
#
|
4477
4447
|
# * `Timestream` for Amazon Timestream
|
4478
4448
|
#
|
4479
|
-
# * `VirtualMachine` for virtual machines
|
4449
|
+
# * `VirtualMachine` for VMware virtual machines
|
4480
4450
|
#
|
4481
4451
|
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
4482
4452
|
# Returns only restore jobs that were created before the specified date.
|
@@ -4735,17 +4705,8 @@ module Aws::Backup
|
|
4735
4705
|
req.send_request(options)
|
4736
4706
|
end
|
4737
4707
|
|
4738
|
-
# Returns
|
4739
|
-
# backup plan, or backup vault.
|
4740
|
-
#
|
4741
|
-
# `ListTags` only works for resource types that support full Backup
|
4742
|
-
# management of their backups. Those resource types are listed in the
|
4743
|
-
# "Full Backup management" section of the [ Feature availability by
|
4744
|
-
# resource][1] table.
|
4745
|
-
#
|
4746
|
-
#
|
4747
|
-
#
|
4748
|
-
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
|
4708
|
+
# Returns the tags assigned to the resource, such as a target recovery
|
4709
|
+
# point, backup plan, or backup vault.
|
4749
4710
|
#
|
4750
4711
|
# @option params [required, String] :resource_arn
|
4751
4712
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
@@ -4799,7 +4760,6 @@ module Aws::Backup
|
|
4799
4760
|
# The name of a logical container where backups are stored. Backup
|
4800
4761
|
# vaults are identified by names that are unique to the account used to
|
4801
4762
|
# create them and the Amazon Web Services Region where they are created.
|
4802
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
4803
4763
|
#
|
4804
4764
|
# @option params [String] :policy
|
4805
4765
|
# The backup vault access policy document in JSON format.
|
@@ -4834,10 +4794,17 @@ module Aws::Backup
|
|
4834
4794
|
# environments that are subject to SEC 17a-4, CFTC, and FINRA
|
4835
4795
|
# regulations. For more information about how Backup Vault Lock relates
|
4836
4796
|
# to these regulations, see the [Cohasset Associates Compliance
|
4837
|
-
# Assessment.]
|
4797
|
+
# Assessment.][1]
|
4838
4798
|
#
|
4839
4799
|
# </note>
|
4840
4800
|
#
|
4801
|
+
# For more information, see [Backup Vault Lock][2].
|
4802
|
+
#
|
4803
|
+
#
|
4804
|
+
#
|
4805
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/samples/cohassetreport.zip
|
4806
|
+
# [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html
|
4807
|
+
#
|
4841
4808
|
# @option params [required, String] :backup_vault_name
|
4842
4809
|
# The Backup Vault Lock configuration that specifies the name of the
|
4843
4810
|
# backup vault it protects.
|
@@ -4849,8 +4816,10 @@ module Aws::Backup
|
|
4849
4816
|
# require you to retain certain data for at least seven years (2555
|
4850
4817
|
# days).
|
4851
4818
|
#
|
4852
|
-
#
|
4853
|
-
#
|
4819
|
+
# This parameter is required when a vault lock is created through
|
4820
|
+
# CloudFormation; otherwise, this parameter is optional. If this
|
4821
|
+
# parameter is not specified, Vault Lock will not enforce a minimum
|
4822
|
+
# retention period.
|
4854
4823
|
#
|
4855
4824
|
# If this parameter is specified, any backup or copy job to the vault
|
4856
4825
|
# must have a lifecycle policy with a retention period equal to or
|
@@ -4931,7 +4900,6 @@ module Aws::Backup
|
|
4931
4900
|
# The name of a logical container where backups are stored. Backup
|
4932
4901
|
# vaults are identified by names that are unique to the account used to
|
4933
4902
|
# create them and the Amazon Web Services Region where they are created.
|
4934
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
4935
4903
|
#
|
4936
4904
|
# @option params [required, String] :sns_topic_arn
|
4937
4905
|
# The Amazon Resource Name (ARN) that specifies the topic for a backup
|
@@ -4956,9 +4924,9 @@ module Aws::Backup
|
|
4956
4924
|
#
|
4957
4925
|
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
4958
4926
|
#
|
4959
|
-
# <note markdown="1"> The list below
|
4960
|
-
#
|
4961
|
-
# return statuses or notifications. Refer to the list above for
|
4927
|
+
# <note markdown="1"> The list below includes both supported events and deprecated events
|
4928
|
+
# that are no longer in use (for reference). Deprecated events do not
|
4929
|
+
# return statuses or notifications. Refer to the list above for the
|
4962
4930
|
# supported events.
|
4963
4931
|
#
|
4964
4932
|
# </note>
|
@@ -4994,7 +4962,7 @@ module Aws::Backup
|
|
4994
4962
|
# This is a unique identifier of a restore job within Backup.
|
4995
4963
|
#
|
4996
4964
|
# @option params [required, String] :validation_status
|
4997
|
-
#
|
4965
|
+
# The status of your restore validation.
|
4998
4966
|
#
|
4999
4967
|
# @option params [String] :validation_status_message
|
5000
4968
|
# This is an optional message string you can input to describe the
|
@@ -5025,7 +4993,6 @@ module Aws::Backup
|
|
5025
4993
|
# The name of a logical container where backups are stored. Backup
|
5026
4994
|
# vaults are identified by names that are unique to the account used to
|
5027
4995
|
# create them and the Amazon Web Services Region where they are created.
|
5028
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
5029
4996
|
#
|
5030
4997
|
# @option params [required, String] :resource_arn
|
5031
4998
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
@@ -5079,25 +5046,22 @@ module Aws::Backup
|
|
5079
5046
|
# “transition to cold after days” setting cannot be changed after a
|
5080
5047
|
# backup has been transitioned to cold.
|
5081
5048
|
#
|
5082
|
-
# Resource types that
|
5083
|
-
#
|
5084
|
-
#
|
5085
|
-
# other resource types.
|
5049
|
+
# Resource types that can transition to cold storage are listed in the
|
5050
|
+
# [Feature availability by resource][1] table. Backup ignores this
|
5051
|
+
# expression for other resource types.
|
5086
5052
|
#
|
5087
5053
|
# This parameter has a maximum value of 100 years (36,500 days).
|
5088
5054
|
#
|
5089
5055
|
#
|
5090
5056
|
#
|
5091
|
-
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/
|
5057
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
|
5092
5058
|
#
|
5093
5059
|
# @option params [Hash<String,String>] :recovery_point_tags
|
5094
|
-
#
|
5095
|
-
# the resources that you create. Each tag is a key-value pair.
|
5060
|
+
# The tags to assign to the resources.
|
5096
5061
|
#
|
5097
5062
|
# @option params [Hash<String,String>] :backup_options
|
5098
|
-
#
|
5099
|
-
#
|
5100
|
-
# jobs.
|
5063
|
+
# The backup option for a selected resource. This option is only
|
5064
|
+
# available for Windows Volume Shadow Copy Service (VSS) backup jobs.
|
5101
5065
|
#
|
5102
5066
|
# Valid values: Set to `"WindowsVSS":"enabled"` to enable the
|
5103
5067
|
# `WindowsVSS` backup option and create a Windows VSS backup. Set to
|
@@ -5162,12 +5126,12 @@ module Aws::Backup
|
|
5162
5126
|
# The name of a logical source container where backups are stored.
|
5163
5127
|
# Backup vaults are identified by names that are unique to the account
|
5164
5128
|
# used to create them and the Amazon Web Services Region where they are
|
5165
|
-
# created.
|
5129
|
+
# created.
|
5166
5130
|
#
|
5167
5131
|
# @option params [required, String] :destination_backup_vault_arn
|
5168
5132
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
5169
5133
|
# backup vault to copy to; for example,
|
5170
|
-
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
5134
|
+
# `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
|
5171
5135
|
#
|
5172
5136
|
# @option params [required, String] :iam_role_arn
|
5173
5137
|
# Specifies the IAM role ARN used to copy the target recovery point; for
|
@@ -5180,23 +5144,26 @@ module Aws::Backup
|
|
5180
5144
|
# with no action taken.
|
5181
5145
|
#
|
5182
5146
|
# @option params [Types::Lifecycle] :lifecycle
|
5183
|
-
#
|
5184
|
-
#
|
5147
|
+
# Specifies the time period, in days, before a recovery point
|
5148
|
+
# transitions to cold storage or is deleted.
|
5185
5149
|
#
|
5186
5150
|
# Backups transitioned to cold storage must be stored in cold storage
|
5187
|
-
# for a minimum of 90 days. Therefore, on the console, the
|
5188
|
-
# setting must be 90 days greater than the
|
5189
|
-
#
|
5190
|
-
#
|
5151
|
+
# for a minimum of 90 days. Therefore, on the console, the retention
|
5152
|
+
# setting must be 90 days greater than the transition to cold after days
|
5153
|
+
# setting. The transition to cold after days setting can't be changed
|
5154
|
+
# after a backup has been transitioned to cold.
|
5155
|
+
#
|
5156
|
+
# Resource types that can transition to cold storage are listed in the
|
5157
|
+
# [Feature availability by resource][1] table. Backup ignores this
|
5158
|
+
# expression for other resource types.
|
5191
5159
|
#
|
5192
|
-
#
|
5193
|
-
#
|
5194
|
-
#
|
5195
|
-
# other resource types.
|
5160
|
+
# To remove the existing lifecycle and retention periods and keep your
|
5161
|
+
# recovery points indefinitely, specify -1 for
|
5162
|
+
# `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
|
5196
5163
|
#
|
5197
5164
|
#
|
5198
5165
|
#
|
5199
|
-
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/
|
5166
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
|
5200
5167
|
#
|
5201
5168
|
# @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5202
5169
|
#
|
@@ -5280,8 +5247,7 @@ module Aws::Backup
|
|
5280
5247
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
5281
5248
|
#
|
5282
5249
|
# @option params [required, Hash<String,String>] :metadata
|
5283
|
-
# A set of metadata key-value pairs.
|
5284
|
-
# resource name, required to restore a recovery point.
|
5250
|
+
# A set of metadata key-value pairs.
|
5285
5251
|
#
|
5286
5252
|
# You can get configuration metadata about a resource at the time it was
|
5287
5253
|
# backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
@@ -5290,33 +5256,56 @@ module Aws::Backup
|
|
5290
5256
|
# resource. For example, you might need to provide a new resource name
|
5291
5257
|
# if the original already exists.
|
5292
5258
|
#
|
5293
|
-
#
|
5294
|
-
#
|
5259
|
+
# For more information about the metadata for each resource, see the
|
5260
|
+
# following:
|
5261
|
+
#
|
5262
|
+
# * [Metadata for Amazon Aurora][1]
|
5263
|
+
#
|
5264
|
+
# * [Metadata for Amazon DocumentDB][2]
|
5295
5265
|
#
|
5296
|
-
# *
|
5297
|
-
# backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`.
|
5266
|
+
# * [Metadata for CloudFormation][3]
|
5298
5267
|
#
|
5299
|
-
# *
|
5300
|
-
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
5301
|
-
# set to `true`.
|
5268
|
+
# * [Metadata for Amazon DynamoDB][4]
|
5302
5269
|
#
|
5303
|
-
# *
|
5304
|
-
# to encrypt the restored file system. You can specify a key from
|
5305
|
-
# another Amazon Web Services account provided that key it is properly
|
5306
|
-
# shared with your account via Amazon Web Services KMS.
|
5270
|
+
# * [ Metadata for Amazon EBS][5]
|
5307
5271
|
#
|
5308
|
-
# *
|
5272
|
+
# * [Metadata for Amazon EC2][6]
|
5309
5273
|
#
|
5310
|
-
# *
|
5311
|
-
# (idempotency) of the request.
|
5274
|
+
# * [Metadata for Amazon EFS][7]
|
5312
5275
|
#
|
5313
|
-
# *
|
5314
|
-
# recovery point is restored to a new Amazon EFS file system.
|
5276
|
+
# * [Metadata for Amazon FSx][8]
|
5315
5277
|
#
|
5316
|
-
# *
|
5317
|
-
#
|
5318
|
-
#
|
5319
|
-
#
|
5278
|
+
# * [Metadata for Amazon Neptune][9]
|
5279
|
+
#
|
5280
|
+
# * [Metadata for Amazon RDS][10]
|
5281
|
+
#
|
5282
|
+
# * [Metadata for Amazon Redshift][11]
|
5283
|
+
#
|
5284
|
+
# * [Metadata for Storage Gateway][12]
|
5285
|
+
#
|
5286
|
+
# * [Metadata for Amazon S3][13]
|
5287
|
+
#
|
5288
|
+
# * [Metadata for Amazon Timestream][14]
|
5289
|
+
#
|
5290
|
+
# * [Metadata for virtual machines][15]
|
5291
|
+
#
|
5292
|
+
#
|
5293
|
+
#
|
5294
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli
|
5295
|
+
# [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli
|
5296
|
+
# [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli
|
5297
|
+
# [4]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli
|
5298
|
+
# [5]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli
|
5299
|
+
# [6]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli
|
5300
|
+
# [7]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli
|
5301
|
+
# [8]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli
|
5302
|
+
# [9]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli
|
5303
|
+
# [10]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli
|
5304
|
+
# [11]: https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api
|
5305
|
+
# [12]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli
|
5306
|
+
# [13]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli
|
5307
|
+
# [14]: https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api
|
5308
|
+
# [15]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli
|
5320
5309
|
#
|
5321
5310
|
# @option params [String] :iam_role_arn
|
5322
5311
|
# The Amazon Resource Name (ARN) of the IAM role that Backup uses to
|
@@ -5333,35 +5322,35 @@ module Aws::Backup
|
|
5333
5322
|
# Starts a job to restore a recovery point for one of the following
|
5334
5323
|
# resources:
|
5335
5324
|
#
|
5336
|
-
# * `Aurora`
|
5325
|
+
# * `Aurora` - Amazon Aurora
|
5337
5326
|
#
|
5338
|
-
# * `DocumentDB`
|
5327
|
+
# * `DocumentDB` - Amazon DocumentDB
|
5339
5328
|
#
|
5340
|
-
# * `CloudFormation`
|
5329
|
+
# * `CloudFormation` - CloudFormation
|
5341
5330
|
#
|
5342
|
-
# * `DynamoDB`
|
5331
|
+
# * `DynamoDB` - Amazon DynamoDB
|
5343
5332
|
#
|
5344
|
-
# * `EBS`
|
5333
|
+
# * `EBS` - Amazon Elastic Block Store
|
5345
5334
|
#
|
5346
|
-
# * `EC2`
|
5335
|
+
# * `EC2` - Amazon Elastic Compute Cloud
|
5347
5336
|
#
|
5348
|
-
# * `EFS`
|
5337
|
+
# * `EFS` - Amazon Elastic File System
|
5349
5338
|
#
|
5350
|
-
# * `FSx`
|
5339
|
+
# * `FSx` - Amazon FSx
|
5351
5340
|
#
|
5352
|
-
# * `Neptune`
|
5341
|
+
# * `Neptune` - Amazon Neptune
|
5353
5342
|
#
|
5354
|
-
# * `RDS`
|
5343
|
+
# * `RDS` - Amazon Relational Database Service
|
5355
5344
|
#
|
5356
|
-
# * `Redshift`
|
5345
|
+
# * `Redshift` - Amazon Redshift
|
5357
5346
|
#
|
5358
|
-
# * `Storage Gateway`
|
5347
|
+
# * `Storage Gateway` - Storage Gateway
|
5359
5348
|
#
|
5360
|
-
# * `S3`
|
5349
|
+
# * `S3` - Amazon Simple Storage Service
|
5361
5350
|
#
|
5362
|
-
# * `Timestream`
|
5351
|
+
# * `Timestream` - Amazon Timestream
|
5363
5352
|
#
|
5364
|
-
# * `VirtualMachine`
|
5353
|
+
# * `VirtualMachine` - Virtual machines
|
5365
5354
|
#
|
5366
5355
|
# @option params [Boolean] :copy_source_tags_to_restored_resource
|
5367
5356
|
# This is an optional parameter. If this equals `True`, tags included in
|
@@ -5403,7 +5392,7 @@ module Aws::Backup
|
|
5403
5392
|
#
|
5404
5393
|
# This action is not supported for the following services: Amazon FSx
|
5405
5394
|
# for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp
|
5406
|
-
# ONTAP
|
5395
|
+
# ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
|
5407
5396
|
# compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
|
5408
5397
|
#
|
5409
5398
|
# @option params [required, String] :backup_job_id
|
@@ -5429,10 +5418,19 @@ module Aws::Backup
|
|
5429
5418
|
# Assigns a set of key-value pairs to a recovery point, backup plan, or
|
5430
5419
|
# backup vault identified by an Amazon Resource Name (ARN).
|
5431
5420
|
#
|
5421
|
+
# This API is supported for recovery points for resource types including
|
5422
|
+
# Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune, and Amazon
|
5423
|
+
# RDS.
|
5424
|
+
#
|
5432
5425
|
# @option params [required, String] :resource_arn
|
5433
5426
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
5434
5427
|
# depends on the type of the tagged resource.
|
5435
5428
|
#
|
5429
|
+
# ARNs that do not include `backup` are incompatible with tagging.
|
5430
|
+
# `TagResource` and `UntagResource` with invalid ARNs will result in an
|
5431
|
+
# error. Acceptable ARN content can include `arn:aws:backup:us-east`.
|
5432
|
+
# Invalid ARN content may look like `arn:aws:ec2:us-east`.
|
5433
|
+
#
|
5436
5434
|
# @option params [required, Hash<String,String>] :tags
|
5437
5435
|
# Key-value pairs that are used to help organize your resources. You can
|
5438
5436
|
# assign your own metadata to the resources you create. For clarity,
|
@@ -5462,13 +5460,21 @@ module Aws::Backup
|
|
5462
5460
|
# Removes a set of key-value pairs from a recovery point, backup plan,
|
5463
5461
|
# or backup vault identified by an Amazon Resource Name (ARN)
|
5464
5462
|
#
|
5463
|
+
# This API is not supported for recovery points for resource types
|
5464
|
+
# including Aurora, Amazon DocumentDB. Amazon EBS, Amazon FSx, Neptune,
|
5465
|
+
# and Amazon RDS.
|
5466
|
+
#
|
5465
5467
|
# @option params [required, String] :resource_arn
|
5466
5468
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
5467
5469
|
# depends on the type of the tagged resource.
|
5468
5470
|
#
|
5471
|
+
# ARNs that do not include `backup` are incompatible with tagging.
|
5472
|
+
# `TagResource` and `UntagResource` with invalid ARNs will result in an
|
5473
|
+
# error. Acceptable ARN content can include `arn:aws:backup:us-east`.
|
5474
|
+
# Invalid ARN content may look like `arn:aws:ec2:us-east`.
|
5475
|
+
#
|
5469
5476
|
# @option params [required, Array<String>] :tag_key_list
|
5470
|
-
#
|
5471
|
-
# resource.
|
5477
|
+
# The keys to identify which key-value tags to remove from a resource.
|
5472
5478
|
#
|
5473
5479
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5474
5480
|
#
|
@@ -5488,16 +5494,15 @@ module Aws::Backup
|
|
5488
5494
|
req.send_request(options)
|
5489
5495
|
end
|
5490
5496
|
|
5491
|
-
# Updates
|
5492
|
-
#
|
5493
|
-
# identified by a `VersionId`.
|
5497
|
+
# Updates the specified backup plan. The new version is uniquely
|
5498
|
+
# identified by its ID.
|
5494
5499
|
#
|
5495
5500
|
# @option params [required, String] :backup_plan_id
|
5496
|
-
#
|
5501
|
+
# The ID of the backup plan.
|
5497
5502
|
#
|
5498
5503
|
# @option params [required, Types::BackupPlanInput] :backup_plan
|
5499
|
-
#
|
5500
|
-
#
|
5504
|
+
# The body of a backup plan. Includes a `BackupPlanName` and one or more
|
5505
|
+
# sets of `Rules`.
|
5501
5506
|
#
|
5502
5507
|
# @return [Types::UpdateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5503
5508
|
#
|
@@ -5573,8 +5578,7 @@ module Aws::Backup
|
|
5573
5578
|
req.send_request(options)
|
5574
5579
|
end
|
5575
5580
|
|
5576
|
-
# Updates
|
5577
|
-
# the input document in JSON format.
|
5581
|
+
# Updates the specified framework.
|
5578
5582
|
#
|
5579
5583
|
# @option params [required, String] :framework_name
|
5580
5584
|
# The unique name of a framework. This name is between 1 and 256
|
@@ -5586,8 +5590,8 @@ module Aws::Backup
|
|
5586
5590
|
# characters.
|
5587
5591
|
#
|
5588
5592
|
# @option params [Array<Types::FrameworkControl>] :framework_controls
|
5589
|
-
#
|
5590
|
-
#
|
5593
|
+
# The controls that make up the framework. Each control in the list has
|
5594
|
+
# a name, input parameters, and scope.
|
5591
5595
|
#
|
5592
5596
|
# @option params [String] :idempotency_token
|
5593
5597
|
# A customer-chosen string that you can use to distinguish between
|
@@ -5680,28 +5684,31 @@ module Aws::Backup
|
|
5680
5684
|
# cold storage and when it expires. Backup transitions and expires
|
5681
5685
|
# backups automatically according to the lifecycle that you define.
|
5682
5686
|
#
|
5687
|
+
# Resource types that can transition to cold storage are listed in the
|
5688
|
+
# [Feature availability by resource][1] table. Backup ignores this
|
5689
|
+
# expression for other resource types.
|
5690
|
+
#
|
5683
5691
|
# Backups transitioned to cold storage must be stored in cold storage
|
5684
5692
|
# for a minimum of 90 days. Therefore, the “retention” setting must be
|
5685
5693
|
# 90 days greater than the “transition to cold after days” setting. The
|
5686
5694
|
# “transition to cold after days” setting cannot be changed after a
|
5687
5695
|
# backup has been transitioned to cold.
|
5688
5696
|
#
|
5689
|
-
#
|
5690
|
-
#
|
5691
|
-
#
|
5692
|
-
#
|
5697
|
+
# If your lifecycle currently uses the parameters `DeleteAfterDays` and
|
5698
|
+
# `MoveToColdStorageAfterDays`, include these parameters and their
|
5699
|
+
# values when you call this operation. Not including them may result in
|
5700
|
+
# your plan updating with null values.
|
5693
5701
|
#
|
5694
5702
|
# This operation does not support continuous backups.
|
5695
5703
|
#
|
5696
5704
|
#
|
5697
5705
|
#
|
5698
|
-
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/
|
5706
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
|
5699
5707
|
#
|
5700
5708
|
# @option params [required, String] :backup_vault_name
|
5701
5709
|
# The name of a logical container where backups are stored. Backup
|
5702
5710
|
# vaults are identified by names that are unique to the account used to
|
5703
5711
|
# create them and the Amazon Web Services Region where they are created.
|
5704
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
5705
5712
|
#
|
5706
5713
|
# @option params [required, String] :recovery_point_arn
|
5707
5714
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -5808,8 +5815,7 @@ module Aws::Backup
|
|
5808
5815
|
req.send_request(options)
|
5809
5816
|
end
|
5810
5817
|
|
5811
|
-
# Updates
|
5812
|
-
# with the input document in JSON format.
|
5818
|
+
# Updates the specified report plan.
|
5813
5819
|
#
|
5814
5820
|
# @option params [required, String] :report_plan_name
|
5815
5821
|
# The unique name of the report plan. This name is between 1 and 256
|
@@ -5821,13 +5827,12 @@ module Aws::Backup
|
|
5821
5827
|
# characters.
|
5822
5828
|
#
|
5823
5829
|
# @option params [Types::ReportDeliveryChannel] :report_delivery_channel
|
5824
|
-
#
|
5825
|
-
#
|
5826
|
-
# the formats of your reports.
|
5830
|
+
# The information about where to deliver your reports, specifically your
|
5831
|
+
# Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
|
5827
5832
|
#
|
5828
5833
|
# @option params [Types::ReportSetting] :report_setting
|
5829
|
-
#
|
5830
|
-
#
|
5834
|
+
# The report template for the report. Reports are built using a report
|
5835
|
+
# template. The report templates are:
|
5831
5836
|
#
|
5832
5837
|
# `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
|
5833
5838
|
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
|
@@ -5906,7 +5911,7 @@ module Aws::Backup
|
|
5906
5911
|
# Specifies the body of a restore testing plan.
|
5907
5912
|
#
|
5908
5913
|
# @option params [required, String] :restore_testing_plan_name
|
5909
|
-
#
|
5914
|
+
# The name of the restore testing plan name.
|
5910
5915
|
#
|
5911
5916
|
# @return [Types::UpdateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5912
5917
|
#
|
@@ -5949,13 +5954,13 @@ module Aws::Backup
|
|
5949
5954
|
req.send_request(options)
|
5950
5955
|
end
|
5951
5956
|
|
5957
|
+
# Updates the specified restore testing selection.
|
5958
|
+
#
|
5952
5959
|
# Most elements except the `RestoreTestingSelectionName` can be updated
|
5953
5960
|
# with this request.
|
5954
5961
|
#
|
5955
|
-
#
|
5956
|
-
#
|
5957
|
-
# `ProtectedResourceArns`, requesting an update with the parameter
|
5958
|
-
# `ProtectedResourceConditions` will be unsuccessful.
|
5962
|
+
# You can use either protected resource ARNs or conditions, but not
|
5963
|
+
# both.
|
5959
5964
|
#
|
5960
5965
|
# @option params [required, String] :restore_testing_plan_name
|
5961
5966
|
# The restore testing plan name is required to update the indicated
|
@@ -5968,8 +5973,8 @@ module Aws::Backup
|
|
5968
5973
|
# `ProtectedResourceConditions` will be unsuccessful.
|
5969
5974
|
#
|
5970
5975
|
# @option params [required, String] :restore_testing_selection_name
|
5971
|
-
#
|
5972
|
-
#
|
5976
|
+
# The required restore testing selection name of the restore testing
|
5977
|
+
# selection you wish to update.
|
5973
5978
|
#
|
5974
5979
|
# @return [Types::UpdateRestoreTestingSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5975
5980
|
#
|
@@ -6038,7 +6043,7 @@ module Aws::Backup
|
|
6038
6043
|
params: params,
|
6039
6044
|
config: config)
|
6040
6045
|
context[:gem_name] = 'aws-sdk-backup'
|
6041
|
-
context[:gem_version] = '1.
|
6046
|
+
context[:gem_version] = '1.74.0'
|
6042
6047
|
Seahorse::Client::Request.new(handlers, context)
|
6043
6048
|
end
|
6044
6049
|
|