aws-sdk-backup 1.73.0 → 1.74.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backup/client.rb +257 -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 +1 -0
- data/sig/types.rbs +3 -0
- metadata +2 -2
@@ -425,19 +425,17 @@ module Aws::Backup
|
|
425
425
|
|
426
426
|
# @!group API Operations
|
427
427
|
|
428
|
-
#
|
429
|
-
#
|
428
|
+
# Removes the specified legal hold on a recovery point. This action can
|
429
|
+
# only be performed by a user with sufficient permissions.
|
430
430
|
#
|
431
431
|
# @option params [required, String] :legal_hold_id
|
432
|
-
#
|
433
|
-
# recovery point.
|
432
|
+
# The ID of the legal hold.
|
434
433
|
#
|
435
434
|
# @option params [required, String] :cancel_description
|
436
|
-
#
|
435
|
+
# A string the describes the reason for removing the legal hold.
|
437
436
|
#
|
438
437
|
# @option params [Integer] :retain_record_in_days
|
439
|
-
# The integer amount in days
|
440
|
-
# operation to remove legal hold.
|
438
|
+
# The integer amount, in days, after which to remove legal hold.
|
441
439
|
#
|
442
440
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
443
441
|
#
|
@@ -466,13 +464,11 @@ module Aws::Backup
|
|
466
464
|
# receive an `AlreadyExistsException` exception.
|
467
465
|
#
|
468
466
|
# @option params [required, Types::BackupPlanInput] :backup_plan
|
469
|
-
#
|
470
|
-
#
|
467
|
+
# The body of a backup plan. Includes a `BackupPlanName` and one or more
|
468
|
+
# sets of `Rules`.
|
471
469
|
#
|
472
470
|
# @option params [Hash<String,String>] :backup_plan_tags
|
473
|
-
#
|
474
|
-
# the resources that you create. Each tag is a key-value pair. The
|
475
|
-
# specified tags are assigned to all backups created with this plan.
|
471
|
+
# The tags to assign to the backup plan.
|
476
472
|
#
|
477
473
|
# @option params [String] :creator_request_id
|
478
474
|
# Identifies the request and allows failed requests to be retried
|
@@ -569,12 +565,10 @@ module Aws::Backup
|
|
569
565
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json
|
570
566
|
#
|
571
567
|
# @option params [required, String] :backup_plan_id
|
572
|
-
#
|
573
|
-
# selection of resources.
|
568
|
+
# The ID of the backup plan.
|
574
569
|
#
|
575
570
|
# @option params [required, Types::BackupSelection] :backup_selection
|
576
|
-
#
|
577
|
-
# backup plan.
|
571
|
+
# The body of a request to assign a set of resources to a backup plan.
|
578
572
|
#
|
579
573
|
# @option params [String] :creator_request_id
|
580
574
|
# A unique string that identifies the request and allows failed requests
|
@@ -667,8 +661,7 @@ module Aws::Backup
|
|
667
661
|
# They consist of letters, numbers, and hyphens.
|
668
662
|
#
|
669
663
|
# @option params [Hash<String,String>] :backup_vault_tags
|
670
|
-
#
|
671
|
-
# create. Each tag is a key-value pair.
|
664
|
+
# The tags to assign to the backup vault.
|
672
665
|
#
|
673
666
|
# @option params [String] :encryption_key_arn
|
674
667
|
# The server-side encryption key that is used to protect your backups;
|
@@ -731,8 +724,8 @@ module Aws::Backup
|
|
731
724
|
# characters.
|
732
725
|
#
|
733
726
|
# @option params [required, Array<Types::FrameworkControl>] :framework_controls
|
734
|
-
#
|
735
|
-
#
|
727
|
+
# The controls that make up the framework. Each control in the list has
|
728
|
+
# a name, input parameters, and scope.
|
736
729
|
#
|
737
730
|
# @option params [String] :idempotency_token
|
738
731
|
# A customer-chosen string that you can use to distinguish between
|
@@ -744,8 +737,7 @@ module Aws::Backup
|
|
744
737
|
# not need to pass this option.**
|
745
738
|
#
|
746
739
|
# @option params [Hash<String,String>] :framework_tags
|
747
|
-
#
|
748
|
-
# create. Each tag is a key-value pair.
|
740
|
+
# The tags to assign to the framework.
|
749
741
|
#
|
750
742
|
# @return [Types::CreateFrameworkOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
751
743
|
#
|
@@ -795,17 +787,17 @@ module Aws::Backup
|
|
795
787
|
req.send_request(options)
|
796
788
|
end
|
797
789
|
|
798
|
-
#
|
799
|
-
#
|
800
|
-
#
|
801
|
-
#
|
802
|
-
#
|
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.
|
803
795
|
#
|
804
796
|
# @option params [required, String] :title
|
805
|
-
#
|
797
|
+
# The title of the legal hold.
|
806
798
|
#
|
807
799
|
# @option params [required, String] :description
|
808
|
-
#
|
800
|
+
# The description of the legal hold.
|
809
801
|
#
|
810
802
|
# @option params [String] :idempotency_token
|
811
803
|
# This is a user-chosen string used to distinguish between otherwise
|
@@ -813,8 +805,8 @@ module Aws::Backup
|
|
813
805
|
# idempotency token results in a success message with no action taken.
|
814
806
|
#
|
815
807
|
# @option params [Types::RecoveryPointSelection] :recovery_point_selection
|
816
|
-
#
|
817
|
-
#
|
808
|
+
# The criteria to assign a set of resources, such as resource types or
|
809
|
+
# backup vaults.
|
818
810
|
#
|
819
811
|
# @option params [Hash<String,String>] :tags
|
820
812
|
# Optional tags to include. A tag is a key-value pair you can use to
|
@@ -875,8 +867,7 @@ module Aws::Backup
|
|
875
867
|
req.send_request(options)
|
876
868
|
end
|
877
869
|
|
878
|
-
#
|
879
|
-
# copied.
|
870
|
+
# Creates a logical container to where backups may be copied.
|
880
871
|
#
|
881
872
|
# This request includes a name, the Region, the maximum number of
|
882
873
|
# retention days, the minimum number of retention days, and optionally
|
@@ -888,41 +879,28 @@ module Aws::Backup
|
|
888
879
|
# </note>
|
889
880
|
#
|
890
881
|
# @option params [required, String] :backup_vault_name
|
891
|
-
#
|
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.
|
892
885
|
#
|
893
886
|
# @option params [Hash<String,String>] :backup_vault_tags
|
894
|
-
#
|
887
|
+
# The tags to assign to the vault.
|
895
888
|
#
|
896
889
|
# @option params [String] :creator_request_id
|
897
|
-
#
|
890
|
+
# The ID of the creation request.
|
898
891
|
#
|
899
892
|
# This parameter is optional. If used, this parameter must contain 1 to
|
900
893
|
# 50 alphanumeric or '-\_.' characters.
|
901
894
|
#
|
902
895
|
# @option params [required, Integer] :min_retention_days
|
903
896
|
# This setting specifies the minimum retention period that the vault
|
904
|
-
# retains its recovery points.
|
905
|
-
# minimum retention period is enforced.
|
897
|
+
# retains its recovery points.
|
906
898
|
#
|
907
|
-
#
|
908
|
-
# lifecycle policy with a retention period equal to or longer than the
|
909
|
-
# minimum retention period. If a job retention period is shorter than
|
910
|
-
# that minimum retention period, then the vault fails the backup or copy
|
911
|
-
# job, and you should either modify your lifecycle settings or use a
|
912
|
-
# different vault.
|
899
|
+
# The minimum value accepted is 7 days.
|
913
900
|
#
|
914
901
|
# @option params [required, Integer] :max_retention_days
|
915
|
-
#
|
916
|
-
#
|
917
|
-
# specified, Backup does not enforce a maximum retention period on the
|
918
|
-
# recovery points in the vault (allowing indefinite storage).
|
919
|
-
#
|
920
|
-
# If specified, any backup or copy job to the vault must have a
|
921
|
-
# lifecycle policy with a retention period equal to or shorter than the
|
922
|
-
# maximum retention period. If the job retention period is longer than
|
923
|
-
# that maximum retention period, then the vault fails the backup or copy
|
924
|
-
# job, and you should either modify your lifecycle settings or use a
|
925
|
-
# different vault.
|
902
|
+
# The maximum retention period that the vault retains its recovery
|
903
|
+
# points.
|
926
904
|
#
|
927
905
|
# @return [Types::CreateLogicallyAirGappedBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
928
906
|
#
|
@@ -992,8 +970,7 @@ module Aws::Backup
|
|
992
970
|
# report coverage by Amazon Web Services Regions and frameworks.
|
993
971
|
#
|
994
972
|
# @option params [Hash<String,String>] :report_plan_tags
|
995
|
-
#
|
996
|
-
# you create. Each tag is a key-value pair.
|
973
|
+
# The tags to assign to the report plan.
|
997
974
|
#
|
998
975
|
# @option params [String] :idempotency_token
|
999
976
|
# A customer-chosen string that you can use to distinguish between
|
@@ -1049,12 +1026,11 @@ module Aws::Backup
|
|
1049
1026
|
req.send_request(options)
|
1050
1027
|
end
|
1051
1028
|
|
1052
|
-
#
|
1053
|
-
# this request is successful, finish the procedure with request
|
1054
|
-
# CreateRestoreTestingSelection.
|
1029
|
+
# Creates a restore testing plan.
|
1055
1030
|
#
|
1056
|
-
#
|
1057
|
-
#
|
1031
|
+
# The first of two steps to create a restore testing plan. After this
|
1032
|
+
# request is successful, finish the procedure using
|
1033
|
+
# CreateRestoreTestingSelection.
|
1058
1034
|
#
|
1059
1035
|
# @option params [String] :creator_request_id
|
1060
1036
|
# This is a unique string that identifies the request and allows failed
|
@@ -1073,10 +1049,7 @@ module Aws::Backup
|
|
1073
1049
|
# it must consist of only alphanumeric characters and underscores.
|
1074
1050
|
#
|
1075
1051
|
# @option params [Hash<String,String>] :tags
|
1076
|
-
#
|
1077
|
-
# manage, filter, and search for your resources. Allowed characters
|
1078
|
-
# include UTF-8 letters,numbers, spaces, and the following characters: +
|
1079
|
-
# - = . \_ : /.
|
1052
|
+
# The tags to assign to the restore testing plan.
|
1080
1053
|
#
|
1081
1054
|
# @return [Types::CreateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1082
1055
|
#
|
@@ -1293,7 +1266,6 @@ module Aws::Backup
|
|
1293
1266
|
# The name of a logical container where backups are stored. Backup
|
1294
1267
|
# vaults are identified by names that are unique to the account used to
|
1295
1268
|
# create them and the Amazon Web Services Region where they are created.
|
1296
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1297
1269
|
#
|
1298
1270
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1299
1271
|
#
|
@@ -1375,8 +1347,7 @@ module Aws::Backup
|
|
1375
1347
|
# @option params [required, String] :backup_vault_name
|
1376
1348
|
# The name of a logical container where backups are stored. Backup
|
1377
1349
|
# vaults are identified by names that are unique to the account used to
|
1378
|
-
# create them and the Region where they are created.
|
1379
|
-
# lowercase letters, numbers, and hyphens.
|
1350
|
+
# create them and the Region where they are created.
|
1380
1351
|
#
|
1381
1352
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
1382
1353
|
#
|
@@ -1444,7 +1415,6 @@ module Aws::Backup
|
|
1444
1415
|
# The name of a logical container where backups are stored. Backup
|
1445
1416
|
# vaults are identified by names that are unique to the account used to
|
1446
1417
|
# create them and the Amazon Web Services Region where they are created.
|
1447
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1448
1418
|
#
|
1449
1419
|
# @option params [required, String] :recovery_point_arn
|
1450
1420
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -1639,16 +1609,16 @@ module Aws::Backup
|
|
1639
1609
|
# The name of a logical container where backups are stored. Backup
|
1640
1610
|
# vaults are identified by names that are unique to the account used to
|
1641
1611
|
# create them and the Amazon Web Services Region where they are created.
|
1642
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1643
1612
|
#
|
1644
1613
|
# @option params [String] :backup_vault_account_id
|
1645
|
-
#
|
1614
|
+
# The account ID of the specified backup vault.
|
1646
1615
|
#
|
1647
1616
|
# @return [Types::DescribeBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1648
1617
|
#
|
1649
1618
|
# * {Types::DescribeBackupVaultOutput#backup_vault_name #backup_vault_name} => String
|
1650
1619
|
# * {Types::DescribeBackupVaultOutput#backup_vault_arn #backup_vault_arn} => String
|
1651
1620
|
# * {Types::DescribeBackupVaultOutput#vault_type #vault_type} => String
|
1621
|
+
# * {Types::DescribeBackupVaultOutput#vault_state #vault_state} => String
|
1652
1622
|
# * {Types::DescribeBackupVaultOutput#encryption_key_arn #encryption_key_arn} => String
|
1653
1623
|
# * {Types::DescribeBackupVaultOutput#creation_date #creation_date} => Time
|
1654
1624
|
# * {Types::DescribeBackupVaultOutput#creator_request_id #creator_request_id} => String
|
@@ -1670,6 +1640,7 @@ module Aws::Backup
|
|
1670
1640
|
# resp.backup_vault_name #=> String
|
1671
1641
|
# resp.backup_vault_arn #=> String
|
1672
1642
|
# resp.vault_type #=> String, one of "BACKUP_VAULT", "LOGICALLY_AIR_GAPPED_BACKUP_VAULT"
|
1643
|
+
# resp.vault_state #=> String, one of "CREATING", "AVAILABLE", "FAILED"
|
1673
1644
|
# resp.encryption_key_arn #=> String
|
1674
1645
|
# resp.creation_date #=> Time
|
1675
1646
|
# resp.creator_request_id #=> String
|
@@ -1872,7 +1843,6 @@ module Aws::Backup
|
|
1872
1843
|
# The name of a logical container where backups are stored. Backup
|
1873
1844
|
# vaults are identified by names that are unique to the account used to
|
1874
1845
|
# create them and the Amazon Web Services Region where they are created.
|
1875
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
1876
1846
|
#
|
1877
1847
|
# @option params [required, String] :recovery_point_arn
|
1878
1848
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -1880,7 +1850,7 @@ module Aws::Backup
|
|
1880
1850
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
1881
1851
|
#
|
1882
1852
|
# @option params [String] :backup_vault_account_id
|
1883
|
-
#
|
1853
|
+
# The account ID of the specified backup vault.
|
1884
1854
|
#
|
1885
1855
|
# @return [Types::DescribeRecoveryPointOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1886
1856
|
#
|
@@ -2178,15 +2148,14 @@ module Aws::Backup
|
|
2178
2148
|
# (composite) recovery point.
|
2179
2149
|
#
|
2180
2150
|
# @option params [required, String] :backup_vault_name
|
2181
|
-
#
|
2182
|
-
#
|
2183
|
-
#
|
2184
|
-
#
|
2185
|
-
# 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.
|
2186
2155
|
#
|
2187
2156
|
# @option params [required, String] :recovery_point_arn
|
2188
|
-
#
|
2189
|
-
#
|
2157
|
+
# The Amazon Resource Name (ARN) that uniquely identifies the child
|
2158
|
+
# (nested) recovery point; for example,
|
2190
2159
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
|
2191
2160
|
#
|
2192
2161
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -2485,7 +2454,6 @@ module Aws::Backup
|
|
2485
2454
|
# The name of a logical container where backups are stored. Backup
|
2486
2455
|
# vaults are identified by names that are unique to the account used to
|
2487
2456
|
# create them and the Amazon Web Services Region where they are created.
|
2488
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
2489
2457
|
#
|
2490
2458
|
# @return [Types::GetBackupVaultAccessPolicyOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2491
2459
|
#
|
@@ -2520,7 +2488,6 @@ module Aws::Backup
|
|
2520
2488
|
# The name of a logical container where backups are stored. Backup
|
2521
2489
|
# vaults are identified by names that are unique to the account used to
|
2522
2490
|
# create them and the Amazon Web Services Region where they are created.
|
2523
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
2524
2491
|
#
|
2525
2492
|
# @return [Types::GetBackupVaultNotificationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2526
2493
|
#
|
@@ -2556,8 +2523,7 @@ module Aws::Backup
|
|
2556
2523
|
# are the body of a legal hold in JSON format, in addition to metadata.
|
2557
2524
|
#
|
2558
2525
|
# @option params [required, String] :legal_hold_id
|
2559
|
-
#
|
2560
|
-
# associated with a specific legal hold.
|
2526
|
+
# The ID of the legal hold.
|
2561
2527
|
#
|
2562
2528
|
# @return [Types::GetLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2563
2529
|
#
|
@@ -2612,7 +2578,6 @@ module Aws::Backup
|
|
2612
2578
|
# The name of a logical container where backups are stored. Backup
|
2613
2579
|
# vaults are identified by names that are unique to the account used to
|
2614
2580
|
# create them and the Amazon Web Services Region where they are created.
|
2615
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
2616
2581
|
#
|
2617
2582
|
# @option params [required, String] :recovery_point_arn
|
2618
2583
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -2620,7 +2585,7 @@ module Aws::Backup
|
|
2620
2585
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
2621
2586
|
#
|
2622
2587
|
# @option params [String] :backup_vault_account_id
|
2623
|
-
#
|
2588
|
+
# The account ID of the specified backup vault.
|
2624
2589
|
#
|
2625
2590
|
# @return [Types::GetRecoveryPointRestoreMetadataOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2626
2591
|
#
|
@@ -2691,7 +2656,7 @@ module Aws::Backup
|
|
2691
2656
|
# is an optional parameter.
|
2692
2657
|
#
|
2693
2658
|
# @option params [String] :backup_vault_account_id
|
2694
|
-
#
|
2659
|
+
# The account ID of the specified backup vault.
|
2695
2660
|
#
|
2696
2661
|
# @option params [required, String] :backup_vault_name
|
2697
2662
|
# The name of a logical container where backups are stored. Backup
|
@@ -2921,18 +2886,16 @@ module Aws::Backup
|
|
2921
2886
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
2922
2887
|
#
|
2923
2888
|
# @option params [String] :aggregation_period
|
2924
|
-
#
|
2925
|
-
#
|
2926
|
-
# Acceptable values include
|
2889
|
+
# The period for the returned results.
|
2927
2890
|
#
|
2928
|
-
# * `ONE_DAY`
|
2891
|
+
# * `ONE_DAY` - The daily job count for the prior 14 days.
|
2929
2892
|
#
|
2930
|
-
# * `SEVEN_DAYS`
|
2893
|
+
# * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
|
2931
2894
|
#
|
2932
|
-
# * `FOURTEEN_DAYS`
|
2895
|
+
# * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
|
2933
2896
|
#
|
2934
2897
|
# @option params [Integer] :max_results
|
2935
|
-
#
|
2898
|
+
# The maximum number of items to be returned.
|
2936
2899
|
#
|
2937
2900
|
# The value is an integer. Range of accepted values is from 1 to 500.
|
2938
2901
|
#
|
@@ -3025,8 +2988,7 @@ module Aws::Backup
|
|
3025
2988
|
# Returns only backup jobs that will be stored in the specified backup
|
3026
2989
|
# vault. Backup vaults are identified by names that are unique to the
|
3027
2990
|
# account used to create them and the Amazon Web Services Region where
|
3028
|
-
# they are created.
|
3029
|
-
# hyphens.
|
2991
|
+
# they are created.
|
3030
2992
|
#
|
3031
2993
|
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
3032
2994
|
# Returns only backup jobs that were created before the specified date.
|
@@ -3055,19 +3017,20 @@ module Aws::Backup
|
|
3055
3017
|
#
|
3056
3018
|
# * `Neptune` for Amazon Neptune
|
3057
3019
|
#
|
3020
|
+
# * `RDS` for Amazon Relational Database Service
|
3021
|
+
#
|
3058
3022
|
# * `Redshift` for Amazon Redshift
|
3059
3023
|
#
|
3060
|
-
# * `
|
3024
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
3061
3025
|
#
|
3062
|
-
# * `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
|
3063
3028
|
#
|
3064
3029
|
# * `Storage Gateway` for Storage Gateway
|
3065
3030
|
#
|
3066
|
-
# * `S3` for Amazon S3
|
3067
|
-
#
|
3068
3031
|
# * `Timestream` for Amazon Timestream
|
3069
3032
|
#
|
3070
|
-
# * `VirtualMachine` for virtual machines
|
3033
|
+
# * `VirtualMachine` for VMware virtual machines
|
3071
3034
|
#
|
3072
3035
|
# @option params [String] :by_account_id
|
3073
3036
|
# The account ID to list the jobs from. Returns only backup jobs
|
@@ -3173,8 +3136,7 @@ module Aws::Backup
|
|
3173
3136
|
req.send_request(options)
|
3174
3137
|
end
|
3175
3138
|
|
3176
|
-
#
|
3177
|
-
# template ID, name, and the creation and deletion dates.
|
3139
|
+
# Lists the backup plan templates.
|
3178
3140
|
#
|
3179
3141
|
# @option params [String] :next_token
|
3180
3142
|
# The next item following a partial list of returned items. For example,
|
@@ -3183,7 +3145,7 @@ module Aws::Backup
|
|
3183
3145
|
# the location pointed to by the next token.
|
3184
3146
|
#
|
3185
3147
|
# @option params [Integer] :max_results
|
3186
|
-
# The maximum number of items to
|
3148
|
+
# The maximum number of items to return.
|
3187
3149
|
#
|
3188
3150
|
# @return [Types::ListBackupPlanTemplatesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3189
3151
|
#
|
@@ -3272,10 +3234,7 @@ module Aws::Backup
|
|
3272
3234
|
req.send_request(options)
|
3273
3235
|
end
|
3274
3236
|
|
3275
|
-
#
|
3276
|
-
# account. The list contains information such as Amazon Resource Names
|
3277
|
-
# (ARNs), plan IDs, creation and deletion dates, version IDs, plan
|
3278
|
-
# names, and creator request IDs.
|
3237
|
+
# Lists the active backup plans for the account.
|
3279
3238
|
#
|
3280
3239
|
# @option params [String] :next_token
|
3281
3240
|
# The next item following a partial list of returned items. For example,
|
@@ -3420,6 +3379,8 @@ module Aws::Backup
|
|
3420
3379
|
# resp.backup_vault_list #=> Array
|
3421
3380
|
# resp.backup_vault_list[0].backup_vault_name #=> String
|
3422
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"
|
3423
3384
|
# resp.backup_vault_list[0].creation_date #=> Time
|
3424
3385
|
# resp.backup_vault_list[0].encryption_key_arn #=> String
|
3425
3386
|
# resp.backup_vault_list[0].creator_request_id #=> String
|
@@ -3502,13 +3463,13 @@ module Aws::Backup
|
|
3502
3463
|
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html
|
3503
3464
|
#
|
3504
3465
|
# @option params [String] :aggregation_period
|
3505
|
-
#
|
3466
|
+
# The period for the returned results.
|
3506
3467
|
#
|
3507
|
-
# * `ONE_DAY`
|
3468
|
+
# * `ONE_DAY` - The daily job count for the prior 14 days.
|
3508
3469
|
#
|
3509
|
-
# * `SEVEN_DAYS`
|
3470
|
+
# * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
|
3510
3471
|
#
|
3511
|
-
# * `FOURTEEN_DAYS`
|
3472
|
+
# * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
|
3512
3473
|
#
|
3513
3474
|
# @option params [Integer] :max_results
|
3514
3475
|
# This parameter sets the maximum number of items to be returned.
|
@@ -3609,24 +3570,25 @@ module Aws::Backup
|
|
3609
3570
|
#
|
3610
3571
|
# * `Neptune` for Amazon Neptune
|
3611
3572
|
#
|
3573
|
+
# * `RDS` for Amazon Relational Database Service
|
3574
|
+
#
|
3612
3575
|
# * `Redshift` for Amazon Redshift
|
3613
3576
|
#
|
3614
|
-
# * `
|
3577
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
3615
3578
|
#
|
3616
|
-
# * `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
|
3617
3581
|
#
|
3618
3582
|
# * `Storage Gateway` for Storage Gateway
|
3619
3583
|
#
|
3620
|
-
# * `S3` for Amazon S3
|
3621
|
-
#
|
3622
3584
|
# * `Timestream` for Amazon Timestream
|
3623
3585
|
#
|
3624
|
-
# * `VirtualMachine` for virtual machines
|
3586
|
+
# * `VirtualMachine` for VMware virtual machines
|
3625
3587
|
#
|
3626
3588
|
# @option params [String] :by_destination_vault_arn
|
3627
3589
|
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
3628
3590
|
# vault to copy from; for example,
|
3629
|
-
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
3591
|
+
# `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
|
3630
3592
|
#
|
3631
3593
|
# @option params [String] :by_account_id
|
3632
3594
|
# The account ID to list the jobs from. Returns only copy jobs
|
@@ -3869,12 +3831,12 @@ module Aws::Backup
|
|
3869
3831
|
# backup vault.
|
3870
3832
|
#
|
3871
3833
|
# @option params [required, String] :backup_vault_name
|
3872
|
-
#
|
3873
|
-
#
|
3834
|
+
# The list of protected resources by backup vault within the vault(s)
|
3835
|
+
# you specify by name.
|
3874
3836
|
#
|
3875
3837
|
# @option params [String] :backup_vault_account_id
|
3876
|
-
#
|
3877
|
-
#
|
3838
|
+
# The list of protected resources by backup vault within the vault(s)
|
3839
|
+
# you specify by account ID.
|
3878
3840
|
#
|
3879
3841
|
# @option params [String] :next_token
|
3880
3842
|
# The next item following a partial list of returned items. For example,
|
@@ -3928,7 +3890,6 @@ module Aws::Backup
|
|
3928
3890
|
# The name of a logical container where backups are stored. Backup
|
3929
3891
|
# vaults are identified by names that are unique to the account used to
|
3930
3892
|
# create them and the Amazon Web Services Region where they are created.
|
3931
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
3932
3893
|
#
|
3933
3894
|
# <note markdown="1"> Backup vault name might not be available when a supported service
|
3934
3895
|
# creates the backup.
|
@@ -3973,19 +3934,20 @@ module Aws::Backup
|
|
3973
3934
|
#
|
3974
3935
|
# * `Neptune` for Amazon Neptune
|
3975
3936
|
#
|
3937
|
+
# * `RDS` for Amazon Relational Database Service
|
3938
|
+
#
|
3976
3939
|
# * `Redshift` for Amazon Redshift
|
3977
3940
|
#
|
3978
|
-
# * `
|
3941
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
3979
3942
|
#
|
3980
|
-
# * `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
|
3981
3945
|
#
|
3982
3946
|
# * `Storage Gateway` for Storage Gateway
|
3983
3947
|
#
|
3984
|
-
# * `S3` for Amazon S3
|
3985
|
-
#
|
3986
3948
|
# * `Timestream` for Amazon Timestream
|
3987
3949
|
#
|
3988
|
-
# * `VirtualMachine` for virtual machines
|
3950
|
+
# * `VirtualMachine` for VMware virtual machines
|
3989
3951
|
#
|
3990
3952
|
# @option params [String] :by_backup_plan_id
|
3991
3953
|
# Returns only recovery points that match the specified backup plan ID.
|
@@ -4071,16 +4033,16 @@ module Aws::Backup
|
|
4071
4033
|
# specified legal hold.
|
4072
4034
|
#
|
4073
4035
|
# @option params [required, String] :legal_hold_id
|
4074
|
-
#
|
4036
|
+
# The ID of the legal hold.
|
4075
4037
|
#
|
4076
4038
|
# @option params [String] :next_token
|
4077
|
-
#
|
4078
|
-
#
|
4039
|
+
# The next item following a partial list of returned resources. For
|
4040
|
+
# example, if a request is made to return `MaxResults` number of
|
4079
4041
|
# resources, `NextToken` allows you to return more items in your list
|
4080
4042
|
# starting at the location pointed to by the next token.
|
4081
4043
|
#
|
4082
4044
|
# @option params [Integer] :max_results
|
4083
|
-
#
|
4045
|
+
# The maximum number of resource list items to be returned.
|
4084
4046
|
#
|
4085
4047
|
# @return [Types::ListRecoveryPointsByLegalHoldOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4086
4048
|
#
|
@@ -4115,8 +4077,8 @@ module Aws::Backup
|
|
4115
4077
|
req.send_request(options)
|
4116
4078
|
end
|
4117
4079
|
|
4118
|
-
#
|
4119
|
-
#
|
4080
|
+
# The information about the recovery points of the type specified by a
|
4081
|
+
# resource Amazon Resource Name (ARN).
|
4120
4082
|
#
|
4121
4083
|
# <note markdown="1"> For Amazon EFS and Amazon EC2, this action only lists recovery points
|
4122
4084
|
# created by Backup.
|
@@ -4373,15 +4335,13 @@ module Aws::Backup
|
|
4373
4335
|
# Relational Database Service (Amazon RDS) database.
|
4374
4336
|
#
|
4375
4337
|
# @option params [String] :aggregation_period
|
4376
|
-
#
|
4377
|
-
#
|
4378
|
-
# Acceptable values include
|
4338
|
+
# The period for the returned results.
|
4379
4339
|
#
|
4380
|
-
# * `ONE_DAY`
|
4340
|
+
# * `ONE_DAY` - The daily job count for the prior 14 days.
|
4381
4341
|
#
|
4382
|
-
# * `SEVEN_DAYS`
|
4342
|
+
# * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
|
4383
4343
|
#
|
4384
|
-
# * `FOURTEEN_DAYS`
|
4344
|
+
# * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
|
4385
4345
|
#
|
4386
4346
|
# @option params [Integer] :max_results
|
4387
4347
|
# This parameter sets the maximum number of items to be returned.
|
@@ -4473,19 +4433,20 @@ module Aws::Backup
|
|
4473
4433
|
#
|
4474
4434
|
# * `Neptune` for Amazon Neptune
|
4475
4435
|
#
|
4436
|
+
# * `RDS` for Amazon Relational Database Service
|
4437
|
+
#
|
4476
4438
|
# * `Redshift` for Amazon Redshift
|
4477
4439
|
#
|
4478
|
-
# * `
|
4440
|
+
# * `S3` for Amazon Simple Storage Service (Amazon S3)
|
4479
4441
|
#
|
4480
|
-
# * `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
|
4481
4444
|
#
|
4482
4445
|
# * `Storage Gateway` for Storage Gateway
|
4483
4446
|
#
|
4484
|
-
# * `S3` for Amazon S3
|
4485
|
-
#
|
4486
4447
|
# * `Timestream` for Amazon Timestream
|
4487
4448
|
#
|
4488
|
-
# * `VirtualMachine` for virtual machines
|
4449
|
+
# * `VirtualMachine` for VMware virtual machines
|
4489
4450
|
#
|
4490
4451
|
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
4491
4452
|
# Returns only restore jobs that were created before the specified date.
|
@@ -4744,17 +4705,8 @@ module Aws::Backup
|
|
4744
4705
|
req.send_request(options)
|
4745
4706
|
end
|
4746
4707
|
|
4747
|
-
# Returns
|
4748
|
-
# backup plan, or backup vault.
|
4749
|
-
#
|
4750
|
-
# `ListTags` only works for resource types that support full Backup
|
4751
|
-
# management of their backups. Those resource types are listed in the
|
4752
|
-
# "Full Backup management" section of the [ Feature availability by
|
4753
|
-
# resource][1] table.
|
4754
|
-
#
|
4755
|
-
#
|
4756
|
-
#
|
4757
|
-
# [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.
|
4758
4710
|
#
|
4759
4711
|
# @option params [required, String] :resource_arn
|
4760
4712
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
@@ -4808,7 +4760,6 @@ module Aws::Backup
|
|
4808
4760
|
# The name of a logical container where backups are stored. Backup
|
4809
4761
|
# vaults are identified by names that are unique to the account used to
|
4810
4762
|
# create them and the Amazon Web Services Region where they are created.
|
4811
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
4812
4763
|
#
|
4813
4764
|
# @option params [String] :policy
|
4814
4765
|
# The backup vault access policy document in JSON format.
|
@@ -4843,10 +4794,17 @@ module Aws::Backup
|
|
4843
4794
|
# environments that are subject to SEC 17a-4, CFTC, and FINRA
|
4844
4795
|
# regulations. For more information about how Backup Vault Lock relates
|
4845
4796
|
# to these regulations, see the [Cohasset Associates Compliance
|
4846
|
-
# Assessment.]
|
4797
|
+
# Assessment.][1]
|
4847
4798
|
#
|
4848
4799
|
# </note>
|
4849
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
|
+
#
|
4850
4808
|
# @option params [required, String] :backup_vault_name
|
4851
4809
|
# The Backup Vault Lock configuration that specifies the name of the
|
4852
4810
|
# backup vault it protects.
|
@@ -4858,8 +4816,10 @@ module Aws::Backup
|
|
4858
4816
|
# require you to retain certain data for at least seven years (2555
|
4859
4817
|
# days).
|
4860
4818
|
#
|
4861
|
-
#
|
4862
|
-
#
|
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.
|
4863
4823
|
#
|
4864
4824
|
# If this parameter is specified, any backup or copy job to the vault
|
4865
4825
|
# must have a lifecycle policy with a retention period equal to or
|
@@ -4940,7 +4900,6 @@ module Aws::Backup
|
|
4940
4900
|
# The name of a logical container where backups are stored. Backup
|
4941
4901
|
# vaults are identified by names that are unique to the account used to
|
4942
4902
|
# create them and the Amazon Web Services Region where they are created.
|
4943
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
4944
4903
|
#
|
4945
4904
|
# @option params [required, String] :sns_topic_arn
|
4946
4905
|
# The Amazon Resource Name (ARN) that specifies the topic for a backup
|
@@ -4965,9 +4924,9 @@ module Aws::Backup
|
|
4965
4924
|
#
|
4966
4925
|
# * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
|
4967
4926
|
#
|
4968
|
-
# <note markdown="1"> The list below
|
4969
|
-
#
|
4970
|
-
# 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
|
4971
4930
|
# supported events.
|
4972
4931
|
#
|
4973
4932
|
# </note>
|
@@ -5003,7 +4962,7 @@ module Aws::Backup
|
|
5003
4962
|
# This is a unique identifier of a restore job within Backup.
|
5004
4963
|
#
|
5005
4964
|
# @option params [required, String] :validation_status
|
5006
|
-
#
|
4965
|
+
# The status of your restore validation.
|
5007
4966
|
#
|
5008
4967
|
# @option params [String] :validation_status_message
|
5009
4968
|
# This is an optional message string you can input to describe the
|
@@ -5034,7 +4993,6 @@ module Aws::Backup
|
|
5034
4993
|
# The name of a logical container where backups are stored. Backup
|
5035
4994
|
# vaults are identified by names that are unique to the account used to
|
5036
4995
|
# create them and the Amazon Web Services Region where they are created.
|
5037
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
5038
4996
|
#
|
5039
4997
|
# @option params [required, String] :resource_arn
|
5040
4998
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
@@ -5088,25 +5046,22 @@ module Aws::Backup
|
|
5088
5046
|
# “transition to cold after days” setting cannot be changed after a
|
5089
5047
|
# backup has been transitioned to cold.
|
5090
5048
|
#
|
5091
|
-
# Resource types that
|
5092
|
-
#
|
5093
|
-
#
|
5094
|
-
# 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.
|
5095
5052
|
#
|
5096
5053
|
# This parameter has a maximum value of 100 years (36,500 days).
|
5097
5054
|
#
|
5098
5055
|
#
|
5099
5056
|
#
|
5100
|
-
# [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
|
5101
5058
|
#
|
5102
5059
|
# @option params [Hash<String,String>] :recovery_point_tags
|
5103
|
-
#
|
5104
|
-
# the resources that you create. Each tag is a key-value pair.
|
5060
|
+
# The tags to assign to the resources.
|
5105
5061
|
#
|
5106
5062
|
# @option params [Hash<String,String>] :backup_options
|
5107
|
-
#
|
5108
|
-
#
|
5109
|
-
# jobs.
|
5063
|
+
# The backup option for a selected resource. This option is only
|
5064
|
+
# available for Windows Volume Shadow Copy Service (VSS) backup jobs.
|
5110
5065
|
#
|
5111
5066
|
# Valid values: Set to `"WindowsVSS":"enabled"` to enable the
|
5112
5067
|
# `WindowsVSS` backup option and create a Windows VSS backup. Set to
|
@@ -5171,12 +5126,12 @@ module Aws::Backup
|
|
5171
5126
|
# The name of a logical source container where backups are stored.
|
5172
5127
|
# Backup vaults are identified by names that are unique to the account
|
5173
5128
|
# used to create them and the Amazon Web Services Region where they are
|
5174
|
-
# created.
|
5129
|
+
# created.
|
5175
5130
|
#
|
5176
5131
|
# @option params [required, String] :destination_backup_vault_arn
|
5177
5132
|
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
5178
5133
|
# backup vault to copy to; for example,
|
5179
|
-
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
5134
|
+
# `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
|
5180
5135
|
#
|
5181
5136
|
# @option params [required, String] :iam_role_arn
|
5182
5137
|
# Specifies the IAM role ARN used to copy the target recovery point; for
|
@@ -5189,23 +5144,26 @@ module Aws::Backup
|
|
5189
5144
|
# with no action taken.
|
5190
5145
|
#
|
5191
5146
|
# @option params [Types::Lifecycle] :lifecycle
|
5192
|
-
#
|
5193
|
-
#
|
5147
|
+
# Specifies the time period, in days, before a recovery point
|
5148
|
+
# transitions to cold storage or is deleted.
|
5194
5149
|
#
|
5195
5150
|
# Backups transitioned to cold storage must be stored in cold storage
|
5196
|
-
# for a minimum of 90 days. Therefore, on the console, the
|
5197
|
-
# setting must be 90 days greater than the
|
5198
|
-
#
|
5199
|
-
#
|
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.
|
5200
5159
|
#
|
5201
|
-
#
|
5202
|
-
#
|
5203
|
-
#
|
5204
|
-
# 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`.
|
5205
5163
|
#
|
5206
5164
|
#
|
5207
5165
|
#
|
5208
|
-
# [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
|
5209
5167
|
#
|
5210
5168
|
# @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5211
5169
|
#
|
@@ -5289,8 +5247,7 @@ module Aws::Backup
|
|
5289
5247
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
5290
5248
|
#
|
5291
5249
|
# @option params [required, Hash<String,String>] :metadata
|
5292
|
-
# A set of metadata key-value pairs.
|
5293
|
-
# resource name, required to restore a recovery point.
|
5250
|
+
# A set of metadata key-value pairs.
|
5294
5251
|
#
|
5295
5252
|
# You can get configuration metadata about a resource at the time it was
|
5296
5253
|
# backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
@@ -5299,33 +5256,56 @@ module Aws::Backup
|
|
5299
5256
|
# resource. For example, you might need to provide a new resource name
|
5300
5257
|
# if the original already exists.
|
5301
5258
|
#
|
5302
|
-
#
|
5303
|
-
#
|
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]
|
5265
|
+
#
|
5266
|
+
# * [Metadata for CloudFormation][3]
|
5304
5267
|
#
|
5305
|
-
# *
|
5306
|
-
# backed up by Backup. Returned in `GetRecoveryPointRestoreMetadata`.
|
5268
|
+
# * [Metadata for Amazon DynamoDB][4]
|
5307
5269
|
#
|
5308
|
-
# *
|
5309
|
-
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
5310
|
-
# set to `true`.
|
5270
|
+
# * [ Metadata for Amazon EBS][5]
|
5311
5271
|
#
|
5312
|
-
# *
|
5313
|
-
# to encrypt the restored file system. You can specify a key from
|
5314
|
-
# another Amazon Web Services account provided that key it is properly
|
5315
|
-
# shared with your account via Amazon Web Services KMS.
|
5272
|
+
# * [Metadata for Amazon EC2][6]
|
5316
5273
|
#
|
5317
|
-
# *
|
5274
|
+
# * [Metadata for Amazon EFS][7]
|
5318
5275
|
#
|
5319
|
-
# *
|
5320
|
-
# (idempotency) of the request.
|
5276
|
+
# * [Metadata for Amazon FSx][8]
|
5321
5277
|
#
|
5322
|
-
# *
|
5323
|
-
# recovery point is restored to a new Amazon EFS file system.
|
5278
|
+
# * [Metadata for Amazon Neptune][9]
|
5324
5279
|
#
|
5325
|
-
# *
|
5326
|
-
#
|
5327
|
-
#
|
5328
|
-
#
|
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
|
5329
5309
|
#
|
5330
5310
|
# @option params [String] :iam_role_arn
|
5331
5311
|
# The Amazon Resource Name (ARN) of the IAM role that Backup uses to
|
@@ -5342,35 +5322,35 @@ module Aws::Backup
|
|
5342
5322
|
# Starts a job to restore a recovery point for one of the following
|
5343
5323
|
# resources:
|
5344
5324
|
#
|
5345
|
-
# * `Aurora`
|
5325
|
+
# * `Aurora` - Amazon Aurora
|
5346
5326
|
#
|
5347
|
-
# * `DocumentDB`
|
5327
|
+
# * `DocumentDB` - Amazon DocumentDB
|
5348
5328
|
#
|
5349
|
-
# * `CloudFormation`
|
5329
|
+
# * `CloudFormation` - CloudFormation
|
5350
5330
|
#
|
5351
|
-
# * `DynamoDB`
|
5331
|
+
# * `DynamoDB` - Amazon DynamoDB
|
5352
5332
|
#
|
5353
|
-
# * `EBS`
|
5333
|
+
# * `EBS` - Amazon Elastic Block Store
|
5354
5334
|
#
|
5355
|
-
# * `EC2`
|
5335
|
+
# * `EC2` - Amazon Elastic Compute Cloud
|
5356
5336
|
#
|
5357
|
-
# * `EFS`
|
5337
|
+
# * `EFS` - Amazon Elastic File System
|
5358
5338
|
#
|
5359
|
-
# * `FSx`
|
5339
|
+
# * `FSx` - Amazon FSx
|
5360
5340
|
#
|
5361
|
-
# * `Neptune`
|
5341
|
+
# * `Neptune` - Amazon Neptune
|
5362
5342
|
#
|
5363
|
-
# * `RDS`
|
5343
|
+
# * `RDS` - Amazon Relational Database Service
|
5364
5344
|
#
|
5365
|
-
# * `Redshift`
|
5345
|
+
# * `Redshift` - Amazon Redshift
|
5366
5346
|
#
|
5367
|
-
# * `Storage Gateway`
|
5347
|
+
# * `Storage Gateway` - Storage Gateway
|
5368
5348
|
#
|
5369
|
-
# * `S3`
|
5349
|
+
# * `S3` - Amazon Simple Storage Service
|
5370
5350
|
#
|
5371
|
-
# * `Timestream`
|
5351
|
+
# * `Timestream` - Amazon Timestream
|
5372
5352
|
#
|
5373
|
-
# * `VirtualMachine`
|
5353
|
+
# * `VirtualMachine` - Virtual machines
|
5374
5354
|
#
|
5375
5355
|
# @option params [Boolean] :copy_source_tags_to_restored_resource
|
5376
5356
|
# This is an optional parameter. If this equals `True`, tags included in
|
@@ -5412,7 +5392,7 @@ module Aws::Backup
|
|
5412
5392
|
#
|
5413
5393
|
# This action is not supported for the following services: Amazon FSx
|
5414
5394
|
# for Windows File Server, Amazon FSx for Lustre, Amazon FSx for NetApp
|
5415
|
-
# ONTAP
|
5395
|
+
# ONTAP, Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB
|
5416
5396
|
# compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.
|
5417
5397
|
#
|
5418
5398
|
# @option params [required, String] :backup_job_id
|
@@ -5438,10 +5418,19 @@ module Aws::Backup
|
|
5438
5418
|
# Assigns a set of key-value pairs to a recovery point, backup plan, or
|
5439
5419
|
# backup vault identified by an Amazon Resource Name (ARN).
|
5440
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
|
+
#
|
5441
5425
|
# @option params [required, String] :resource_arn
|
5442
5426
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
5443
5427
|
# depends on the type of the tagged resource.
|
5444
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
|
+
#
|
5445
5434
|
# @option params [required, Hash<String,String>] :tags
|
5446
5435
|
# Key-value pairs that are used to help organize your resources. You can
|
5447
5436
|
# assign your own metadata to the resources you create. For clarity,
|
@@ -5471,13 +5460,21 @@ module Aws::Backup
|
|
5471
5460
|
# Removes a set of key-value pairs from a recovery point, backup plan,
|
5472
5461
|
# or backup vault identified by an Amazon Resource Name (ARN)
|
5473
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
|
+
#
|
5474
5467
|
# @option params [required, String] :resource_arn
|
5475
5468
|
# An ARN that uniquely identifies a resource. The format of the ARN
|
5476
5469
|
# depends on the type of the tagged resource.
|
5477
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
|
+
#
|
5478
5476
|
# @option params [required, Array<String>] :tag_key_list
|
5479
|
-
#
|
5480
|
-
# resource.
|
5477
|
+
# The keys to identify which key-value tags to remove from a resource.
|
5481
5478
|
#
|
5482
5479
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5483
5480
|
#
|
@@ -5497,16 +5494,15 @@ module Aws::Backup
|
|
5497
5494
|
req.send_request(options)
|
5498
5495
|
end
|
5499
5496
|
|
5500
|
-
# Updates
|
5501
|
-
#
|
5502
|
-
# identified by a `VersionId`.
|
5497
|
+
# Updates the specified backup plan. The new version is uniquely
|
5498
|
+
# identified by its ID.
|
5503
5499
|
#
|
5504
5500
|
# @option params [required, String] :backup_plan_id
|
5505
|
-
#
|
5501
|
+
# The ID of the backup plan.
|
5506
5502
|
#
|
5507
5503
|
# @option params [required, Types::BackupPlanInput] :backup_plan
|
5508
|
-
#
|
5509
|
-
#
|
5504
|
+
# The body of a backup plan. Includes a `BackupPlanName` and one or more
|
5505
|
+
# sets of `Rules`.
|
5510
5506
|
#
|
5511
5507
|
# @return [Types::UpdateBackupPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5512
5508
|
#
|
@@ -5582,8 +5578,7 @@ module Aws::Backup
|
|
5582
5578
|
req.send_request(options)
|
5583
5579
|
end
|
5584
5580
|
|
5585
|
-
# Updates
|
5586
|
-
# the input document in JSON format.
|
5581
|
+
# Updates the specified framework.
|
5587
5582
|
#
|
5588
5583
|
# @option params [required, String] :framework_name
|
5589
5584
|
# The unique name of a framework. This name is between 1 and 256
|
@@ -5595,8 +5590,8 @@ module Aws::Backup
|
|
5595
5590
|
# characters.
|
5596
5591
|
#
|
5597
5592
|
# @option params [Array<Types::FrameworkControl>] :framework_controls
|
5598
|
-
#
|
5599
|
-
#
|
5593
|
+
# The controls that make up the framework. Each control in the list has
|
5594
|
+
# a name, input parameters, and scope.
|
5600
5595
|
#
|
5601
5596
|
# @option params [String] :idempotency_token
|
5602
5597
|
# A customer-chosen string that you can use to distinguish between
|
@@ -5689,28 +5684,31 @@ module Aws::Backup
|
|
5689
5684
|
# cold storage and when it expires. Backup transitions and expires
|
5690
5685
|
# backups automatically according to the lifecycle that you define.
|
5691
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
|
+
#
|
5692
5691
|
# Backups transitioned to cold storage must be stored in cold storage
|
5693
5692
|
# for a minimum of 90 days. Therefore, the “retention” setting must be
|
5694
5693
|
# 90 days greater than the “transition to cold after days” setting. The
|
5695
5694
|
# “transition to cold after days” setting cannot be changed after a
|
5696
5695
|
# backup has been transitioned to cold.
|
5697
5696
|
#
|
5698
|
-
#
|
5699
|
-
#
|
5700
|
-
#
|
5701
|
-
#
|
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.
|
5702
5701
|
#
|
5703
5702
|
# This operation does not support continuous backups.
|
5704
5703
|
#
|
5705
5704
|
#
|
5706
5705
|
#
|
5707
|
-
# [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
|
5708
5707
|
#
|
5709
5708
|
# @option params [required, String] :backup_vault_name
|
5710
5709
|
# The name of a logical container where backups are stored. Backup
|
5711
5710
|
# vaults are identified by names that are unique to the account used to
|
5712
5711
|
# create them and the Amazon Web Services Region where they are created.
|
5713
|
-
# They consist of lowercase letters, numbers, and hyphens.
|
5714
5712
|
#
|
5715
5713
|
# @option params [required, String] :recovery_point_arn
|
5716
5714
|
# An Amazon Resource Name (ARN) that uniquely identifies a recovery
|
@@ -5817,8 +5815,7 @@ module Aws::Backup
|
|
5817
5815
|
req.send_request(options)
|
5818
5816
|
end
|
5819
5817
|
|
5820
|
-
# Updates
|
5821
|
-
# with the input document in JSON format.
|
5818
|
+
# Updates the specified report plan.
|
5822
5819
|
#
|
5823
5820
|
# @option params [required, String] :report_plan_name
|
5824
5821
|
# The unique name of the report plan. This name is between 1 and 256
|
@@ -5830,13 +5827,12 @@ module Aws::Backup
|
|
5830
5827
|
# characters.
|
5831
5828
|
#
|
5832
5829
|
# @option params [Types::ReportDeliveryChannel] :report_delivery_channel
|
5833
|
-
#
|
5834
|
-
#
|
5835
|
-
# 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.
|
5836
5832
|
#
|
5837
5833
|
# @option params [Types::ReportSetting] :report_setting
|
5838
|
-
#
|
5839
|
-
#
|
5834
|
+
# The report template for the report. Reports are built using a report
|
5835
|
+
# template. The report templates are:
|
5840
5836
|
#
|
5841
5837
|
# `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
|
5842
5838
|
# BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
|
@@ -5915,7 +5911,7 @@ module Aws::Backup
|
|
5915
5911
|
# Specifies the body of a restore testing plan.
|
5916
5912
|
#
|
5917
5913
|
# @option params [required, String] :restore_testing_plan_name
|
5918
|
-
#
|
5914
|
+
# The name of the restore testing plan name.
|
5919
5915
|
#
|
5920
5916
|
# @return [Types::UpdateRestoreTestingPlanOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5921
5917
|
#
|
@@ -5958,13 +5954,13 @@ module Aws::Backup
|
|
5958
5954
|
req.send_request(options)
|
5959
5955
|
end
|
5960
5956
|
|
5957
|
+
# Updates the specified restore testing selection.
|
5958
|
+
#
|
5961
5959
|
# Most elements except the `RestoreTestingSelectionName` can be updated
|
5962
5960
|
# with this request.
|
5963
5961
|
#
|
5964
|
-
#
|
5965
|
-
#
|
5966
|
-
# `ProtectedResourceArns`, requesting an update with the parameter
|
5967
|
-
# `ProtectedResourceConditions` will be unsuccessful.
|
5962
|
+
# You can use either protected resource ARNs or conditions, but not
|
5963
|
+
# both.
|
5968
5964
|
#
|
5969
5965
|
# @option params [required, String] :restore_testing_plan_name
|
5970
5966
|
# The restore testing plan name is required to update the indicated
|
@@ -5977,8 +5973,8 @@ module Aws::Backup
|
|
5977
5973
|
# `ProtectedResourceConditions` will be unsuccessful.
|
5978
5974
|
#
|
5979
5975
|
# @option params [required, String] :restore_testing_selection_name
|
5980
|
-
#
|
5981
|
-
#
|
5976
|
+
# The required restore testing selection name of the restore testing
|
5977
|
+
# selection you wish to update.
|
5982
5978
|
#
|
5983
5979
|
# @return [Types::UpdateRestoreTestingSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5984
5980
|
#
|
@@ -6047,7 +6043,7 @@ module Aws::Backup
|
|
6047
6043
|
params: params,
|
6048
6044
|
config: config)
|
6049
6045
|
context[:gem_name] = 'aws-sdk-backup'
|
6050
|
-
context[:gem_version] = '1.
|
6046
|
+
context[:gem_version] = '1.74.0'
|
6051
6047
|
Seahorse::Client::Request.new(handlers, context)
|
6052
6048
|
end
|
6053
6049
|
|