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.
@@ -10,7 +10,7 @@
10
10
  module Aws::Backup
11
11
  module Types
12
12
 
13
- # A list of backup options for each resource type.
13
+ # The backup options for each resource type.
14
14
  #
15
15
  # @!attribute [rw] resource_type
16
16
  # Specifies an object containing resource type and backup options. The
@@ -105,13 +105,13 @@ module Aws::Backup
105
105
  # The name of a logical container where backups are stored. Backup
106
106
  # vaults are identified by names that are unique to the account used
107
107
  # to create them and the Amazon Web Services Region where they are
108
- # created. They consist of lowercase letters, numbers, and hyphens.
108
+ # created.
109
109
  # @return [String]
110
110
  #
111
111
  # @!attribute [rw] backup_vault_arn
112
112
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
113
113
  # vault; for example,
114
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
114
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
115
115
  # @return [String]
116
116
  #
117
117
  # @!attribute [rw] recovery_point_arn
@@ -229,12 +229,12 @@ module Aws::Backup
229
229
  # @return [Boolean]
230
230
  #
231
231
  # @!attribute [rw] resource_name
232
- # This is the non-unique name of the resource that belongs to the
233
- # specified backup.
232
+ # The non-unique name of the resource that belongs to the specified
233
+ # backup.
234
234
  # @return [String]
235
235
  #
236
236
  # @!attribute [rw] initiation_date
237
- # This is the date on which the backup job was initiated.
237
+ # The date on which the backup job was initiated.
238
238
  # @return [Time]
239
239
  #
240
240
  # @!attribute [rw] message_category
@@ -369,8 +369,11 @@ module Aws::Backup
369
369
  # different selection of Amazon Web Services resources.
370
370
  #
371
371
  # @!attribute [rw] backup_plan_name
372
- # The display name of a backup plan. Must contain 1 to 50 alphanumeric
373
- # or '-\_.' characters.
372
+ # The display name of a backup plan. Must contain only alphanumeric or
373
+ # '-\_.' special characters.
374
+ #
375
+ # If this is set in the console, it can contain 1 to 50 characters; if
376
+ # this is set through CLI or API, it can contain 1 to 200 characters.
374
377
  # @return [String]
375
378
  #
376
379
  # @!attribute [rw] rules
@@ -486,11 +489,11 @@ module Aws::Backup
486
489
  # @return [String]
487
490
  #
488
491
  # @!attribute [rw] last_execution_date
489
- # The last time a job to back up resources was run with this rule. A
490
- # date and time, in Unix format and Coordinated Universal Time (UTC).
491
- # The value of `LastExecutionDate` is accurate to milliseconds. For
492
- # example, the value 1516925490.087 represents Friday, January 26,
493
- # 2018 12:11:30.087 AM.
492
+ # The last time this backup plan was run. A date and time, in Unix
493
+ # format and Coordinated Universal Time (UTC). The value of
494
+ # `LastExecutionDate` is accurate to milliseconds. For example, the
495
+ # value 1516925490.087 represents Friday, January 26, 2018
496
+ # 12:11:30.087 AM.
494
497
  # @return [Time]
495
498
  #
496
499
  # @!attribute [rw] advanced_backup_settings
@@ -524,7 +527,7 @@ module Aws::Backup
524
527
  # The name of a logical container where backups are stored. Backup
525
528
  # vaults are identified by names that are unique to the account used
526
529
  # to create them and the Amazon Web Services Region where they are
527
- # created. They consist of lowercase letters, numbers, and hyphens.
530
+ # created.
528
531
  # @return [String]
529
532
  #
530
533
  # @!attribute [rw] schedule_expression
@@ -575,19 +578,18 @@ module Aws::Backup
575
578
  # The “transition to cold after days” setting cannot be changed after
576
579
  # a backup has been transitioned to cold.
577
580
  #
578
- # Resource types that are able to be transitioned to cold storage are
579
- # listed in the "Lifecycle to cold storage" section of the [ Feature
580
- # availability by resource][1] table. Backup ignores this expression
581
- # for other resource types.
581
+ # Resource types that can transition to cold storage are listed in the
582
+ # [Feature availability by resource][1] table. Backup ignores this
583
+ # expression for other resource types.
582
584
  #
583
585
  #
584
586
  #
585
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
587
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
586
588
  # @return [Types::Lifecycle]
587
589
  #
588
590
  # @!attribute [rw] recovery_point_tags
589
- # An array of key-value pair strings that are assigned to resources
590
- # that are associated with this rule when restored from backup.
591
+ # The tags that are assigned to resources that are associated with
592
+ # this rule when restored from backup.
591
593
  # @return [Hash<String,String>]
592
594
  #
593
595
  # @!attribute [rw] rule_id
@@ -608,9 +610,9 @@ module Aws::Backup
608
610
  # @return [Boolean]
609
611
  #
610
612
  # @!attribute [rw] schedule_expression_timezone
611
- # This is the timezone in which the schedule expression is set. By
612
- # default, ScheduleExpressions are in UTC. You can modify this to a
613
- # specified timezone.
613
+ # The timezone in which the schedule expression is set. By default,
614
+ # ScheduleExpressions are in UTC. You can modify this to a specified
615
+ # timezone.
614
616
  # @return [String]
615
617
  #
616
618
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRule AWS API Documentation
@@ -642,7 +644,7 @@ module Aws::Backup
642
644
  # The name of a logical container where backups are stored. Backup
643
645
  # vaults are identified by names that are unique to the account used
644
646
  # to create them and the Amazon Web Services Region where they are
645
- # created. They consist of lowercase letters, numbers, and hyphens.
647
+ # created.
646
648
  # @return [String]
647
649
  #
648
650
  # @!attribute [rw] schedule_expression
@@ -684,23 +686,21 @@ module Aws::Backup
684
686
  # for a minimum of 90 days. Therefore, the “retention” setting must be
685
687
  # 90 days greater than the “transition to cold after days” setting.
686
688
  # The “transition to cold after days” setting cannot be changed after
687
- # a backup has been transitioned to cold.
689
+ # a backup has been transitioned to cold storage.
688
690
  #
689
- # Resource types that are able to be transitioned to cold storage are
690
- # listed in the "Lifecycle to cold storage" section of the [ Feature
691
- # availability by resource][1] table. Backup ignores this expression
692
- # for other resource types.
691
+ # Resource types that can transition to cold storage are listed in the
692
+ # [Feature availability by resource][1] table. Backup ignores this
693
+ # expression for other resource types.
693
694
  #
694
695
  # This parameter has a maximum value of 100 years (36,500 days).
695
696
  #
696
697
  #
697
698
  #
698
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
699
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
699
700
  # @return [Types::Lifecycle]
700
701
  #
701
702
  # @!attribute [rw] recovery_point_tags
702
- # To help organize your resources, you can assign your own metadata to
703
- # the resources that you create. Each tag is a key-value pair.
703
+ # The tags to assign to the resources.
704
704
  # @return [Hash<String,String>]
705
705
  #
706
706
  # @!attribute [rw] copy_actions
@@ -716,9 +716,9 @@ module Aws::Backup
716
716
  # @return [Boolean]
717
717
  #
718
718
  # @!attribute [rw] schedule_expression_timezone
719
- # This is the timezone in which the schedule expression is set. By
720
- # default, ScheduleExpressions are in UTC. You can modify this to a
721
- # specified timezone.
719
+ # The timezone in which the schedule expression is set. By default,
720
+ # ScheduleExpressions are in UTC. You can modify this to a specified
721
+ # timezone.
722
722
  # @return [String]
723
723
  #
724
724
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupRuleInput AWS API Documentation
@@ -740,10 +740,16 @@ module Aws::Backup
740
740
 
741
741
  # Used to specify a set of resources to a backup plan.
742
742
  #
743
- # Specifying your desired `Conditions`, `ListOfTags`, `NotResources`,
744
- # and/or `Resources` is recommended. If none of these are specified,
745
- # Backup will attempt to select all supported and opted-in storage
746
- # resources, which could have unintended cost implications.
743
+ # We recommend that you specify conditions, tags, or resources to
744
+ # include or exclude. Otherwise, Backup attempts to select all supported
745
+ # and opted-in storage resources, which could have unintended cost
746
+ # implications.
747
+ #
748
+ # For more information, see [Assigning resources programmatically][1].
749
+ #
750
+ #
751
+ #
752
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json
747
753
  #
748
754
  # @!attribute [rw] selection_name
749
755
  # The display name of a resource selection document. Must contain 1 to
@@ -757,36 +763,35 @@ module Aws::Backup
757
763
  # @return [String]
758
764
  #
759
765
  # @!attribute [rw] resources
760
- # A list of Amazon Resource Names (ARNs) to assign to a backup plan.
761
- # The maximum number of ARNs is 500 without wildcards, or 30 ARNs with
762
- # wildcards.
766
+ # The Amazon Resource Names (ARNs) of the resources to assign to a
767
+ # backup plan. The maximum number of ARNs is 500 without wildcards, or
768
+ # 30 ARNs with wildcards.
763
769
  #
764
770
  # If you need to assign many resources to a backup plan, consider a
765
771
  # different resource selection strategy, such as assigning all
766
772
  # resources of a resource type or refining your resource selection
767
773
  # using tags.
774
+ #
775
+ # If you specify multiple ARNs, the resources much match any of the
776
+ # ARNs (OR logic).
768
777
  # @return [Array<String>]
769
778
  #
770
779
  # @!attribute [rw] list_of_tags
771
- # A list of conditions that you define to assign resources to your
772
- # backup plans using tags. For example, `"StringEquals": \{ "Key":
773
- # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition
774
- # operators are case sensitive.
775
- #
776
- # `ListOfTags` differs from `Conditions` as follows:
780
+ # The conditions that you define to assign resources to your backup
781
+ # plans using tags. For example, `"StringEquals": \{ "ConditionKey":
782
+ # "backup", "ConditionValue": "daily"\}`.
777
783
  #
778
- # * When you specify more than one condition, you assign all resources
779
- # that match AT LEAST ONE condition (using OR logic).
784
+ # `ListOfTags` supports only `StringEquals`. Condition operators are
785
+ # case sensitive.
780
786
  #
781
- # * `ListOfTags` only supports `StringEquals`. `Conditions` supports
782
- # `StringEquals`, `StringLike`, `StringNotEquals`, and
783
- # `StringNotLike`.
787
+ # If you specify multiple conditions, the resources much match any of
788
+ # the conditions (OR logic).
784
789
  # @return [Array<Types::Condition>]
785
790
  #
786
791
  # @!attribute [rw] not_resources
787
- # A list of Amazon Resource Names (ARNs) to exclude from a backup
788
- # plan. The maximum number of ARNs is 500 without wildcards, or 30
789
- # ARNs with wildcards.
792
+ # The Amazon Resource Names (ARNs) of the resources to exclude from a
793
+ # backup plan. The maximum number of ARNs is 500 without wildcards, or
794
+ # 30 ARNs with wildcards.
790
795
  #
791
796
  # If you need to exclude many resources from a backup plan, consider a
792
797
  # different resource selection strategy, such as assigning only one or
@@ -794,19 +799,16 @@ module Aws::Backup
794
799
  # @return [Array<String>]
795
800
  #
796
801
  # @!attribute [rw] conditions
797
- # A list of conditions that you define to assign resources to your
798
- # backup plans using tags. For example, `"StringEquals": \{ "Key":
799
- # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition
800
- # operators are case sensitive.
802
+ # The conditions that you define to assign resources to your backup
803
+ # plans using tags. For example, `"StringEquals": \{ "ConditionKey":
804
+ # "aws:ResourceTag/backup", "ConditionValue": "daily" \}`.
801
805
  #
802
- # `Conditions` differs from `ListOfTags` as follows:
806
+ # `Conditions` supports `StringEquals`, `StringLike`,
807
+ # `StringNotEquals`, and `StringNotLike`. Condition operators are case
808
+ # sensitive.
803
809
  #
804
- # * When you specify more than one condition, you only assign the
805
- # resources that match ALL conditions (using AND logic).
806
- #
807
- # * `Conditions` supports `StringEquals`, `StringLike`,
808
- # `StringNotEquals`, and `StringNotLike`. `ListOfTags` only supports
809
- # `StringEquals`.
810
+ # If you specify multiple conditions, the resources much match all
811
+ # conditions (AND logic).
810
812
  # @return [Types::Conditions]
811
813
  #
812
814
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupSelection AWS API Documentation
@@ -878,13 +880,21 @@ module Aws::Backup
878
880
  # The name of a logical container where backups are stored. Backup
879
881
  # vaults are identified by names that are unique to the account used
880
882
  # to create them and the Amazon Web Services Region where they are
881
- # created. They consist of lowercase letters, numbers, and hyphens.
883
+ # created.
882
884
  # @return [String]
883
885
  #
884
886
  # @!attribute [rw] backup_vault_arn
885
887
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
886
888
  # vault; for example,
887
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
889
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
890
+ # @return [String]
891
+ #
892
+ # @!attribute [rw] vault_type
893
+ # The type of vault in which the described recovery point is stored.
894
+ # @return [String]
895
+ #
896
+ # @!attribute [rw] vault_state
897
+ # The current state of the vault.
888
898
  # @return [String]
889
899
  #
890
900
  # @!attribute [rw] creation_date
@@ -979,6 +989,8 @@ module Aws::Backup
979
989
  class BackupVaultListMember < Struct.new(
980
990
  :backup_vault_name,
981
991
  :backup_vault_arn,
992
+ :vault_type,
993
+ :vault_state,
982
994
  :creation_date,
983
995
  :encryption_key_arn,
984
996
  :creator_request_id,
@@ -1004,14 +1016,13 @@ module Aws::Backup
1004
1016
  # “transition to cold after days” setting cannot be changed after a
1005
1017
  # backup has been transitioned to cold.
1006
1018
  #
1007
- # Resource types that are able to be transitioned to cold storage are
1008
- # listed in the "Lifecycle to cold storage" section of the [ Feature
1009
- # availability by resource][1] table. Backup ignores this expression for
1010
- # other resource types.
1019
+ # Resource types that can transition to cold storage are listed in the
1020
+ # [Feature availability by resource][1] table. Backup ignores this
1021
+ # expression for other resource types.
1011
1022
  #
1012
1023
  #
1013
1024
  #
1014
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
1025
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
1015
1026
  #
1016
1027
  # @!attribute [rw] move_to_cold_storage_at
1017
1028
  # A timestamp that specifies when to transition a recovery point to
@@ -1032,17 +1043,15 @@ module Aws::Backup
1032
1043
  end
1033
1044
 
1034
1045
  # @!attribute [rw] legal_hold_id
1035
- # Legal hold ID required to remove the specified legal hold on a
1036
- # recovery point.
1046
+ # The ID of the legal hold.
1037
1047
  # @return [String]
1038
1048
  #
1039
1049
  # @!attribute [rw] cancel_description
1040
- # String describing the reason for removing the legal hold.
1050
+ # A string the describes the reason for removing the legal hold.
1041
1051
  # @return [String]
1042
1052
  #
1043
1053
  # @!attribute [rw] retain_record_in_days
1044
- # The integer amount in days specifying amount of days after this API
1045
- # operation to remove legal hold.
1054
+ # The integer amount, in days, after which to remove legal hold.
1046
1055
  # @return [Integer]
1047
1056
  #
1048
1057
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CancelLegalHoldInput AWS API Documentation
@@ -1098,6 +1107,9 @@ module Aws::Backup
1098
1107
  # Includes information about tags you define to assign tagged resources
1099
1108
  # to a backup plan.
1100
1109
  #
1110
+ # Include the prefix `aws:ResourceTag` in your tags. For example,
1111
+ # `"aws:ResourceTag/TagKey1": "Value1"`.
1112
+ #
1101
1113
  # @!attribute [rw] condition_key
1102
1114
  # The key in a key-value pair. For example, in the tag `Department:
1103
1115
  # Accounting`, `Department` is the key.
@@ -1181,11 +1193,11 @@ module Aws::Backup
1181
1193
  include Aws::Structure
1182
1194
  end
1183
1195
 
1184
- # A list of parameters for a control. A control can have zero, one, or
1185
- # more than one parameter. An example of a control with two parameters
1186
- # is: "backup plan frequency is at least `daily` and the retention
1187
- # period is at least `1 year`". The first parameter is `daily`. The
1188
- # second parameter is `1 year`.
1196
+ # The parameters for a control. A control can have zero, one, or more
1197
+ # than one parameter. An example of a control with two parameters is:
1198
+ # "backup plan frequency is at least `daily` and the retention period
1199
+ # is at least `1 year`". The first parameter is `daily`. The second
1200
+ # parameter is `1 year`.
1189
1201
  #
1190
1202
  # @!attribute [rw] parameter_name
1191
1203
  # The name of a parameter, for example, `BackupPlanFrequency`.
@@ -1231,8 +1243,12 @@ module Aws::Backup
1231
1243
  # The tag key-value pair applied to those Amazon Web Services
1232
1244
  # resources that you want to trigger an evaluation for a rule. A
1233
1245
  # maximum of one key-value pair can be provided. The tag value is
1234
- # optional, but it cannot be an empty string. The structure to assign
1235
- # a tag is: `[\{"Key":"string","Value":"string"\}]`.
1246
+ # optional, but it cannot be an empty string if you are creating or
1247
+ # editing a framework from the console (though the value can be an
1248
+ # empty string when included in a CloudFormation template).
1249
+ #
1250
+ # The structure to assign a tag is:
1251
+ # `[\{"Key":"string","Value":"string"\}]`.
1236
1252
  # @return [Hash<String,String>]
1237
1253
  #
1238
1254
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ControlScope AWS API Documentation
@@ -1248,30 +1264,32 @@ module Aws::Backup
1248
1264
  # The details of the copy operation.
1249
1265
  #
1250
1266
  # @!attribute [rw] lifecycle
1251
- # Contains an array of `Transition` objects specifying how long in
1252
- # days before a recovery point transitions to cold storage or is
1253
- # deleted.
1267
+ # Specifies the time period, in days, before a recovery point
1268
+ # transitions to cold storage or is deleted.
1254
1269
  #
1255
1270
  # Backups transitioned to cold storage must be stored in cold storage
1256
- # for a minimum of 90 days. Therefore, on the console, the retention
1257
- # setting must be 90 days greater than the transition to cold after
1258
- # days setting. The transition to cold after days setting cannot be
1271
+ # for a minimum of 90 days. Therefore, on the console, the retention
1272
+ # setting must be 90 days greater than the transition to cold after
1273
+ # days setting. The transition to cold after days setting can't be
1259
1274
  # changed after a backup has been transitioned to cold.
1260
1275
  #
1261
- # Resource types that are able to be transitioned to cold storage are
1262
- # listed in the "Lifecycle to cold storage" section of the [ Feature
1263
- # availability by resource][1] table. Backup ignores this expression
1264
- # for other resource types.
1276
+ # Resource types that can transition to cold storage are listed in the
1277
+ # [Feature availability by resource][1] table. Backup ignores this
1278
+ # expression for other resource types.
1265
1279
  #
1280
+ # To remove the existing lifecycle and retention periods and keep your
1281
+ # recovery points indefinitely, specify -1 for
1282
+ # `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
1266
1283
  #
1267
1284
  #
1268
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
1285
+ #
1286
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
1269
1287
  # @return [Types::Lifecycle]
1270
1288
  #
1271
1289
  # @!attribute [rw] destination_backup_vault_arn
1272
1290
  # An Amazon Resource Name (ARN) that uniquely identifies the
1273
1291
  # destination backup vault for the copied backup. For example,
1274
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
1292
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
1275
1293
  # @return [String]
1276
1294
  #
1277
1295
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CopyAction AWS API Documentation
@@ -1296,7 +1314,7 @@ module Aws::Backup
1296
1314
  # @!attribute [rw] source_backup_vault_arn
1297
1315
  # An Amazon Resource Name (ARN) that uniquely identifies a source copy
1298
1316
  # vault; for example,
1299
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
1317
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
1300
1318
  # @return [String]
1301
1319
  #
1302
1320
  # @!attribute [rw] source_recovery_point_arn
@@ -1308,7 +1326,7 @@ module Aws::Backup
1308
1326
  # @!attribute [rw] destination_backup_vault_arn
1309
1327
  # An Amazon Resource Name (ARN) that uniquely identifies a destination
1310
1328
  # copy vault; for example,
1311
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
1329
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
1312
1330
  # @return [String]
1313
1331
  #
1314
1332
  # @!attribute [rw] destination_recovery_point_arn
@@ -1377,8 +1395,8 @@ module Aws::Backup
1377
1395
  # @return [Boolean]
1378
1396
  #
1379
1397
  # @!attribute [rw] composite_member_identifier
1380
- # This is the identifier of a resource within a composite group, such
1381
- # as nested (child) recovery point belonging to a composite (parent)
1398
+ # The identifier of a resource within a composite group, such as
1399
+ # nested (child) recovery point belonging to a composite (parent)
1382
1400
  # stack. The ID is transferred from the [ logical ID][1] within a
1383
1401
  # stack.
1384
1402
  #
@@ -1388,7 +1406,7 @@ module Aws::Backup
1388
1406
  # @return [String]
1389
1407
  #
1390
1408
  # @!attribute [rw] number_of_child_jobs
1391
- # This is the number of child (nested) copy jobs.
1409
+ # The number of child (nested) copy jobs.
1392
1410
  # @return [Integer]
1393
1411
  #
1394
1412
  # @!attribute [rw] child_jobs_in_state
@@ -1397,8 +1415,8 @@ module Aws::Backup
1397
1415
  # @return [Hash<String,Integer>]
1398
1416
  #
1399
1417
  # @!attribute [rw] resource_name
1400
- # This is the non-unique name of the resource that belongs to the
1401
- # specified backup.
1418
+ # The non-unique name of the resource that belongs to the specified
1419
+ # backup.
1402
1420
  # @return [String]
1403
1421
  #
1404
1422
  # @!attribute [rw] message_category
@@ -1455,7 +1473,7 @@ module Aws::Backup
1455
1473
  # of included jobs.
1456
1474
  #
1457
1475
  # @!attribute [rw] region
1458
- # This is the Amazon Web Services Regions within the job summary.
1476
+ # The Amazon Web Services Regions within the job summary.
1459
1477
  # @return [String]
1460
1478
  #
1461
1479
  # @!attribute [rw] account_id
@@ -1525,14 +1543,12 @@ module Aws::Backup
1525
1543
  end
1526
1544
 
1527
1545
  # @!attribute [rw] backup_plan
1528
- # Specifies the body of a backup plan. Includes a `BackupPlanName` and
1529
- # one or more sets of `Rules`.
1546
+ # The body of a backup plan. Includes a `BackupPlanName` and one or
1547
+ # more sets of `Rules`.
1530
1548
  # @return [Types::BackupPlanInput]
1531
1549
  #
1532
1550
  # @!attribute [rw] backup_plan_tags
1533
- # To help organize your resources, you can assign your own metadata to
1534
- # the resources that you create. Each tag is a key-value pair. The
1535
- # specified tags are assigned to all backups created with this plan.
1551
+ # The tags to assign to the backup plan.
1536
1552
  # @return [Hash<String,String>]
1537
1553
  #
1538
1554
  # @!attribute [rw] creator_request_id
@@ -1556,7 +1572,7 @@ module Aws::Backup
1556
1572
  end
1557
1573
 
1558
1574
  # @!attribute [rw] backup_plan_id
1559
- # Uniquely identifies a backup plan.
1575
+ # The ID of the backup plan.
1560
1576
  # @return [String]
1561
1577
  #
1562
1578
  # @!attribute [rw] backup_plan_arn
@@ -1578,9 +1594,8 @@ module Aws::Backup
1578
1594
  # @return [String]
1579
1595
  #
1580
1596
  # @!attribute [rw] advanced_backup_settings
1581
- # A list of `BackupOptions` settings for a resource type. This option
1582
- # is only available for Windows Volume Shadow Copy Service (VSS)
1583
- # backup jobs.
1597
+ # The settings for a resource type. This option is only available for
1598
+ # Windows Volume Shadow Copy Service (VSS) backup jobs.
1584
1599
  # @return [Array<Types::AdvancedBackupSetting>]
1585
1600
  #
1586
1601
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanOutput AWS API Documentation
@@ -1596,13 +1611,11 @@ module Aws::Backup
1596
1611
  end
1597
1612
 
1598
1613
  # @!attribute [rw] backup_plan_id
1599
- # Uniquely identifies the backup plan to be associated with the
1600
- # selection of resources.
1614
+ # The ID of the backup plan.
1601
1615
  # @return [String]
1602
1616
  #
1603
1617
  # @!attribute [rw] backup_selection
1604
- # Specifies the body of a request to assign a set of resources to a
1605
- # backup plan.
1618
+ # The body of a request to assign a set of resources to a backup plan.
1606
1619
  # @return [Types::BackupSelection]
1607
1620
  #
1608
1621
  # @!attribute [rw] creator_request_id
@@ -1630,7 +1643,7 @@ module Aws::Backup
1630
1643
  # @return [String]
1631
1644
  #
1632
1645
  # @!attribute [rw] backup_plan_id
1633
- # Uniquely identifies a backup plan.
1646
+ # The ID of the backup plan.
1634
1647
  # @return [String]
1635
1648
  #
1636
1649
  # @!attribute [rw] creation_date
@@ -1658,8 +1671,7 @@ module Aws::Backup
1658
1671
  # @return [String]
1659
1672
  #
1660
1673
  # @!attribute [rw] backup_vault_tags
1661
- # Metadata that you can assign to help organize the resources that you
1662
- # create. Each tag is a key-value pair.
1674
+ # The tags to assign to the backup vault.
1663
1675
  # @return [Hash<String,String>]
1664
1676
  #
1665
1677
  # @!attribute [rw] encryption_key_arn
@@ -1698,7 +1710,7 @@ module Aws::Backup
1698
1710
  # @!attribute [rw] backup_vault_arn
1699
1711
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
1700
1712
  # vault; for example,
1701
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
1713
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
1702
1714
  # @return [String]
1703
1715
  #
1704
1716
  # @!attribute [rw] creation_date
@@ -1730,8 +1742,8 @@ module Aws::Backup
1730
1742
  # @return [String]
1731
1743
  #
1732
1744
  # @!attribute [rw] framework_controls
1733
- # A list of the controls that make up the framework. Each control in
1734
- # the list has a name, input parameters, and scope.
1745
+ # The controls that make up the framework. Each control in the list
1746
+ # has a name, input parameters, and scope.
1735
1747
  # @return [Array<Types::FrameworkControl>]
1736
1748
  #
1737
1749
  # @!attribute [rw] idempotency_token
@@ -1745,8 +1757,7 @@ module Aws::Backup
1745
1757
  # @return [String]
1746
1758
  #
1747
1759
  # @!attribute [rw] framework_tags
1748
- # Metadata that you can assign to help organize the frameworks that
1749
- # you create. Each tag is a key-value pair.
1760
+ # The tags to assign to the framework.
1750
1761
  # @return [Hash<String,String>]
1751
1762
  #
1752
1763
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateFrameworkInput AWS API Documentation
@@ -1782,11 +1793,11 @@ module Aws::Backup
1782
1793
  end
1783
1794
 
1784
1795
  # @!attribute [rw] title
1785
- # This is the string title of the legal hold.
1796
+ # The title of the legal hold.
1786
1797
  # @return [String]
1787
1798
  #
1788
1799
  # @!attribute [rw] description
1789
- # This is the string description of the legal hold.
1800
+ # The description of the legal hold.
1790
1801
  # @return [String]
1791
1802
  #
1792
1803
  # @!attribute [rw] idempotency_token
@@ -1796,8 +1807,8 @@ module Aws::Backup
1796
1807
  # @return [String]
1797
1808
  #
1798
1809
  # @!attribute [rw] recovery_point_selection
1799
- # This specifies criteria to assign a set of resources, such as
1800
- # resource types or backup vaults.
1810
+ # The criteria to assign a set of resources, such as resource types or
1811
+ # backup vaults.
1801
1812
  # @return [Types::RecoveryPointSelection]
1802
1813
  #
1803
1814
  # @!attribute [rw] tags
@@ -1820,36 +1831,32 @@ module Aws::Backup
1820
1831
  end
1821
1832
 
1822
1833
  # @!attribute [rw] title
1823
- # This is the string title of the legal hold returned after creating
1824
- # the legal hold.
1834
+ # The title of the legal hold.
1825
1835
  # @return [String]
1826
1836
  #
1827
1837
  # @!attribute [rw] status
1828
- # This displays the status of the legal hold returned after creating
1829
- # the legal hold. Statuses can be `ACTIVE`, `PENDING`, `CANCELED`,
1830
- # `CANCELING`, or `FAILED`.
1838
+ # The status of the legal hold.
1831
1839
  # @return [String]
1832
1840
  #
1833
1841
  # @!attribute [rw] description
1834
- # This is the returned string description of the legal hold.
1842
+ # The description of the legal hold.
1835
1843
  # @return [String]
1836
1844
  #
1837
1845
  # @!attribute [rw] legal_hold_id
1838
- # Legal hold ID returned for the specified legal hold on a recovery
1839
- # point.
1846
+ # The ID of the legal hold.
1840
1847
  # @return [String]
1841
1848
  #
1842
1849
  # @!attribute [rw] legal_hold_arn
1843
- # This is the ARN (Amazon Resource Number) of the created legal hold.
1850
+ # The Amazon Resource Name (ARN) of the legal hold.
1844
1851
  # @return [String]
1845
1852
  #
1846
1853
  # @!attribute [rw] creation_date
1847
- # Time in number format when legal hold was created.
1854
+ # The time when the legal hold was created.
1848
1855
  # @return [Time]
1849
1856
  #
1850
1857
  # @!attribute [rw] recovery_point_selection
1851
- # This specifies criteria to assign a set of resources, such as
1852
- # resource types or backup vaults.
1858
+ # The criteria to assign to a set of resources, such as resource types
1859
+ # or backup vaults.
1853
1860
  # @return [Types::RecoveryPointSelection]
1854
1861
  #
1855
1862
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLegalHoldOutput AWS API Documentation
@@ -1867,15 +1874,18 @@ module Aws::Backup
1867
1874
  end
1868
1875
 
1869
1876
  # @!attribute [rw] backup_vault_name
1870
- # This is the name of the vault that is being created.
1877
+ # The name of a logical container where backups are stored. Logically
1878
+ # air-gapped backup vaults are identified by names that are unique to
1879
+ # the account used to create them and the Region where they are
1880
+ # created.
1871
1881
  # @return [String]
1872
1882
  #
1873
1883
  # @!attribute [rw] backup_vault_tags
1874
- # These are the tags that will be included in the newly-created vault.
1884
+ # The tags to assign to the vault.
1875
1885
  # @return [Hash<String,String>]
1876
1886
  #
1877
1887
  # @!attribute [rw] creator_request_id
1878
- # This is the ID of the creation request.
1888
+ # The ID of the creation request.
1879
1889
  #
1880
1890
  # This parameter is optional. If used, this parameter must contain 1
1881
1891
  # to 50 alphanumeric or '-\_.' characters.
@@ -1883,29 +1893,14 @@ module Aws::Backup
1883
1893
  #
1884
1894
  # @!attribute [rw] min_retention_days
1885
1895
  # This setting specifies the minimum retention period that the vault
1886
- # retains its recovery points. If this parameter is not specified, no
1887
- # minimum retention period is enforced.
1896
+ # retains its recovery points.
1888
1897
  #
1889
- # If specified, any backup or copy job to the vault must have a
1890
- # lifecycle policy with a retention period equal to or longer than the
1891
- # minimum retention period. If a job retention period is shorter than
1892
- # that minimum retention period, then the vault fails the backup or
1893
- # copy job, and you should either modify your lifecycle settings or
1894
- # use a different vault.
1898
+ # The minimum value accepted is 7 days.
1895
1899
  # @return [Integer]
1896
1900
  #
1897
1901
  # @!attribute [rw] max_retention_days
1898
- # This is the setting that specifies the maximum retention period that
1899
- # the vault retains its recovery points. If this parameter is not
1900
- # specified, Backup does not enforce a maximum retention period on the
1901
- # recovery points in the vault (allowing indefinite storage).
1902
- #
1903
- # If specified, any backup or copy job to the vault must have a
1904
- # lifecycle policy with a retention period equal to or shorter than
1905
- # the maximum retention period. If the job retention period is longer
1906
- # than that maximum retention period, then the vault fails the backup
1907
- # or copy job, and you should either modify your lifecycle settings or
1908
- # use a different vault.
1902
+ # The maximum retention period that the vault retains its recovery
1903
+ # points.
1909
1904
  # @return [Integer]
1910
1905
  #
1911
1906
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLogicallyAirGappedBackupVaultInput AWS API Documentation
@@ -1924,11 +1919,11 @@ module Aws::Backup
1924
1919
  # The name of a logical container where backups are stored. Logically
1925
1920
  # air-gapped backup vaults are identified by names that are unique to
1926
1921
  # the account used to create them and the Region where they are
1927
- # created. They consist of lowercase letters, numbers, and hyphens.
1922
+ # created.
1928
1923
  # @return [String]
1929
1924
  #
1930
1925
  # @!attribute [rw] backup_vault_arn
1931
- # This is the ARN (Amazon Resource Name) of the vault being created.
1926
+ # The ARN (Amazon Resource Name) of the vault.
1932
1927
  # @return [String]
1933
1928
  #
1934
1929
  # @!attribute [rw] creation_date
@@ -1940,7 +1935,7 @@ module Aws::Backup
1940
1935
  # @return [Time]
1941
1936
  #
1942
1937
  # @!attribute [rw] vault_state
1943
- # This is the current state of the vault.
1938
+ # The current state of the vault.
1944
1939
  # @return [String]
1945
1940
  #
1946
1941
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateLogicallyAirGappedBackupVaultOutput AWS API Documentation
@@ -1984,8 +1979,7 @@ module Aws::Backup
1984
1979
  # @return [Types::ReportSetting]
1985
1980
  #
1986
1981
  # @!attribute [rw] report_plan_tags
1987
- # Metadata that you can assign to help organize the report plans that
1988
- # you create. Each tag is a key-value pair.
1982
+ # The tags to assign to the report plan.
1989
1983
  # @return [Hash<String,String>]
1990
1984
  #
1991
1985
  # @!attribute [rw] idempotency_token
@@ -2056,10 +2050,7 @@ module Aws::Backup
2056
2050
  # @return [Types::RestoreTestingPlanForCreate]
2057
2051
  #
2058
2052
  # @!attribute [rw] tags
2059
- # Optional tags to include. A tag is a key-value pair you can use to
2060
- # manage, filter, and search for your resources. Allowed characters
2061
- # include UTF-8 letters,numbers, spaces, and the following characters:
2062
- # + - = . \_ : /.
2053
+ # The tags to assign to the restore testing plan.
2063
2054
  # @return [Hash<String,String>]
2064
2055
  #
2065
2056
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreTestingPlanInput AWS API Documentation
@@ -2140,25 +2131,24 @@ module Aws::Backup
2140
2131
  end
2141
2132
 
2142
2133
  # @!attribute [rw] creation_time
2143
- # This is the time the resource testing selection was created
2144
- # successfully.
2134
+ # The time that the resource testing selection was created.
2145
2135
  # @return [Time]
2146
2136
  #
2147
2137
  # @!attribute [rw] restore_testing_plan_arn
2148
- # This is the ARN of the restore testing plan with which the restore
2149
- # testing selection is associated.
2138
+ # The ARN of the restore testing plan with which the restore testing
2139
+ # selection is associated.
2150
2140
  # @return [String]
2151
2141
  #
2152
2142
  # @!attribute [rw] restore_testing_plan_name
2153
- # Unique string that is the name of the restore testing plan.
2143
+ # The name of the restore testing plan.
2154
2144
  #
2155
2145
  # The name cannot be changed after creation. The name consists of only
2156
2146
  # alphanumeric characters and underscores. Maximum length is 50.
2157
2147
  # @return [String]
2158
2148
  #
2159
2149
  # @!attribute [rw] restore_testing_selection_name
2160
- # This is the unique name of the restore testing selection that
2161
- # belongs to the related restore testing plan.
2150
+ # The name of the restore testing selection for the related restore
2151
+ # testing plan.
2162
2152
  # @return [String]
2163
2153
  #
2164
2154
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateRestoreTestingSelectionOutput AWS API Documentation
@@ -2288,7 +2278,7 @@ module Aws::Backup
2288
2278
  # The name of a logical container where backups are stored. Backup
2289
2279
  # vaults are identified by names that are unique to the account used
2290
2280
  # to create them and the Amazon Web Services Region where they are
2291
- # created. They consist of lowercase letters, numbers, and hyphens.
2281
+ # created.
2292
2282
  # @return [String]
2293
2283
  #
2294
2284
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultInput AWS API Documentation
@@ -2314,8 +2304,7 @@ module Aws::Backup
2314
2304
  # @!attribute [rw] backup_vault_name
2315
2305
  # The name of a logical container where backups are stored. Backup
2316
2306
  # vaults are identified by names that are unique to the account used
2317
- # to create them and the Region where they are created. They consist
2318
- # of lowercase letters, numbers, and hyphens.
2307
+ # to create them and the Region where they are created.
2319
2308
  # @return [String]
2320
2309
  #
2321
2310
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultNotificationsInput AWS API Documentation
@@ -2342,7 +2331,7 @@ module Aws::Backup
2342
2331
  # The name of a logical container where backups are stored. Backup
2343
2332
  # vaults are identified by names that are unique to the account used
2344
2333
  # to create them and the Amazon Web Services Region where they are
2345
- # created. They consist of lowercase letters, numbers, and hyphens.
2334
+ # created.
2346
2335
  # @return [String]
2347
2336
  #
2348
2337
  # @!attribute [rw] recovery_point_arn
@@ -2453,13 +2442,13 @@ module Aws::Backup
2453
2442
  # The name of a logical container where backups are stored. Backup
2454
2443
  # vaults are identified by names that are unique to the account used
2455
2444
  # to create them and the Amazon Web Services Region where they are
2456
- # created. They consist of lowercase letters, numbers, and hyphens.
2445
+ # created.
2457
2446
  # @return [String]
2458
2447
  #
2459
2448
  # @!attribute [rw] backup_vault_arn
2460
2449
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
2461
2450
  # vault; for example,
2462
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
2451
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
2463
2452
  # @return [String]
2464
2453
  #
2465
2454
  # @!attribute [rw] recovery_point_arn
@@ -2576,16 +2565,16 @@ module Aws::Backup
2576
2565
  # @return [Hash<String,Integer>]
2577
2566
  #
2578
2567
  # @!attribute [rw] resource_name
2579
- # This is the non-unique name of the resource that belongs to the
2580
- # specified backup.
2568
+ # The non-unique name of the resource that belongs to the specified
2569
+ # backup.
2581
2570
  # @return [String]
2582
2571
  #
2583
2572
  # @!attribute [rw] initiation_date
2584
- # This is the date a backup job was initiated.
2573
+ # The date a backup job was initiated.
2585
2574
  # @return [Time]
2586
2575
  #
2587
2576
  # @!attribute [rw] message_category
2588
- # This is the job count for the specified message category.
2577
+ # The job count for the specified message category.
2589
2578
  #
2590
2579
  # Example strings may include `AccessDenied`, `SUCCESS`,
2591
2580
  # `AGGREGATE_ALL`, and `INVALIDPARAMETERS`. View [Monitoring][1] for a
@@ -2634,11 +2623,11 @@ module Aws::Backup
2634
2623
  # The name of a logical container where backups are stored. Backup
2635
2624
  # vaults are identified by names that are unique to the account used
2636
2625
  # to create them and the Amazon Web Services Region where they are
2637
- # created. They consist of lowercase letters, numbers, and hyphens.
2626
+ # created.
2638
2627
  # @return [String]
2639
2628
  #
2640
2629
  # @!attribute [rw] backup_vault_account_id
2641
- # This is the account ID of the specified backup vault.
2630
+ # The account ID of the specified backup vault.
2642
2631
  # @return [String]
2643
2632
  #
2644
2633
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVaultInput AWS API Documentation
@@ -2653,18 +2642,21 @@ module Aws::Backup
2653
2642
  # @!attribute [rw] backup_vault_name
2654
2643
  # The name of a logical container where backups are stored. Backup
2655
2644
  # vaults are identified by names that are unique to the account used
2656
- # to create them and the Region where they are created. They consist
2657
- # of lowercase letters, numbers, and hyphens.
2645
+ # to create them and the Region where they are created.
2658
2646
  # @return [String]
2659
2647
  #
2660
2648
  # @!attribute [rw] backup_vault_arn
2661
2649
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
2662
2650
  # vault; for example,
2663
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
2651
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
2664
2652
  # @return [String]
2665
2653
  #
2666
2654
  # @!attribute [rw] vault_type
2667
- # This is the type of vault described.
2655
+ # The type of vault described.
2656
+ # @return [String]
2657
+ #
2658
+ # @!attribute [rw] vault_state
2659
+ # The current state of the vault.-&gt;
2668
2660
  # @return [String]
2669
2661
  #
2670
2662
  # @!attribute [rw] encryption_key_arn
@@ -2701,7 +2693,7 @@ module Aws::Backup
2701
2693
  # @!attribute [rw] min_retention_days
2702
2694
  # The Backup Vault Lock setting that specifies the minimum retention
2703
2695
  # period that the vault retains its recovery points. If this parameter
2704
- # is not specified, Vault Lock does not enforce a minimum retention
2696
+ # is not specified, Vault Lock will not enforce a minimum retention
2705
2697
  # period.
2706
2698
  #
2707
2699
  # If specified, any backup or copy job to the vault must have a
@@ -2748,6 +2740,7 @@ module Aws::Backup
2748
2740
  :backup_vault_name,
2749
2741
  :backup_vault_arn,
2750
2742
  :vault_type,
2743
+ :vault_state,
2751
2744
  :encryption_key_arn,
2752
2745
  :creation_date,
2753
2746
  :creator_request_id,
@@ -2810,8 +2803,8 @@ module Aws::Backup
2810
2803
  # @return [String]
2811
2804
  #
2812
2805
  # @!attribute [rw] framework_controls
2813
- # A list of the controls that make up the framework. Each control in
2814
- # the list has a name, input parameters, and scope.
2806
+ # The controls that make up the framework. Each control in the list
2807
+ # has a name, input parameters, and scope.
2815
2808
  # @return [Array<Types::FrameworkControl>]
2816
2809
  #
2817
2810
  # @!attribute [rw] creation_time
@@ -2927,31 +2920,29 @@ module Aws::Backup
2927
2920
  # @return [Time]
2928
2921
  #
2929
2922
  # @!attribute [rw] resource_name
2930
- # This is the non-unique name of the resource that belongs to the
2931
- # specified backup.
2923
+ # The name of the resource that belongs to the specified backup.
2932
2924
  # @return [String]
2933
2925
  #
2934
2926
  # @!attribute [rw] last_backup_vault_arn
2935
- # This is the ARN (Amazon Resource Name) of the backup vault that
2936
- # contains the most recent backup recovery point.
2927
+ # The ARN (Amazon Resource Name) of the backup vault that contains the
2928
+ # most recent backup recovery point.
2937
2929
  # @return [String]
2938
2930
  #
2939
2931
  # @!attribute [rw] last_recovery_point_arn
2940
- # This is the ARN (Amazon Resource Name) of the most recent recovery
2941
- # point.
2932
+ # The ARN (Amazon Resource Name) of the most recent recovery point.
2942
2933
  # @return [String]
2943
2934
  #
2944
2935
  # @!attribute [rw] latest_restore_execution_time_minutes
2945
- # This is the time in minutes the most recent restore job took to
2936
+ # The time, in minutes, that the most recent restore job took to
2946
2937
  # complete.
2947
2938
  # @return [Integer]
2948
2939
  #
2949
2940
  # @!attribute [rw] latest_restore_job_creation_date
2950
- # This is the creation date of the most recent restore job.
2941
+ # The creation date of the most recent restore job.
2951
2942
  # @return [Time]
2952
2943
  #
2953
2944
  # @!attribute [rw] latest_restore_recovery_point_creation_date
2954
- # This is the date the most recent recovery point was created.
2945
+ # The date the most recent recovery point was created.
2955
2946
  # @return [Time]
2956
2947
  #
2957
2948
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeProtectedResourceOutput AWS API Documentation
@@ -2974,7 +2965,7 @@ module Aws::Backup
2974
2965
  # The name of a logical container where backups are stored. Backup
2975
2966
  # vaults are identified by names that are unique to the account used
2976
2967
  # to create them and the Amazon Web Services Region where they are
2977
- # created. They consist of lowercase letters, numbers, and hyphens.
2968
+ # created.
2978
2969
  # @return [String]
2979
2970
  #
2980
2971
  # @!attribute [rw] recovery_point_arn
@@ -2984,7 +2975,7 @@ module Aws::Backup
2984
2975
  # @return [String]
2985
2976
  #
2986
2977
  # @!attribute [rw] backup_vault_account_id
2987
- # This is the account ID of the specified backup vault.
2978
+ # The account ID of the specified backup vault.
2988
2979
  # @return [String]
2989
2980
  #
2990
2981
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointInput AWS API Documentation
@@ -3005,21 +2996,20 @@ module Aws::Backup
3005
2996
  # @!attribute [rw] backup_vault_name
3006
2997
  # The name of a logical container where backups are stored. Backup
3007
2998
  # vaults are identified by names that are unique to the account used
3008
- # to create them and the Region where they are created. They consist
3009
- # of lowercase letters, numbers, and hyphens.
2999
+ # to create them and the Region where they are created.
3010
3000
  # @return [String]
3011
3001
  #
3012
3002
  # @!attribute [rw] backup_vault_arn
3013
3003
  # An ARN that uniquely identifies a backup vault; for example,
3014
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
3004
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3015
3005
  # @return [String]
3016
3006
  #
3017
3007
  # @!attribute [rw] source_backup_vault_arn
3018
3008
  # An Amazon Resource Name (ARN) that uniquely identifies the source
3019
3009
  # vault where the resource was originally backed up in; for example,
3020
- # `arn:aws:backup:us-east-1:123456789012:vault:BackupVault`. If the
3021
- # recovery is restored to the same Amazon Web Services account or
3022
- # Region, this value will be `null`.
3010
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3011
+ # If the recovery is restored to the same Amazon Web Services account
3012
+ # or Region, this value will be `null`.
3023
3013
  # @return [String]
3024
3014
  #
3025
3015
  # @!attribute [rw] resource_arn
@@ -3065,7 +3055,10 @@ module Aws::Backup
3065
3055
  # taken some action that causes the continuous backup to be disabled.
3066
3056
  # This can be caused by the removal of permissions, turning off
3067
3057
  # versioning, turning off events being sent to EventBridge, or
3068
- # disabling the EventBridge rules that are put in place by Backup.
3058
+ # disabling the EventBridge rules that are put in place by Backup. For
3059
+ # recovery points of Amazon S3, Amazon RDS, and Amazon Aurora
3060
+ # resources, this status occurs when the retention period of a
3061
+ # continuous backup rule is changed.
3069
3062
  #
3070
3063
  # To resolve `STOPPED` status, ensure that all requested permissions
3071
3064
  # are in place and that versioning is enabled on the S3 bucket. Once
@@ -3123,14 +3116,13 @@ module Aws::Backup
3123
3116
  # setting. The “transition to cold after days” setting cannot be
3124
3117
  # changed after a backup has been transitioned to cold.
3125
3118
  #
3126
- # Resource types that are able to be transitioned to cold storage are
3127
- # listed in the "Lifecycle to cold storage" section of the [ Feature
3128
- # availability by resource][1] table. Backup ignores this expression
3129
- # for other resource types.
3119
+ # Resource types that can transition to cold storage are listed in the
3120
+ # [Feature availability by resource][1] table. Backup ignores this
3121
+ # expression for other resource types.
3130
3122
  #
3131
3123
  #
3132
3124
  #
3133
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
3125
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
3134
3126
  # @return [Types::Lifecycle]
3135
3127
  #
3136
3128
  # @!attribute [rw] encryption_key_arn
@@ -3165,8 +3157,8 @@ module Aws::Backup
3165
3157
  # @return [String]
3166
3158
  #
3167
3159
  # @!attribute [rw] composite_member_identifier
3168
- # This is the identifier of a resource within a composite group, such
3169
- # as nested (child) recovery point belonging to a composite (parent)
3160
+ # The identifier of a resource within a composite group, such as
3161
+ # nested (child) recovery point belonging to a composite (parent)
3170
3162
  # stack. The ID is transferred from the [ logical ID][1] within a
3171
3163
  # stack.
3172
3164
  #
@@ -3181,13 +3173,11 @@ module Aws::Backup
3181
3173
  # @return [Boolean]
3182
3174
  #
3183
3175
  # @!attribute [rw] resource_name
3184
- # This is the non-unique name of the resource that belongs to the
3185
- # specified backup.
3176
+ # The name of the resource that belongs to the specified backup.
3186
3177
  # @return [String]
3187
3178
  #
3188
3179
  # @!attribute [rw] vault_type
3189
- # This is the type of vault in which the described recovery point is
3190
- # stored.
3180
+ # The type of vault in which the described recovery point is stored.
3191
3181
  # @return [String]
3192
3182
  #
3193
3183
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPointOutput AWS API Documentation
@@ -3228,19 +3218,18 @@ module Aws::Backup
3228
3218
  class DescribeRegionSettingsInput < Aws::EmptyStructure; end
3229
3219
 
3230
3220
  # @!attribute [rw] resource_type_opt_in_preference
3231
- # Returns a list of all services along with the opt-in preferences in
3232
- # the Region.
3221
+ # The services along with the opt-in preferences in the Region.
3233
3222
  # @return [Hash<String,Boolean>]
3234
3223
  #
3235
3224
  # @!attribute [rw] resource_type_management_preference
3236
3225
  # Returns whether Backup fully manages the backups for a resource
3237
3226
  # type.
3238
3227
  #
3239
- # For the benefits of full Backup management, see [ Full Backup
3228
+ # For the benefits of full Backup management, see [Full Backup
3240
3229
  # management][1].
3241
3230
  #
3242
3231
  # For a list of resource types and whether each supports full Backup
3243
- # management, see the [ Feature availability by resource][2] table.
3232
+ # management, see the [Feature availability by resource][2] table.
3244
3233
  #
3245
3234
  # If `"DynamoDB":false`, you can enable full Backup management for
3246
3235
  # DynamoDB backup by enabling [ Backup's advanced DynamoDB backup
@@ -3249,7 +3238,7 @@ module Aws::Backup
3249
3238
  #
3250
3239
  #
3251
3240
  # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management
3252
- # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
3241
+ # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
3253
3242
  # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli
3254
3243
  # @return [Hash<String,Boolean>]
3255
3244
  #
@@ -3277,8 +3266,8 @@ module Aws::Backup
3277
3266
  end
3278
3267
 
3279
3268
  # @!attribute [rw] report_job
3280
- # A list of information about a report job, including its completion
3281
- # and creation times, report destination, unique report job ID, Amazon
3269
+ # The information about a report job, including its completion and
3270
+ # creation times, report destination, unique report job ID, Amazon
3282
3271
  # Resource Name (ARN), report template, status, and status message.
3283
3272
  # @return [Types::ReportJob]
3284
3273
  #
@@ -3386,9 +3375,11 @@ module Aws::Backup
3386
3375
  # @return [Integer]
3387
3376
  #
3388
3377
  # @!attribute [rw] created_resource_arn
3389
- # An Amazon Resource Name (ARN) that uniquely identifies a resource
3390
- # whose recovery point is being restored. The format of the ARN
3391
- # depends on the resource type of the backed-up resource.
3378
+ # The Amazon Resource Name (ARN) of the resource that was created by
3379
+ # the restore job.
3380
+ #
3381
+ # The format of the ARN depends on the resource type of the backed-up
3382
+ # resource.
3392
3383
  # @return [String]
3393
3384
  #
3394
3385
  # @!attribute [rw] resource_type
@@ -3397,8 +3388,8 @@ module Aws::Backup
3397
3388
  # @return [String]
3398
3389
  #
3399
3390
  # @!attribute [rw] recovery_point_creation_date
3400
- # This is the creation date of the recovery point made by the specifed
3401
- # restore job.
3391
+ # The creation date of the recovery point made by the specifed restore
3392
+ # job.
3402
3393
  # @return [Time]
3403
3394
  #
3404
3395
  # @!attribute [rw] created_by
@@ -3407,17 +3398,15 @@ module Aws::Backup
3407
3398
  # @return [Types::RestoreJobCreator]
3408
3399
  #
3409
3400
  # @!attribute [rw] validation_status
3410
- # This is the status of validation run on the indicated restore job.
3401
+ # The status of validation run on the indicated restore job.
3411
3402
  # @return [String]
3412
3403
  #
3413
3404
  # @!attribute [rw] validation_status_message
3414
- # This describes the status of validation run on the indicated restore
3415
- # job.
3405
+ # The status message.
3416
3406
  # @return [String]
3417
3407
  #
3418
3408
  # @!attribute [rw] deletion_status
3419
- # This notes the status of the data generated by the restore test. The
3420
- # status may be `Deleting`, `Failed`, or `Successful`.
3409
+ # The status of the data generated by the restore test.
3421
3410
  # @return [String]
3422
3411
  #
3423
3412
  # @!attribute [rw] deletion_status_message
@@ -3451,16 +3440,15 @@ module Aws::Backup
3451
3440
  end
3452
3441
 
3453
3442
  # @!attribute [rw] backup_vault_name
3454
- # This is the name of a logical container where the child (nested)
3455
- # recovery point is stored. Backup vaults are identified by names that
3456
- # are unique to the account used to create them and the Amazon Web
3457
- # Services Region where they are created. They consist of lowercase
3458
- # letters, numbers, and hyphens.
3443
+ # The name of a logical container where the child (nested) recovery
3444
+ # point is stored. Backup vaults are identified by names that are
3445
+ # unique to the account used to create them and the Amazon Web
3446
+ # Services Region where they are created.
3459
3447
  # @return [String]
3460
3448
  #
3461
3449
  # @!attribute [rw] recovery_point_arn
3462
- # This is the Amazon Resource Name (ARN) that uniquely identifies the
3463
- # child (nested) recovery point; for example,
3450
+ # The Amazon Resource Name (ARN) that uniquely identifies the child
3451
+ # (nested) recovery point; for example,
3464
3452
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.`
3465
3453
  # @return [String]
3466
3454
  #
@@ -3579,7 +3567,7 @@ module Aws::Backup
3579
3567
  # @return [String]
3580
3568
  #
3581
3569
  # @!attribute [rw] control_input_parameters
3582
- # A list of `ParameterName` and `ParameterValue` pairs.
3570
+ # The name/value pairs.
3583
3571
  # @return [Array<Types::ControlInputParameter>]
3584
3572
  #
3585
3573
  # @!attribute [rw] control_scope
@@ -3714,11 +3702,11 @@ module Aws::Backup
3714
3702
  # @return [Time]
3715
3703
  #
3716
3704
  # @!attribute [rw] last_execution_date
3717
- # The last time a job to back up resources was run with this backup
3718
- # plan. A date and time, in Unix format and Coordinated Universal Time
3719
- # (UTC). The value of `LastExecutionDate` is accurate to milliseconds.
3720
- # For example, the value 1516925490.087 represents Friday, January 26,
3721
- # 2018 12:11:30.087 AM.
3705
+ # The last time this backup plan was run. A date and time, in Unix
3706
+ # format and Coordinated Universal Time (UTC). The value of
3707
+ # `LastExecutionDate` is accurate to milliseconds. For example, the
3708
+ # value 1516925490.087 represents Friday, January 26, 2018
3709
+ # 12:11:30.087 AM.
3722
3710
  # @return [Time]
3723
3711
  #
3724
3712
  # @!attribute [rw] advanced_backup_settings
@@ -3803,7 +3791,7 @@ module Aws::Backup
3803
3791
  # The name of a logical container where backups are stored. Backup
3804
3792
  # vaults are identified by names that are unique to the account used
3805
3793
  # to create them and the Amazon Web Services Region where they are
3806
- # created. They consist of lowercase letters, numbers, and hyphens.
3794
+ # created.
3807
3795
  # @return [String]
3808
3796
  #
3809
3797
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultAccessPolicyInput AWS API Documentation
@@ -3817,14 +3805,13 @@ module Aws::Backup
3817
3805
  # @!attribute [rw] backup_vault_name
3818
3806
  # The name of a logical container where backups are stored. Backup
3819
3807
  # vaults are identified by names that are unique to the account used
3820
- # to create them and the Region where they are created. They consist
3821
- # of lowercase letters, numbers, and hyphens.
3808
+ # to create them and the Region where they are created.
3822
3809
  # @return [String]
3823
3810
  #
3824
3811
  # @!attribute [rw] backup_vault_arn
3825
3812
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
3826
3813
  # vault; for example,
3827
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
3814
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3828
3815
  # @return [String]
3829
3816
  #
3830
3817
  # @!attribute [rw] policy
@@ -3845,7 +3832,7 @@ module Aws::Backup
3845
3832
  # The name of a logical container where backups are stored. Backup
3846
3833
  # vaults are identified by names that are unique to the account used
3847
3834
  # to create them and the Amazon Web Services Region where they are
3848
- # created. They consist of lowercase letters, numbers, and hyphens.
3835
+ # created.
3849
3836
  # @return [String]
3850
3837
  #
3851
3838
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotificationsInput AWS API Documentation
@@ -3859,14 +3846,13 @@ module Aws::Backup
3859
3846
  # @!attribute [rw] backup_vault_name
3860
3847
  # The name of a logical container where backups are stored. Backup
3861
3848
  # vaults are identified by names that are unique to the account used
3862
- # to create them and the Region where they are created. They consist
3863
- # of lowercase letters, numbers, and hyphens.
3849
+ # to create them and the Region where they are created.
3864
3850
  # @return [String]
3865
3851
  #
3866
3852
  # @!attribute [rw] backup_vault_arn
3867
3853
  # An Amazon Resource Name (ARN) that uniquely identifies a backup
3868
3854
  # vault; for example,
3869
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
3855
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3870
3856
  # @return [String]
3871
3857
  #
3872
3858
  # @!attribute [rw] sns_topic_arn
@@ -3892,8 +3878,7 @@ module Aws::Backup
3892
3878
  end
3893
3879
 
3894
3880
  # @!attribute [rw] legal_hold_id
3895
- # This is the ID required to use `GetLegalHold`. This unique ID is
3896
- # associated with a specific legal hold.
3881
+ # The ID of the legal hold.
3897
3882
  # @return [String]
3898
3883
  #
3899
3884
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetLegalHoldInput AWS API Documentation
@@ -3905,48 +3890,45 @@ module Aws::Backup
3905
3890
  end
3906
3891
 
3907
3892
  # @!attribute [rw] title
3908
- # This is the string title of the legal hold.
3893
+ # The title of the legal hold.
3909
3894
  # @return [String]
3910
3895
  #
3911
3896
  # @!attribute [rw] status
3912
- # This is the status of the legal hold. Statuses can be `ACTIVE`,
3913
- # `CREATING`, `CANCELED`, and `CANCELING`.
3897
+ # The status of the legal hold.
3914
3898
  # @return [String]
3915
3899
  #
3916
3900
  # @!attribute [rw] description
3917
- # This is the returned string description of the legal hold.
3901
+ # The description of the legal hold.
3918
3902
  # @return [String]
3919
3903
  #
3920
3904
  # @!attribute [rw] cancel_description
3921
- # String describing the reason for removing the legal hold.
3905
+ # The reason for removing the legal hold.
3922
3906
  # @return [String]
3923
3907
  #
3924
3908
  # @!attribute [rw] legal_hold_id
3925
- # This is the returned ID associated with a specified legal hold.
3909
+ # The ID of the legal hold.
3926
3910
  # @return [String]
3927
3911
  #
3928
3912
  # @!attribute [rw] legal_hold_arn
3929
- # This is the returned framework ARN for the specified legal hold. An
3930
- # Amazon Resource Name (ARN) uniquely identifies a resource. The
3931
- # format of the ARN depends on the resource type.
3913
+ # The framework ARN for the specified legal hold. The format of the
3914
+ # ARN depends on the resource type.
3932
3915
  # @return [String]
3933
3916
  #
3934
3917
  # @!attribute [rw] creation_date
3935
- # Time in number format when legal hold was created.
3918
+ # The time when the legal hold was created.
3936
3919
  # @return [Time]
3937
3920
  #
3938
3921
  # @!attribute [rw] cancellation_date
3939
- # Time in number when legal hold was cancelled.
3922
+ # The time when the legal hold was cancelled.
3940
3923
  # @return [Time]
3941
3924
  #
3942
3925
  # @!attribute [rw] retain_record_until
3943
- # This is the date and time until which the legal hold record will be
3944
- # retained.
3926
+ # The date and time until which the legal hold record is retained.
3945
3927
  # @return [Time]
3946
3928
  #
3947
3929
  # @!attribute [rw] recovery_point_selection
3948
- # This specifies criteria to assign a set of resources, such as
3949
- # resource types or backup vaults.
3930
+ # The criteria to assign a set of resources, such as resource types or
3931
+ # backup vaults.
3950
3932
  # @return [Types::RecoveryPointSelection]
3951
3933
  #
3952
3934
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetLegalHoldOutput AWS API Documentation
@@ -3970,7 +3952,7 @@ module Aws::Backup
3970
3952
  # The name of a logical container where backups are stored. Backup
3971
3953
  # vaults are identified by names that are unique to the account used
3972
3954
  # to create them and the Amazon Web Services Region where they are
3973
- # created. They consist of lowercase letters, numbers, and hyphens.
3955
+ # created.
3974
3956
  # @return [String]
3975
3957
  #
3976
3958
  # @!attribute [rw] recovery_point_arn
@@ -3980,7 +3962,7 @@ module Aws::Backup
3980
3962
  # @return [String]
3981
3963
  #
3982
3964
  # @!attribute [rw] backup_vault_account_id
3983
- # This is the account ID of the specified backup vault.
3965
+ # The account ID of the specified backup vault.
3984
3966
  # @return [String]
3985
3967
  #
3986
3968
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRecoveryPointRestoreMetadataInput AWS API Documentation
@@ -3995,7 +3977,7 @@ module Aws::Backup
3995
3977
 
3996
3978
  # @!attribute [rw] backup_vault_arn
3997
3979
  # An ARN that uniquely identifies a backup vault; for example,
3998
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
3980
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
3999
3981
  # @return [String]
4000
3982
  #
4001
3983
  # @!attribute [rw] recovery_point_arn
@@ -4010,7 +3992,7 @@ module Aws::Backup
4010
3992
  # @return [Hash<String,String>]
4011
3993
  #
4012
3994
  # @!attribute [rw] resource_type
4013
- # This is the resource type associated with the recovery point.
3995
+ # The resource type of the recovery point.
4014
3996
  # @return [String]
4015
3997
  #
4016
3998
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRecoveryPointRestoreMetadataOutput AWS API Documentation
@@ -4054,7 +4036,7 @@ module Aws::Backup
4054
4036
  end
4055
4037
 
4056
4038
  # @!attribute [rw] backup_vault_account_id
4057
- # This is the account ID of the specified backup vault.
4039
+ # The account ID of the specified backup vault.
4058
4040
  # @return [String]
4059
4041
  #
4060
4042
  # @!attribute [rw] backup_vault_name
@@ -4152,6 +4134,10 @@ module Aws::Backup
4152
4134
  #
4153
4135
  # * `Aurora` for Amazon Aurora
4154
4136
  #
4137
+ # * `CloudFormation` for CloudFormation
4138
+ #
4139
+ # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
4140
+ #
4155
4141
  # * `DynamoDB` for Amazon DynamoDB
4156
4142
  #
4157
4143
  # * `EBS` for Amazon Elastic Block Store
@@ -4160,15 +4146,24 @@ module Aws::Backup
4160
4146
  #
4161
4147
  # * `EFS` for Amazon Elastic File System
4162
4148
  #
4163
- # * `FSX` for Amazon FSx
4149
+ # * `FSx` for Amazon FSx
4150
+ #
4151
+ # * `Neptune` for Amazon Neptune
4164
4152
  #
4165
4153
  # * `RDS` for Amazon Relational Database Service
4166
4154
  #
4155
+ # * `Redshift` for Amazon Redshift
4156
+ #
4157
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
4158
+ #
4159
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
4160
+ # Compute Cloud instances
4161
+ #
4167
4162
  # * `Storage Gateway` for Storage Gateway
4168
4163
  #
4169
- # * `DocDB` for Amazon DocumentDB (with MongoDB compatibility)
4164
+ # * `Timestream` for Amazon Timestream
4170
4165
  #
4171
- # * `Neptune` for Amazon Neptune
4166
+ # * `VirtualMachine` for VMware virtual machines
4172
4167
  # @return [Array<String>]
4173
4168
  #
4174
4169
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetSupportedResourceTypesOutput AWS API Documentation
@@ -4298,34 +4293,32 @@ module Aws::Backup
4298
4293
  # by resource IDs.
4299
4294
  #
4300
4295
  # @!attribute [rw] title
4301
- # This is the title of a legal hold.
4296
+ # The title of a legal hold.
4302
4297
  # @return [String]
4303
4298
  #
4304
4299
  # @!attribute [rw] status
4305
- # This is the status of the legal hold. Statuses can be `ACTIVE`,
4306
- # `CREATING`, `CANCELED`, and `CANCELING`.
4300
+ # The status of the legal hold.
4307
4301
  # @return [String]
4308
4302
  #
4309
4303
  # @!attribute [rw] description
4310
- # This is the description of a legal hold.
4304
+ # The description of a legal hold.
4311
4305
  # @return [String]
4312
4306
  #
4313
4307
  # @!attribute [rw] legal_hold_id
4314
- # ID of specific legal hold on one or more recovery points.
4308
+ # The ID of the legal hold.
4315
4309
  # @return [String]
4316
4310
  #
4317
4311
  # @!attribute [rw] legal_hold_arn
4318
- # This is an Amazon Resource Number (ARN) that uniquely identifies the
4319
- # legal hold; for example,
4312
+ # The Amazon Resource Name (ARN) of the legal hold; for example,
4320
4313
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
4321
4314
  # @return [String]
4322
4315
  #
4323
4316
  # @!attribute [rw] creation_date
4324
- # This is the time in number format when legal hold was created.
4317
+ # The time when the legal hold was created.
4325
4318
  # @return [Time]
4326
4319
  #
4327
4320
  # @!attribute [rw] cancellation_date
4328
- # This is the time in number format when legal hold was cancelled.
4321
+ # The time when the legal hold was cancelled.
4329
4322
  # @return [Time]
4330
4323
  #
4331
4324
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/LegalHold AWS API Documentation
@@ -4342,39 +4335,42 @@ module Aws::Backup
4342
4335
  include Aws::Structure
4343
4336
  end
4344
4337
 
4345
- # Contains an array of `Transition` objects specifying how long in days
4346
- # before a recovery point transitions to cold storage or is deleted.
4338
+ # Specifies the time period, in days, before a recovery point
4339
+ # transitions to cold storage or is deleted.
4347
4340
  #
4348
4341
  # Backups transitioned to cold storage must be stored in cold storage
4349
- # for a minimum of 90 days. Therefore, on the console, the retention
4350
- # setting must be 90 days greater than the transition to cold after
4351
- # days” setting. The transition to cold after days setting cannot be
4352
- # changed after a backup has been transitioned to cold.
4342
+ # for a minimum of 90 days. Therefore, on the console, the retention
4343
+ # setting must be 90 days greater than the transition to cold after days
4344
+ # setting. The transition to cold after days setting can't be changed
4345
+ # after a backup has been transitioned to cold.
4346
+ #
4347
+ # Resource types that can transition to cold storage are listed in the
4348
+ # [Feature availability by resource][1] table. Backup ignores this
4349
+ # expression for other resource types.
4353
4350
  #
4354
- # Resource types that are able to be transitioned to cold storage are
4355
- # listed in the "Lifecycle to cold storage" section of the [ Feature
4356
- # availability by resource][1] table. Backup ignores this expression for
4357
- # other resource types.
4351
+ # To remove the existing lifecycle and retention periods and keep your
4352
+ # recovery points indefinitely, specify -1 for
4353
+ # `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
4358
4354
  #
4359
4355
  #
4360
4356
  #
4361
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
4357
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
4362
4358
  #
4363
4359
  # @!attribute [rw] move_to_cold_storage_after_days
4364
- # Specifies the number of days after creation that a recovery point is
4365
- # moved to cold storage.
4360
+ # The number of days after creation that a recovery point is moved to
4361
+ # cold storage.
4366
4362
  # @return [Integer]
4367
4363
  #
4368
4364
  # @!attribute [rw] delete_after_days
4369
- # Specifies the number of days after creation that a recovery point is
4370
- # deleted. Must be greater than 90 days plus
4371
- # `MoveToColdStorageAfterDays`.
4365
+ # The number of days after creation that a recovery point is deleted.
4366
+ # This value must be at least 90 days after the number of days
4367
+ # specified in `MoveToColdStorageAfterDays`.
4372
4368
  # @return [Integer]
4373
4369
  #
4374
4370
  # @!attribute [rw] opt_in_to_archive_for_supported_resources
4375
- # Optional Boolean. If this is true, this setting will instruct your
4376
- # backup plan to transition supported resources to archive (cold)
4377
- # storage tier in accordance with your lifecycle settings.
4371
+ # If the value is true, your backup plan transitions supported
4372
+ # resources to archive (cold) storage tier in accordance with your
4373
+ # lifecycle settings.
4378
4374
  # @return [Boolean]
4379
4375
  #
4380
4376
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/Lifecycle AWS API Documentation
@@ -4484,19 +4480,17 @@ module Aws::Backup
4484
4480
  # @return [String]
4485
4481
  #
4486
4482
  # @!attribute [rw] aggregation_period
4487
- # This is the period that sets the boundaries for returned results.
4488
- #
4489
- # Acceptable values include
4483
+ # The period for the returned results.
4490
4484
  #
4491
- # * `ONE_DAY` for daily job count for the prior 14 days.
4485
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
4492
4486
  #
4493
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
4487
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
4494
4488
  #
4495
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
4489
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
4496
4490
  # @return [String]
4497
4491
  #
4498
4492
  # @!attribute [rw] max_results
4499
- # This parameter sets the maximum number of items to be returned.
4493
+ # The maximum number of items to be returned.
4500
4494
  #
4501
4495
  # The value is an integer. Range of accepted values is from 1 to 500.
4502
4496
  # @return [Integer]
@@ -4523,19 +4517,17 @@ module Aws::Backup
4523
4517
  end
4524
4518
 
4525
4519
  # @!attribute [rw] backup_job_summaries
4526
- # This request returns a summary that contains Region, Account, State,
4527
- # ResourceType, MessageCategory, StartTime, EndTime, and Count of
4528
- # included jobs.
4520
+ # The summary information.
4529
4521
  # @return [Array<Types::BackupJobSummary>]
4530
4522
  #
4531
4523
  # @!attribute [rw] aggregation_period
4532
- # This is the period that sets the boundaries for returned results.
4524
+ # The period for the returned results.
4533
4525
  #
4534
- # * `ONE_DAY` for daily job count for the prior 14 days.
4526
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
4535
4527
  #
4536
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
4528
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
4537
4529
  #
4538
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
4530
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
4539
4531
  # @return [String]
4540
4532
  #
4541
4533
  # @!attribute [rw] next_token
@@ -4592,8 +4584,7 @@ module Aws::Backup
4592
4584
  # Returns only backup jobs that will be stored in the specified backup
4593
4585
  # vault. Backup vaults are identified by names that are unique to the
4594
4586
  # account used to create them and the Amazon Web Services Region where
4595
- # they are created. They consist of lowercase letters, numbers, and
4596
- # hyphens.
4587
+ # they are created.
4597
4588
  # @return [String]
4598
4589
  #
4599
4590
  # @!attribute [rw] by_created_before
@@ -4626,19 +4617,20 @@ module Aws::Backup
4626
4617
  #
4627
4618
  # * `Neptune` for Amazon Neptune
4628
4619
  #
4620
+ # * `RDS` for Amazon Relational Database Service
4621
+ #
4629
4622
  # * `Redshift` for Amazon Redshift
4630
4623
  #
4631
- # * `RDS` for Amazon Relational Database Service
4624
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
4632
4625
  #
4633
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
4626
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
4627
+ # Compute Cloud instances
4634
4628
  #
4635
4629
  # * `Storage Gateway` for Storage Gateway
4636
4630
  #
4637
- # * `S3` for Amazon S3
4638
- #
4639
4631
  # * `Timestream` for Amazon Timestream
4640
4632
  #
4641
- # * `VirtualMachine` for virtual machines
4633
+ # * `VirtualMachine` for VMware virtual machines
4642
4634
  # @return [String]
4643
4635
  #
4644
4636
  # @!attribute [rw] by_account_id
@@ -4731,7 +4723,7 @@ module Aws::Backup
4731
4723
  # @return [String]
4732
4724
  #
4733
4725
  # @!attribute [rw] max_results
4734
- # The maximum number of items to be returned.
4726
+ # The maximum number of items to return.
4735
4727
  # @return [Integer]
4736
4728
  #
4737
4729
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanTemplatesInput AWS API Documentation
@@ -4844,8 +4836,7 @@ module Aws::Backup
4844
4836
  # @return [String]
4845
4837
  #
4846
4838
  # @!attribute [rw] backup_plans_list
4847
- # An array of backup plan list items containing metadata about your
4848
- # saved backup plans.
4839
+ # Information about the backup plans.
4849
4840
  # @return [Array<Types::BackupPlansListMember>]
4850
4841
  #
4851
4842
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlansOutput AWS API Documentation
@@ -5014,13 +5005,13 @@ module Aws::Backup
5014
5005
  # @return [String]
5015
5006
  #
5016
5007
  # @!attribute [rw] aggregation_period
5017
- # This is the period that sets the boundaries for returned results.
5008
+ # The period for the returned results.
5018
5009
  #
5019
- # * `ONE_DAY` for daily job count for the prior 14 days.
5010
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
5020
5011
  #
5021
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
5012
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
5022
5013
  #
5023
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
5014
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
5024
5015
  # @return [String]
5025
5016
  #
5026
5017
  # @!attribute [rw] max_results
@@ -5057,13 +5048,13 @@ module Aws::Backup
5057
5048
  # @return [Array<Types::CopyJobSummary>]
5058
5049
  #
5059
5050
  # @!attribute [rw] aggregation_period
5060
- # This is the period that sets the boundaries for returned results.
5051
+ # The period for the returned results.
5061
5052
  #
5062
- # * `ONE_DAY` for daily job count for the prior 14 days.
5053
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
5063
5054
  #
5064
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
5055
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
5065
5056
  #
5066
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
5057
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
5067
5058
  # @return [String]
5068
5059
  #
5069
5060
  # @!attribute [rw] next_token
@@ -5132,25 +5123,26 @@ module Aws::Backup
5132
5123
  #
5133
5124
  # * `Neptune` for Amazon Neptune
5134
5125
  #
5126
+ # * `RDS` for Amazon Relational Database Service
5127
+ #
5135
5128
  # * `Redshift` for Amazon Redshift
5136
5129
  #
5137
- # * `RDS` for Amazon Relational Database Service
5130
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
5138
5131
  #
5139
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
5132
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
5133
+ # Compute Cloud instances
5140
5134
  #
5141
5135
  # * `Storage Gateway` for Storage Gateway
5142
5136
  #
5143
- # * `S3` for Amazon S3
5144
- #
5145
5137
  # * `Timestream` for Amazon Timestream
5146
5138
  #
5147
- # * `VirtualMachine` for virtual machines
5139
+ # * `VirtualMachine` for VMware virtual machines
5148
5140
  # @return [String]
5149
5141
  #
5150
5142
  # @!attribute [rw] by_destination_vault_arn
5151
5143
  # An Amazon Resource Name (ARN) that uniquely identifies a source
5152
5144
  # backup vault to copy from; for example,
5153
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
5145
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
5154
5146
  # @return [String]
5155
5147
  #
5156
5148
  # @!attribute [rw] by_account_id
@@ -5253,7 +5245,7 @@ module Aws::Backup
5253
5245
  end
5254
5246
 
5255
5247
  # @!attribute [rw] frameworks
5256
- # A list of frameworks with details for each framework, including the
5248
+ # The frameworks with details for each framework, including the
5257
5249
  # framework name, Amazon Resource Name (ARN), description, number of
5258
5250
  # controls, creation time, and deployment status.
5259
5251
  # @return [Array<Types::Framework>]
@@ -5314,13 +5306,13 @@ module Aws::Backup
5314
5306
  end
5315
5307
 
5316
5308
  # @!attribute [rw] backup_vault_name
5317
- # This is the list of protected resources by backup vault within the
5318
- # vault(s) you specify by name.
5309
+ # The list of protected resources by backup vault within the vault(s)
5310
+ # you specify by name.
5319
5311
  # @return [String]
5320
5312
  #
5321
5313
  # @!attribute [rw] backup_vault_account_id
5322
- # This is the list of protected resources by backup vault within the
5323
- # vault(s) you specify by account ID.
5314
+ # The list of protected resources by backup vault within the vault(s)
5315
+ # you specify by account ID.
5324
5316
  # @return [String]
5325
5317
  #
5326
5318
  # @!attribute [rw] next_token
@@ -5412,7 +5404,7 @@ module Aws::Backup
5412
5404
  # The name of a logical container where backups are stored. Backup
5413
5405
  # vaults are identified by names that are unique to the account used
5414
5406
  # to create them and the Amazon Web Services Region where they are
5415
- # created. They consist of lowercase letters, numbers, and hyphens.
5407
+ # created.
5416
5408
  #
5417
5409
  # <note markdown="1"> Backup vault name might not be available when a supported service
5418
5410
  # creates the backup.
@@ -5462,19 +5454,20 @@ module Aws::Backup
5462
5454
  #
5463
5455
  # * `Neptune` for Amazon Neptune
5464
5456
  #
5457
+ # * `RDS` for Amazon Relational Database Service
5458
+ #
5465
5459
  # * `Redshift` for Amazon Redshift
5466
5460
  #
5467
- # * `RDS` for Amazon Relational Database Service
5461
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
5468
5462
  #
5469
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
5463
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
5464
+ # Compute Cloud instances
5470
5465
  #
5471
5466
  # * `Storage Gateway` for Storage Gateway
5472
5467
  #
5473
- # * `S3` for Amazon S3
5474
- #
5475
5468
  # * `Timestream` for Amazon Timestream
5476
5469
  #
5477
- # * `VirtualMachine` for virtual machines
5470
+ # * `VirtualMachine` for VMware virtual machines
5478
5471
  # @return [String]
5479
5472
  #
5480
5473
  # @!attribute [rw] by_backup_plan_id
@@ -5536,18 +5529,18 @@ module Aws::Backup
5536
5529
  end
5537
5530
 
5538
5531
  # @!attribute [rw] legal_hold_id
5539
- # This is the ID of the legal hold.
5532
+ # The ID of the legal hold.
5540
5533
  # @return [String]
5541
5534
  #
5542
5535
  # @!attribute [rw] next_token
5543
- # This is the next item following a partial list of returned
5544
- # resources. For example, if a request is made to return `MaxResults`
5545
- # number of resources, `NextToken` allows you to return more items in
5546
- # your list starting at the location pointed to by the next token.
5536
+ # The next item following a partial list of returned resources. For
5537
+ # example, if a request is made to return `MaxResults` number of
5538
+ # resources, `NextToken` allows you to return more items in your list
5539
+ # starting at the location pointed to by the next token.
5547
5540
  # @return [String]
5548
5541
  #
5549
5542
  # @!attribute [rw] max_results
5550
- # This is the maximum number of resource list items to be returned.
5543
+ # The maximum number of resource list items to be returned.
5551
5544
  # @return [Integer]
5552
5545
  #
5553
5546
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHoldInput AWS API Documentation
@@ -5561,13 +5554,11 @@ module Aws::Backup
5561
5554
  end
5562
5555
 
5563
5556
  # @!attribute [rw] recovery_points
5564
- # This is a list of the recovery points returned by
5565
- # `ListRecoveryPointsByLegalHold`.
5557
+ # The recovery points.
5566
5558
  # @return [Array<Types::RecoveryPointMember>]
5567
5559
  #
5568
5560
  # @!attribute [rw] next_token
5569
- # This return is the next item following a partial list of returned
5570
- # resources.
5561
+ # The next item following a partial list of returned resources.
5571
5562
  # @return [String]
5572
5563
  #
5573
5564
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByLegalHoldOutput AWS API Documentation
@@ -5737,11 +5728,11 @@ module Aws::Backup
5737
5728
  end
5738
5729
 
5739
5730
  # @!attribute [rw] report_plans
5740
- # A list of your report plans with detailed information for each plan.
5741
- # This information includes the Amazon Resource Name (ARN), report
5742
- # plan name, description, settings, delivery channel, deployment
5743
- # status, creation time, and last times the report plan attempted to
5744
- # and successfully ran.
5731
+ # The report plans with detailed information for each plan. This
5732
+ # information includes the Amazon Resource Name (ARN), report plan
5733
+ # name, description, settings, delivery channel, deployment status,
5734
+ # creation time, and last times the report plan attempted to and
5735
+ # successfully ran.
5745
5736
  # @return [Array<Types::ReportPlan>]
5746
5737
  #
5747
5738
  # @!attribute [rw] next_token
@@ -5799,15 +5790,13 @@ module Aws::Backup
5799
5790
  # @return [String]
5800
5791
  #
5801
5792
  # @!attribute [rw] aggregation_period
5802
- # This is the period that sets the boundaries for returned results.
5793
+ # The period for the returned results.
5803
5794
  #
5804
- # Acceptable values include
5795
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
5805
5796
  #
5806
- # * `ONE_DAY` for daily job count for the prior 14 days.
5797
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
5807
5798
  #
5808
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
5809
- #
5810
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
5799
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
5811
5800
  # @return [String]
5812
5801
  #
5813
5802
  # @!attribute [rw] max_results
@@ -5843,13 +5832,13 @@ module Aws::Backup
5843
5832
  # @return [Array<Types::RestoreJobSummary>]
5844
5833
  #
5845
5834
  # @!attribute [rw] aggregation_period
5846
- # This is the period that sets the boundaries for returned results.
5835
+ # The period for the returned results.
5847
5836
  #
5848
- # * `ONE_DAY` for daily job count for the prior 14 days.
5837
+ # * `ONE_DAY` - The daily job count for the prior 14 days.
5849
5838
  #
5850
- # * `SEVEN_DAYS` for the aggregated job count for the prior 7 days.
5839
+ # * `SEVEN_DAYS` - The aggregated job count for the prior 7 days.
5851
5840
  #
5852
- # * `FOURTEEN_DAYS` for aggregated job count for prior 14 days.
5841
+ # * `FOURTEEN_DAYS` - The aggregated job count for prior 14 days.
5853
5842
  # @return [String]
5854
5843
  #
5855
5844
  # @!attribute [rw] next_token
@@ -5971,19 +5960,20 @@ module Aws::Backup
5971
5960
  #
5972
5961
  # * `Neptune` for Amazon Neptune
5973
5962
  #
5963
+ # * `RDS` for Amazon Relational Database Service
5964
+ #
5974
5965
  # * `Redshift` for Amazon Redshift
5975
5966
  #
5976
- # * `RDS` for Amazon Relational Database Service
5967
+ # * `S3` for Amazon Simple Storage Service (Amazon S3)
5977
5968
  #
5978
- # * `SAP HANA on Amazon EC2` for SAP HANA databases
5969
+ # * `SAP HANA on Amazon EC2` for SAP HANA databases on Amazon Elastic
5970
+ # Compute Cloud instances
5979
5971
  #
5980
5972
  # * `Storage Gateway` for Storage Gateway
5981
5973
  #
5982
- # * `S3` for Amazon S3
5983
- #
5984
5974
  # * `Timestream` for Amazon Timestream
5985
5975
  #
5986
- # * `VirtualMachine` for virtual machines
5976
+ # * `VirtualMachine` for VMware virtual machines
5987
5977
  # @return [String]
5988
5978
  #
5989
5979
  # @!attribute [rw] by_created_before
@@ -6175,8 +6165,7 @@ module Aws::Backup
6175
6165
  # @return [String]
6176
6166
  #
6177
6167
  # @!attribute [rw] tags
6178
- # To help organize your resources, you can assign your own metadata to
6179
- # the resources you create. Each tag is a key-value pair.
6168
+ # Information about the tags.
6180
6169
  # @return [Hash<String,String>]
6181
6170
  #
6182
6171
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTagsOutput AWS API Documentation
@@ -6236,18 +6225,17 @@ module Aws::Backup
6236
6225
  # @return [Time]
6237
6226
  #
6238
6227
  # @!attribute [rw] resource_name
6239
- # This is the non-unique name of the resource that belongs to the
6240
- # specified backup.
6228
+ # The non-unique name of the resource that belongs to the specified
6229
+ # backup.
6241
6230
  # @return [String]
6242
6231
  #
6243
6232
  # @!attribute [rw] last_backup_vault_arn
6244
- # This is the ARN (Amazon Resource Name) of the backup vault that
6245
- # contains the most recent backup recovery point.
6233
+ # The ARN (Amazon Resource Name) of the backup vault that contains the
6234
+ # most recent backup recovery point.
6246
6235
  # @return [String]
6247
6236
  #
6248
6237
  # @!attribute [rw] last_recovery_point_arn
6249
- # This is the ARN (Amazon Resource Name) of the most recent recovery
6250
- # point.
6238
+ # The ARN (Amazon Resource Name) of the most recent recovery point.
6251
6239
  # @return [String]
6252
6240
  #
6253
6241
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ProtectedResource AWS API Documentation
@@ -6263,12 +6251,8 @@ module Aws::Backup
6263
6251
  include Aws::Structure
6264
6252
  end
6265
6253
 
6266
- # A list of conditions that you define for resources in your restore
6267
- # testing plan using tags.
6268
- #
6269
- # For example, `"StringEquals": \{ "Key":
6270
- # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition
6271
- # operators are case sensitive.
6254
+ # The conditions that you define for resources in your restore testing
6255
+ # plan using tags.
6272
6256
  #
6273
6257
  # @!attribute [rw] string_equals
6274
6258
  # Filters the values of your tagged resources for only those resources
@@ -6294,7 +6278,7 @@ module Aws::Backup
6294
6278
  # The name of a logical container where backups are stored. Backup
6295
6279
  # vaults are identified by names that are unique to the account used
6296
6280
  # to create them and the Amazon Web Services Region where they are
6297
- # created. They consist of lowercase letters, numbers, and hyphens.
6281
+ # created.
6298
6282
  # @return [String]
6299
6283
  #
6300
6284
  # @!attribute [rw] policy
@@ -6322,8 +6306,10 @@ module Aws::Backup
6322
6306
  # require you to retain certain data for at least seven years (2555
6323
6307
  # days).
6324
6308
  #
6325
- # If this parameter is not specified, Vault Lock will not enforce a
6326
- # minimum retention period.
6309
+ # This parameter is required when a vault lock is created through
6310
+ # CloudFormation; otherwise, this parameter is optional. If this
6311
+ # parameter is not specified, Vault Lock will not enforce a minimum
6312
+ # retention period.
6327
6313
  #
6328
6314
  # If this parameter is specified, any backup or copy job to the vault
6329
6315
  # must have a lifecycle policy with a retention period equal to or
@@ -6395,7 +6381,7 @@ module Aws::Backup
6395
6381
  # The name of a logical container where backups are stored. Backup
6396
6382
  # vaults are identified by names that are unique to the account used
6397
6383
  # to create them and the Amazon Web Services Region where they are
6398
- # created. They consist of lowercase letters, numbers, and hyphens.
6384
+ # created.
6399
6385
  # @return [String]
6400
6386
  #
6401
6387
  # @!attribute [rw] sns_topic_arn
@@ -6422,10 +6408,10 @@ module Aws::Backup
6422
6408
  #
6423
6409
  # * `S3_BACKUP_OBJECT_FAILED` \| `S3_RESTORE_OBJECT_FAILED`
6424
6410
  #
6425
- # <note markdown="1"> The list below shows items that are deprecated events (for
6426
- # reference) and are no longer in use. They are no longer supported
6427
- # and will not return statuses or notifications. Refer to the list
6428
- # above for current supported events.
6411
+ # <note markdown="1"> The list below includes both supported events and deprecated events
6412
+ # that are no longer in use (for reference). Deprecated events do not
6413
+ # return statuses or notifications. Refer to the list above for the
6414
+ # supported events.
6429
6415
  #
6430
6416
  # </note>
6431
6417
  #
@@ -6449,7 +6435,7 @@ module Aws::Backup
6449
6435
  # @return [String]
6450
6436
  #
6451
6437
  # @!attribute [rw] validation_status
6452
- # This is the status of your restore validation.
6438
+ # The status of your restore validation.
6453
6439
  # @return [String]
6454
6440
  #
6455
6441
  # @!attribute [rw] validation_status_message
@@ -6480,12 +6466,12 @@ module Aws::Backup
6480
6466
  # The name of a logical container where backups are stored. Backup
6481
6467
  # vaults are identified by names that are unique to the account used
6482
6468
  # to create them and the Amazon Web Services Region where they are
6483
- # created. They consist of lowercase letters, numbers, and hyphens.
6469
+ # created.
6484
6470
  # @return [String]
6485
6471
  #
6486
6472
  # @!attribute [rw] backup_vault_arn
6487
6473
  # An ARN that uniquely identifies a backup vault; for example,
6488
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
6474
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
6489
6475
  # @return [String]
6490
6476
  #
6491
6477
  # @!attribute [rw] source_backup_vault_arn
@@ -6524,8 +6510,7 @@ module Aws::Backup
6524
6510
  # @return [String]
6525
6511
  #
6526
6512
  # @!attribute [rw] status_message
6527
- # A message explaining the reason of the recovery point deletion
6528
- # failure.
6513
+ # A message explaining the current status of the recovery point.
6529
6514
  # @return [String]
6530
6515
  #
6531
6516
  # @!attribute [rw] creation_date
@@ -6562,14 +6547,13 @@ module Aws::Backup
6562
6547
  # The “transition to cold after days” setting cannot be changed after
6563
6548
  # a backup has been transitioned to cold.
6564
6549
  #
6565
- # Resource types that are able to be transitioned to cold storage are
6566
- # listed in the "Lifecycle to cold storage" section of the [ Feature
6567
- # availability by resource][1] table. Backup ignores this expression
6568
- # for other resource types.
6550
+ # Resource types that can transition to cold storage are listed in the
6551
+ # [Feature availability by resource][1] table. Backup ignores this
6552
+ # expression for other resource types.
6569
6553
  #
6570
6554
  #
6571
6555
  #
6572
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
6556
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
6573
6557
  # @return [Types::Lifecycle]
6574
6558
  #
6575
6559
  # @!attribute [rw] encryption_key_arn
@@ -6592,13 +6576,13 @@ module Aws::Backup
6592
6576
  # @return [Time]
6593
6577
  #
6594
6578
  # @!attribute [rw] parent_recovery_point_arn
6595
- # This is the Amazon Resource Name (ARN) of the parent (composite)
6596
- # recovery point.
6579
+ # The Amazon Resource Name (ARN) of the parent (composite) recovery
6580
+ # point.
6597
6581
  # @return [String]
6598
6582
  #
6599
6583
  # @!attribute [rw] composite_member_identifier
6600
- # This is the identifier of a resource within a composite group, such
6601
- # as nested (child) recovery point belonging to a composite (parent)
6584
+ # The identifier of a resource within a composite group, such as
6585
+ # nested (child) recovery point belonging to a composite (parent)
6602
6586
  # stack. The ID is transferred from the [ logical ID][1] within a
6603
6587
  # stack.
6604
6588
  #
@@ -6613,13 +6597,12 @@ module Aws::Backup
6613
6597
  # @return [Boolean]
6614
6598
  #
6615
6599
  # @!attribute [rw] resource_name
6616
- # This is the non-unique name of the resource that belongs to the
6617
- # specified backup.
6600
+ # The non-unique name of the resource that belongs to the specified
6601
+ # backup.
6618
6602
  # @return [String]
6619
6603
  #
6620
6604
  # @!attribute [rw] vault_type
6621
- # This is the type of vault in which the described recovery point is
6622
- # stored.
6605
+ # The type of vault in which the described recovery point is stored.
6623
6606
  # @return [String]
6624
6607
  #
6625
6608
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByBackupVault AWS API Documentation
@@ -6672,8 +6655,7 @@ module Aws::Backup
6672
6655
  # @return [String]
6673
6656
  #
6674
6657
  # @!attribute [rw] status_message
6675
- # A message explaining the reason of the recovery point deletion
6676
- # failure.
6658
+ # A message explaining the current status of the recovery point.
6677
6659
  # @return [String]
6678
6660
  #
6679
6661
  # @!attribute [rw] encryption_key_arn
@@ -6690,7 +6672,7 @@ module Aws::Backup
6690
6672
  # The name of a logical container where backups are stored. Backup
6691
6673
  # vaults are identified by names that are unique to the account used
6692
6674
  # to create them and the Amazon Web Services Region where they are
6693
- # created. They consist of lowercase letters, numbers, and hyphens.
6675
+ # created.
6694
6676
  # @return [String]
6695
6677
  #
6696
6678
  # @!attribute [rw] is_parent
@@ -6699,18 +6681,17 @@ module Aws::Backup
6699
6681
  # @return [Boolean]
6700
6682
  #
6701
6683
  # @!attribute [rw] parent_recovery_point_arn
6702
- # This is the Amazon Resource Name (ARN) of the parent (composite)
6703
- # recovery point.
6684
+ # The Amazon Resource Name (ARN) of the parent (composite) recovery
6685
+ # point.
6704
6686
  # @return [String]
6705
6687
  #
6706
6688
  # @!attribute [rw] resource_name
6707
- # This is the non-unique name of the resource that belongs to the
6708
- # specified backup.
6689
+ # The non-unique name of the resource that belongs to the specified
6690
+ # backup.
6709
6691
  # @return [String]
6710
6692
  #
6711
6693
  # @!attribute [rw] vault_type
6712
- # This is the type of vault in which the described recovery point is
6713
- # stored.
6694
+ # The type of vault in which the described recovery point is stored.
6714
6695
  # @return [String]
6715
6696
  #
6716
6697
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointByResource AWS API Documentation
@@ -6771,23 +6752,23 @@ module Aws::Backup
6771
6752
  # case they will no longer be a member.
6772
6753
  #
6773
6754
  # @!attribute [rw] recovery_point_arn
6774
- # This is the Amazon Resource Name (ARN) of the parent (composite)
6775
- # recovery point.
6755
+ # The Amazon Resource Name (ARN) of the parent (composite) recovery
6756
+ # point.
6776
6757
  # @return [String]
6777
6758
  #
6778
6759
  # @!attribute [rw] resource_arn
6779
- # This is the Amazon Resource Name (ARN) that uniquely identifies a
6780
- # saved resource.
6760
+ # The Amazon Resource Name (ARN) that uniquely identifies a saved
6761
+ # resource.
6781
6762
  # @return [String]
6782
6763
  #
6783
6764
  # @!attribute [rw] resource_type
6784
- # This is the Amazon Web Services resource type that is saved as a
6785
- # recovery point.
6765
+ # The Amazon Web Services resource type that is saved as a recovery
6766
+ # point.
6786
6767
  # @return [String]
6787
6768
  #
6788
6769
  # @!attribute [rw] backup_vault_name
6789
- # This is the name of the backup vault (the logical container in which
6790
- # backups are stored).
6770
+ # The name of the backup vault (the logical container in which backups
6771
+ # are stored).
6791
6772
  # @return [String]
6792
6773
  #
6793
6774
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RecoveryPointMember AWS API Documentation
@@ -6851,7 +6832,7 @@ module Aws::Backup
6851
6832
  # @return [String]
6852
6833
  #
6853
6834
  # @!attribute [rw] formats
6854
- # A list of the format of your reports: `CSV`, `JSON`, or both. If not
6835
+ # The format of your reports: `CSV`, `JSON`, or both. If not
6855
6836
  # specified, the default format is `CSV`.
6856
6837
  # @return [Array<String>]
6857
6838
  #
@@ -7059,6 +7040,8 @@ module Aws::Backup
7059
7040
  #
7060
7041
  # @!attribute [rw] accounts
7061
7042
  # These are the accounts to be included in the report.
7043
+ #
7044
+ # Use string value of `ROOT` to include all organizational units.
7062
7045
  # @return [Array<String>]
7063
7046
  #
7064
7047
  # @!attribute [rw] organization_units
@@ -7067,6 +7050,8 @@ module Aws::Backup
7067
7050
  #
7068
7051
  # @!attribute [rw] regions
7069
7052
  # These are the Regions to be included in the report.
7053
+ #
7054
+ # Use the wildcard as the string value to include all Regions.
7070
7055
  # @return [Array<String>]
7071
7056
  #
7072
7057
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ReportSetting AWS API Documentation
@@ -7231,8 +7216,8 @@ module Aws::Backup
7231
7216
  # @return [Integer]
7232
7217
  #
7233
7218
  # @!attribute [rw] iam_role_arn
7234
- # Specifies the IAM role ARN used to create the target recovery point;
7235
- # for example, `arn:aws:iam::123456789012:role/S3Access`.
7219
+ # The IAM role ARN used to create the target recovery point; for
7220
+ # example, `arn:aws:iam::123456789012:role/S3Access`.
7236
7221
  # @return [String]
7237
7222
  #
7238
7223
  # @!attribute [rw] expected_completion_time_minutes
@@ -7263,7 +7248,7 @@ module Aws::Backup
7263
7248
  # @return [Types::RestoreJobCreator]
7264
7249
  #
7265
7250
  # @!attribute [rw] validation_status
7266
- # This is the status of validation run on the indicated restore job.
7251
+ # The status of validation run on the indicated restore job.
7267
7252
  # @return [String]
7268
7253
  #
7269
7254
  # @!attribute [rw] validation_status_message
@@ -7309,10 +7294,35 @@ module Aws::Backup
7309
7294
  # This contains metadata about a restore testing plan.
7310
7295
  #
7311
7296
  # @!attribute [rw] recovery_point_selection
7312
- # Required: Algorithm; Required: Recovery point types; IncludeVaults
7313
- # (one or more). Optional: SelectionWindowDays ('30' if not
7314
- # specified); ExcludeVaults (list of selectors), defaults to empty
7315
- # list if not listed.
7297
+ # `RecoveryPointSelection` has five parameters (three required and two
7298
+ # optional). The values you specify determine which recovery point is
7299
+ # included in the restore test. You must indicate with `Algorithm` if
7300
+ # you want the latest recovery point within your `SelectionWindowDays`
7301
+ # or if you want a random recovery point, and you must indicate
7302
+ # through `IncludeVaults` from which vaults the recovery points can be
7303
+ # chosen.
7304
+ #
7305
+ # `Algorithm` (*required*) Valid values: "`LATEST_WITHIN_WINDOW`" or
7306
+ # "`RANDOM_WITHIN_WINDOW`".
7307
+ #
7308
+ # `Recovery point types` (*required*) Valid values: "`SNAPSHOT`"
7309
+ # and/or "`CONTINUOUS`". Include `SNAPSHOT` to restore only snapshot
7310
+ # recovery points; include `CONTINUOUS` to restore continuous recovery
7311
+ # points (point in time restore / PITR); use both to restore either a
7312
+ # snapshot or a continuous recovery point. The recovery point will be
7313
+ # determined by the value for `Algorithm`.
7314
+ #
7315
+ # `IncludeVaults` (*required*). You must include one or more backup
7316
+ # vaults. Use the wildcard \["*"\] or specific ARNs.
7317
+ #
7318
+ # `SelectionWindowDays` (*optional*) Value must be an integer (in
7319
+ # days) from 1 to 365. If not included, the value defaults to `30`.
7320
+ #
7321
+ # `ExcludeVaults` (*optional*). You can choose to input one or more
7322
+ # specific backup vault ARNs to exclude those vaults' contents from
7323
+ # restore eligibility. Or, you can include a list of selectors. If
7324
+ # this parameter and its value are not included, it defaults to empty
7325
+ # list.
7316
7326
  # @return [Types::RestoreTestingRecoveryPointSelection]
7317
7327
  #
7318
7328
  # @!attribute [rw] restore_testing_plan_name
@@ -7399,7 +7409,7 @@ module Aws::Backup
7399
7409
  # @return [String]
7400
7410
  #
7401
7411
  # @!attribute [rw] restore_testing_plan_name
7402
- # This is the restore testing plan name.
7412
+ # The restore testing plan name.
7403
7413
  # @return [String]
7404
7414
  #
7405
7415
  # @!attribute [rw] schedule_expression
@@ -7470,7 +7480,7 @@ module Aws::Backup
7470
7480
  # @return [String]
7471
7481
  #
7472
7482
  # @!attribute [rw] restore_testing_plan_name
7473
- # This is the restore testing plan name.
7483
+ # The restore testing plan name.
7474
7484
  # @return [String]
7475
7485
  #
7476
7486
  # @!attribute [rw] schedule_expression
@@ -7549,10 +7559,33 @@ module Aws::Backup
7549
7559
  include Aws::Structure
7550
7560
  end
7551
7561
 
7552
- # Required: Algorithm; Required: Recovery point types; IncludeVaults(one
7553
- # or more). Optional: SelectionWindowDays ('30' if not
7554
- # specified);ExcludeVaults (list of selectors), defaults to empty list
7555
- # if not listed.
7562
+ # `RecoveryPointSelection` has five parameters (three required and two
7563
+ # optional). The values you specify determine which recovery point is
7564
+ # included in the restore test. You must indicate with `Algorithm` if
7565
+ # you want the latest recovery point within your `SelectionWindowDays`
7566
+ # or if you want a random recovery point, and you must indicate through
7567
+ # `IncludeVaults` from which vaults the recovery points can be chosen.
7568
+ #
7569
+ # `Algorithm` (*required*) Valid values: "`LATEST_WITHIN_WINDOW`" or
7570
+ # "`RANDOM_WITHIN_WINDOW`".
7571
+ #
7572
+ # `Recovery point types` (*required*) Valid values: "`SNAPSHOT`"
7573
+ # and/or "`CONTINUOUS`". Include `SNAPSHOT` to restore only snapshot
7574
+ # recovery points; include `CONTINUOUS` to restore continuous recovery
7575
+ # points (point in time restore / PITR); use both to restore either a
7576
+ # snapshot or a continuous recovery point. The recovery point will be
7577
+ # determined by the value for `Algorithm`.
7578
+ #
7579
+ # `IncludeVaults` (*required*). You must include one or more backup
7580
+ # vaults. Use the wildcard \["*"\] or specific ARNs.
7581
+ #
7582
+ # `SelectionWindowDays` (*optional*) Value must be an integer (in days)
7583
+ # from 1 to 365. If not included, the value defaults to `30`.
7584
+ #
7585
+ # `ExcludeVaults` (*optional*). You can choose to input one or more
7586
+ # specific backup vault ARNs to exclude those vaults' contents from
7587
+ # restore eligibility. Or, you can include a list of selectors. If this
7588
+ # parameter and its value are not included, it defaults to empty list.
7556
7589
  #
7557
7590
  # @!attribute [rw] algorithm
7558
7591
  # Acceptable values include "LATEST\_WITHIN\_WINDOW" or
@@ -7573,6 +7606,12 @@ module Aws::Backup
7573
7606
  #
7574
7607
  # @!attribute [rw] recovery_point_types
7575
7608
  # These are the types of recovery points.
7609
+ #
7610
+ # Include `SNAPSHOT` to restore only snapshot recovery points; include
7611
+ # `CONTINUOUS` to restore continuous recovery points (point in time
7612
+ # restore / PITR); use both to restore either a snapshot or a
7613
+ # continuous recovery point. The recovery point will be determined by
7614
+ # the value for `Algorithm`.
7576
7615
  # @return [Array<String>]
7577
7616
  #
7578
7617
  # @!attribute [rw] selection_window_days
@@ -7671,8 +7710,8 @@ module Aws::Backup
7671
7710
  # @return [Hash<String,String>]
7672
7711
  #
7673
7712
  # @!attribute [rw] restore_testing_selection_name
7674
- # This is the unique name of the restore testing selection that
7675
- # belongs to the related restore testing plan.
7713
+ # The unique name of the restore testing selection that belongs to the
7714
+ # related restore testing plan.
7676
7715
  # @return [String]
7677
7716
  #
7678
7717
  # @!attribute [rw] validation_window_hours
@@ -7756,8 +7795,8 @@ module Aws::Backup
7756
7795
  # @return [String]
7757
7796
  #
7758
7797
  # @!attribute [rw] restore_testing_selection_name
7759
- # This is the unique name of the restore testing selection that
7760
- # belongs to the related restore testing plan.
7798
+ # The unique name of the restore testing selection that belongs to the
7799
+ # related restore testing plan.
7761
7800
  # @return [String]
7762
7801
  #
7763
7802
  # @!attribute [rw] validation_window_hours
@@ -7787,11 +7826,10 @@ module Aws::Backup
7787
7826
  # This contains metadata about a restore testing selection.
7788
7827
  #
7789
7828
  # @!attribute [rw] creation_time
7790
- # This is the date and time that a restore testing selection was
7791
- # created, in Unix format and Coordinated Universal Time (UTC). The
7792
- # value of `CreationTime` is accurate to milliseconds. For example,
7793
- # the value 1516925490.087 represents Friday, January 26,2018
7794
- # 12:11:30.087 AM.
7829
+ # The date and time that a restore testing selection was created, in
7830
+ # Unix format and Coordinated Universal Time (UTC). The value of
7831
+ # `CreationTime` is accurate to milliseconds. For example, the value
7832
+ # 1516925490.087 represents Friday, January 26,2018 12:11:30.087 AM.
7795
7833
  # @return [Time]
7796
7834
  #
7797
7835
  # @!attribute [rw] iam_role_arn
@@ -7853,12 +7891,8 @@ module Aws::Backup
7853
7891
  # @return [Array<String>]
7854
7892
  #
7855
7893
  # @!attribute [rw] protected_resource_conditions
7856
- # A list of conditions that you define for resources in your restore
7857
- # testing plan using tags.
7858
- #
7859
- # For example, `"StringEquals": \{ "Key":
7860
- # "aws:ResourceTag/CreatedByCryo", "Value": "true" \},`. Condition
7861
- # operators are case sensitive.
7894
+ # The conditions that you define for resources in your restore testing
7895
+ # plan using tags.
7862
7896
  # @return [Types::ProtectedResourceConditions]
7863
7897
  #
7864
7898
  # @!attribute [rw] restore_metadata_overrides
@@ -7922,7 +7956,7 @@ module Aws::Backup
7922
7956
  # The name of a logical container where backups are stored. Backup
7923
7957
  # vaults are identified by names that are unique to the account used
7924
7958
  # to create them and the Amazon Web Services Region where they are
7925
- # created. They consist of lowercase letters, numbers, and hyphens.
7959
+ # created.
7926
7960
  # @return [String]
7927
7961
  #
7928
7962
  # @!attribute [rw] resource_arn
@@ -7983,27 +8017,24 @@ module Aws::Backup
7983
8017
  # The “transition to cold after days” setting cannot be changed after
7984
8018
  # a backup has been transitioned to cold.
7985
8019
  #
7986
- # Resource types that are able to be transitioned to cold storage are
7987
- # listed in the "Lifecycle to cold storage" section of the [ Feature
7988
- # availability by resource][1] table. Backup ignores this expression
7989
- # for other resource types.
8020
+ # Resource types that can transition to cold storage are listed in the
8021
+ # [Feature availability by resource][1] table. Backup ignores this
8022
+ # expression for other resource types.
7990
8023
  #
7991
8024
  # This parameter has a maximum value of 100 years (36,500 days).
7992
8025
  #
7993
8026
  #
7994
8027
  #
7995
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
8028
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
7996
8029
  # @return [Types::Lifecycle]
7997
8030
  #
7998
8031
  # @!attribute [rw] recovery_point_tags
7999
- # To help organize your resources, you can assign your own metadata to
8000
- # the resources that you create. Each tag is a key-value pair.
8032
+ # The tags to assign to the resources.
8001
8033
  # @return [Hash<String,String>]
8002
8034
  #
8003
8035
  # @!attribute [rw] backup_options
8004
- # Specifies the backup option for a selected resource. This option is
8005
- # only available for Windows Volume Shadow Copy Service (VSS) backup
8006
- # jobs.
8036
+ # The backup option for a selected resource. This option is only
8037
+ # available for Windows Volume Shadow Copy Service (VSS) backup jobs.
8007
8038
  #
8008
8039
  # Valid values: Set to `"WindowsVSS":"enabled"` to enable the
8009
8040
  # `WindowsVSS` backup option and create a Windows VSS backup. Set to
@@ -8072,14 +8103,13 @@ module Aws::Backup
8072
8103
  # The name of a logical source container where backups are stored.
8073
8104
  # Backup vaults are identified by names that are unique to the account
8074
8105
  # used to create them and the Amazon Web Services Region where they
8075
- # are created. They consist of lowercase letters, numbers, and
8076
- # hyphens.
8106
+ # are created.
8077
8107
  # @return [String]
8078
8108
  #
8079
8109
  # @!attribute [rw] destination_backup_vault_arn
8080
8110
  # An Amazon Resource Name (ARN) that uniquely identifies a destination
8081
8111
  # backup vault to copy to; for example,
8082
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
8112
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
8083
8113
  # @return [String]
8084
8114
  #
8085
8115
  # @!attribute [rw] iam_role_arn
@@ -8095,24 +8125,26 @@ module Aws::Backup
8095
8125
  # @return [String]
8096
8126
  #
8097
8127
  # @!attribute [rw] lifecycle
8098
- # Contains an array of `Transition` objects specifying how long in
8099
- # days before a recovery point transitions to cold storage or is
8100
- # deleted.
8128
+ # Specifies the time period, in days, before a recovery point
8129
+ # transitions to cold storage or is deleted.
8101
8130
  #
8102
8131
  # Backups transitioned to cold storage must be stored in cold storage
8103
- # for a minimum of 90 days. Therefore, on the console, the retention
8104
- # setting must be 90 days greater than the transition to cold after
8105
- # days setting. The transition to cold after days setting cannot be
8132
+ # for a minimum of 90 days. Therefore, on the console, the retention
8133
+ # setting must be 90 days greater than the transition to cold after
8134
+ # days setting. The transition to cold after days setting can't be
8106
8135
  # changed after a backup has been transitioned to cold.
8107
8136
  #
8108
- # Resource types that are able to be transitioned to cold storage are
8109
- # listed in the "Lifecycle to cold storage" section of the [ Feature
8110
- # availability by resource][1] table. Backup ignores this expression
8111
- # for other resource types.
8137
+ # Resource types that can transition to cold storage are listed in the
8138
+ # [Feature availability by resource][1] table. Backup ignores this
8139
+ # expression for other resource types.
8112
8140
  #
8141
+ # To remove the existing lifecycle and retention periods and keep your
8142
+ # recovery points indefinitely, specify -1 for
8143
+ # `MoveToColdStorageAfterDays` and `DeleteAfterDays`.
8113
8144
  #
8114
8145
  #
8115
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
8146
+ #
8147
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
8116
8148
  # @return [Types::Lifecycle]
8117
8149
  #
8118
8150
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJobInput AWS API Documentation
@@ -8197,8 +8229,7 @@ module Aws::Backup
8197
8229
  # @return [String]
8198
8230
  #
8199
8231
  # @!attribute [rw] metadata
8200
- # A set of metadata key-value pairs. Contains information, such as a
8201
- # resource name, required to restore a recovery point.
8232
+ # A set of metadata key-value pairs.
8202
8233
  #
8203
8234
  # You can get configuration metadata about a resource at the time it
8204
8235
  # was backed up by calling `GetRecoveryPointRestoreMetadata`. However,
@@ -8207,36 +8238,56 @@ module Aws::Backup
8207
8238
  # resource. For example, you might need to provide a new resource name
8208
8239
  # if the original already exists.
8209
8240
  #
8210
- # You need to specify specific metadata to restore an Amazon Elastic
8211
- # File System (Amazon EFS) instance:
8241
+ # For more information about the metadata for each resource, see the
8242
+ # following:
8243
+ #
8244
+ # * [Metadata for Amazon Aurora][1]
8245
+ #
8246
+ # * [Metadata for Amazon DocumentDB][2]
8247
+ #
8248
+ # * [Metadata for CloudFormation][3]
8249
+ #
8250
+ # * [Metadata for Amazon DynamoDB][4]
8251
+ #
8252
+ # * [ Metadata for Amazon EBS][5]
8253
+ #
8254
+ # * [Metadata for Amazon EC2][6]
8255
+ #
8256
+ # * [Metadata for Amazon EFS][7]
8257
+ #
8258
+ # * [Metadata for Amazon FSx][8]
8212
8259
  #
8213
- # * `file-system-id`: The ID of the Amazon EFS file system that is
8214
- # backed up by Backup. Returned in
8215
- # `GetRecoveryPointRestoreMetadata`.
8260
+ # * [Metadata for Amazon Neptune][9]
8216
8261
  #
8217
- # * `Encrypted`: A Boolean value that, if true, specifies that the
8218
- # file system is encrypted. If `KmsKeyId` is specified, `Encrypted`
8219
- # must be set to `true`.
8262
+ # * [Metadata for Amazon RDS][10]
8220
8263
  #
8221
- # * `KmsKeyId`: Specifies the Amazon Web Services KMS key that is used
8222
- # to encrypt the restored file system. You can specify a key from
8223
- # another Amazon Web Services account provided that key it is
8224
- # properly shared with your account via Amazon Web Services KMS.
8264
+ # * [Metadata for Amazon Redshift][11]
8225
8265
  #
8226
- # * `PerformanceMode`: Specifies the throughput mode of the file
8227
- # system.
8266
+ # * [Metadata for Storage Gateway][12]
8228
8267
  #
8229
- # * `CreationToken`: A user-supplied value that ensures the uniqueness
8230
- # (idempotency) of the request.
8268
+ # * [Metadata for Amazon S3][13]
8231
8269
  #
8232
- # * `newFileSystem`: A Boolean value that, if true, specifies that the
8233
- # recovery point is restored to a new Amazon EFS file system.
8270
+ # * [Metadata for Amazon Timestream][14]
8234
8271
  #
8235
- # * `ItemsToRestore`: An array of one to five strings where each
8236
- # string is a file path. Use `ItemsToRestore` to restore specific
8237
- # files or directories rather than the entire file system. This
8238
- # parameter is optional. For example,
8239
- # `"itemsToRestore":"["/my.test"]"`.
8272
+ # * [Metadata for virtual machines][15]
8273
+ #
8274
+ #
8275
+ #
8276
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli
8277
+ # [2]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli
8278
+ # [3]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli
8279
+ # [4]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli
8280
+ # [5]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli
8281
+ # [6]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli
8282
+ # [7]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli
8283
+ # [8]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli
8284
+ # [9]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli
8285
+ # [10]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli
8286
+ # [11]: https://docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api
8287
+ # [12]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli
8288
+ # [13]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli
8289
+ # [14]: https://docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api
8290
+ # [15]: https://docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli
8240
8291
  # @return [Hash<String,String>]
8241
8292
  #
8242
8293
  # @!attribute [rw] iam_role_arn
@@ -8256,35 +8307,35 @@ module Aws::Backup
8256
8307
  # Starts a job to restore a recovery point for one of the following
8257
8308
  # resources:
8258
8309
  #
8259
- # * `Aurora` for Amazon Aurora
8310
+ # * `Aurora` - Amazon Aurora
8260
8311
  #
8261
- # * `DocumentDB` for Amazon DocumentDB (with MongoDB compatibility)
8312
+ # * `DocumentDB` - Amazon DocumentDB
8262
8313
  #
8263
- # * `CloudFormation` for CloudFormation
8314
+ # * `CloudFormation` - CloudFormation
8264
8315
  #
8265
- # * `DynamoDB` for Amazon DynamoDB
8316
+ # * `DynamoDB` - Amazon DynamoDB
8266
8317
  #
8267
- # * `EBS` for Amazon Elastic Block Store
8318
+ # * `EBS` - Amazon Elastic Block Store
8268
8319
  #
8269
- # * `EC2` for Amazon Elastic Compute Cloud
8320
+ # * `EC2` - Amazon Elastic Compute Cloud
8270
8321
  #
8271
- # * `EFS` for Amazon Elastic File System
8322
+ # * `EFS` - Amazon Elastic File System
8272
8323
  #
8273
- # * `FSx` for Amazon FSx
8324
+ # * `FSx` - Amazon FSx
8274
8325
  #
8275
- # * `Neptune` for Amazon Neptune
8326
+ # * `Neptune` - Amazon Neptune
8276
8327
  #
8277
- # * `RDS` for Amazon Relational Database Service
8328
+ # * `RDS` - Amazon Relational Database Service
8278
8329
  #
8279
- # * `Redshift` for Amazon Redshift
8330
+ # * `Redshift` - Amazon Redshift
8280
8331
  #
8281
- # * `Storage Gateway` for Storage Gateway
8332
+ # * `Storage Gateway` - Storage Gateway
8282
8333
  #
8283
- # * `S3` for Amazon S3
8334
+ # * `S3` - Amazon Simple Storage Service
8284
8335
  #
8285
- # * `Timestream` for Amazon Timestream
8336
+ # * `Timestream` - Amazon Timestream
8286
8337
  #
8287
- # * `VirtualMachine` for virtual machines
8338
+ # * `VirtualMachine` - Virtual machines
8288
8339
  # @return [String]
8289
8340
  #
8290
8341
  # @!attribute [rw] copy_source_tags_to_restored_resource
@@ -8334,6 +8385,12 @@ module Aws::Backup
8334
8385
  # @!attribute [rw] resource_arn
8335
8386
  # An ARN that uniquely identifies a resource. The format of the ARN
8336
8387
  # depends on the type of the tagged resource.
8388
+ #
8389
+ # ARNs that do not include `backup` are incompatible with tagging.
8390
+ # `TagResource` and `UntagResource` with invalid ARNs will result in
8391
+ # an error. Acceptable ARN content can include
8392
+ # `arn:aws:backup:us-east`. Invalid ARN content may look like
8393
+ # `arn:aws:ec2:us-east`.
8337
8394
  # @return [String]
8338
8395
  #
8339
8396
  # @!attribute [rw] tags
@@ -8355,11 +8412,16 @@ module Aws::Backup
8355
8412
  # @!attribute [rw] resource_arn
8356
8413
  # An ARN that uniquely identifies a resource. The format of the ARN
8357
8414
  # depends on the type of the tagged resource.
8415
+ #
8416
+ # ARNs that do not include `backup` are incompatible with tagging.
8417
+ # `TagResource` and `UntagResource` with invalid ARNs will result in
8418
+ # an error. Acceptable ARN content can include
8419
+ # `arn:aws:backup:us-east`. Invalid ARN content may look like
8420
+ # `arn:aws:ec2:us-east`.
8358
8421
  # @return [String]
8359
8422
  #
8360
8423
  # @!attribute [rw] tag_key_list
8361
- # A list of keys to identify which key-value tags to remove from a
8362
- # resource.
8424
+ # The keys to identify which key-value tags to remove from a resource.
8363
8425
  # @return [Array<String>]
8364
8426
  #
8365
8427
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UntagResourceInput AWS API Documentation
@@ -8372,12 +8434,12 @@ module Aws::Backup
8372
8434
  end
8373
8435
 
8374
8436
  # @!attribute [rw] backup_plan_id
8375
- # Uniquely identifies a backup plan.
8437
+ # The ID of the backup plan.
8376
8438
  # @return [String]
8377
8439
  #
8378
8440
  # @!attribute [rw] backup_plan
8379
- # Specifies the body of a backup plan. Includes a `BackupPlanName` and
8380
- # one or more sets of `Rules`.
8441
+ # The body of a backup plan. Includes a `BackupPlanName` and one or
8442
+ # more sets of `Rules`.
8381
8443
  # @return [Types::BackupPlanInput]
8382
8444
  #
8383
8445
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanInput AWS API Documentation
@@ -8439,8 +8501,8 @@ module Aws::Backup
8439
8501
  # @return [String]
8440
8502
  #
8441
8503
  # @!attribute [rw] framework_controls
8442
- # A list of the controls that make up the framework. Each control in
8443
- # the list has a name, input parameters, and scope.
8504
+ # The controls that make up the framework. Each control in the list
8505
+ # has a name, input parameters, and scope.
8444
8506
  # @return [Array<Types::FrameworkControl>]
8445
8507
  #
8446
8508
  # @!attribute [rw] idempotency_token
@@ -8510,7 +8572,7 @@ module Aws::Backup
8510
8572
  # The name of a logical container where backups are stored. Backup
8511
8573
  # vaults are identified by names that are unique to the account used
8512
8574
  # to create them and the Amazon Web Services Region where they are
8513
- # created. They consist of lowercase letters, numbers, and hyphens.
8575
+ # created.
8514
8576
  # @return [String]
8515
8577
  #
8516
8578
  # @!attribute [rw] recovery_point_arn
@@ -8543,7 +8605,7 @@ module Aws::Backup
8543
8605
 
8544
8606
  # @!attribute [rw] backup_vault_arn
8545
8607
  # An ARN that uniquely identifies a backup vault; for example,
8546
- # `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
8608
+ # `arn:aws:backup:us-east-1:123456789012:backup-vault:aBackupVault`.
8547
8609
  # @return [String]
8548
8610
  #
8549
8611
  # @!attribute [rw] recovery_point_arn
@@ -8563,14 +8625,13 @@ module Aws::Backup
8563
8625
  # The “transition to cold after days” setting cannot be changed after
8564
8626
  # a backup has been transitioned to cold.
8565
8627
  #
8566
- # Resource types that are able to be transitioned to cold storage are
8567
- # listed in the "Lifecycle to cold storage" section of the [ Feature
8568
- # availability by resource][1] table. Backup ignores this expression
8569
- # for other resource types.
8628
+ # Resource types that can transition to cold storage are listed in the
8629
+ # [Feature availability by resource][1] table. Backup ignores this
8630
+ # expression for other resource types.
8570
8631
  #
8571
8632
  #
8572
8633
  #
8573
- # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource
8634
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/backup-feature-availability.html#features-by-resource
8574
8635
  # @return [Types::Lifecycle]
8575
8636
  #
8576
8637
  # @!attribute [rw] calculated_lifecycle
@@ -8636,14 +8697,14 @@ module Aws::Backup
8636
8697
  # @return [String]
8637
8698
  #
8638
8699
  # @!attribute [rw] report_delivery_channel
8639
- # A structure that contains information about where to deliver your
8640
- # reports, specifically your Amazon S3 bucket name, S3 key prefix, and
8641
- # the formats of your reports.
8700
+ # The information about where to deliver your reports, specifically
8701
+ # your Amazon S3 bucket name, S3 key prefix, and the formats of your
8702
+ # reports.
8642
8703
  # @return [Types::ReportDeliveryChannel]
8643
8704
  #
8644
8705
  # @!attribute [rw] report_setting
8645
- # Identifies the report template for the report. Reports are built
8646
- # using a report template. The report templates are:
8706
+ # The report template for the report. Reports are built using a report
8707
+ # template. The report templates are:
8647
8708
  #
8648
8709
  # `RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT |
8649
8710
  # BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT`
@@ -8706,7 +8767,7 @@ module Aws::Backup
8706
8767
  # @return [Types::RestoreTestingPlanForUpdate]
8707
8768
  #
8708
8769
  # @!attribute [rw] restore_testing_plan_name
8709
- # This is the restore testing plan name you wish to update.
8770
+ # The name of the restore testing plan name.
8710
8771
  # @return [String]
8711
8772
  #
8712
8773
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingPlanInput AWS API Documentation
@@ -8719,7 +8780,7 @@ module Aws::Backup
8719
8780
  end
8720
8781
 
8721
8782
  # @!attribute [rw] creation_time
8722
- # This is the time the resource testing plan was created.
8783
+ # The time the resource testing plan was created.
8723
8784
  # @return [Time]
8724
8785
  #
8725
8786
  # @!attribute [rw] restore_testing_plan_arn
@@ -8732,7 +8793,7 @@ module Aws::Backup
8732
8793
  # @return [String]
8733
8794
  #
8734
8795
  # @!attribute [rw] update_time
8735
- # This is the time the update completed for the restore testing plan.
8796
+ # The time the update completed for the restore testing plan.
8736
8797
  # @return [Time]
8737
8798
  #
8738
8799
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingPlanOutput AWS API Documentation
@@ -8760,8 +8821,8 @@ module Aws::Backup
8760
8821
  # @return [Types::RestoreTestingSelectionForUpdate]
8761
8822
  #
8762
8823
  # @!attribute [rw] restore_testing_selection_name
8763
- # This is the required restore testing selection name of the restore
8764
- # testing selection you wish to update.
8824
+ # The required restore testing selection name of the restore testing
8825
+ # selection you wish to update.
8765
8826
  # @return [String]
8766
8827
  #
8767
8828
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingSelectionInput AWS API Documentation
@@ -8775,8 +8836,7 @@ module Aws::Backup
8775
8836
  end
8776
8837
 
8777
8838
  # @!attribute [rw] creation_time
8778
- # This is the time the resource testing selection was updated
8779
- # successfully.
8839
+ # The time the resource testing selection was updated successfully.
8780
8840
  # @return [Time]
8781
8841
  #
8782
8842
  # @!attribute [rw] restore_testing_plan_arn
@@ -8784,17 +8844,16 @@ module Aws::Backup
8784
8844
  # @return [String]
8785
8845
  #
8786
8846
  # @!attribute [rw] restore_testing_plan_name
8787
- # This is the restore testing plan with which the updated restore
8788
- # testing selection is associated.
8847
+ # The restore testing plan with which the updated restore testing
8848
+ # selection is associated.
8789
8849
  # @return [String]
8790
8850
  #
8791
8851
  # @!attribute [rw] restore_testing_selection_name
8792
- # This is the returned restore testing selection name.
8852
+ # The returned restore testing selection name.
8793
8853
  # @return [String]
8794
8854
  #
8795
8855
  # @!attribute [rw] update_time
8796
- # This is the time the update completed for the restore testing
8797
- # selection.
8856
+ # The time the update completed for the restore testing selection.
8798
8857
  # @return [Time]
8799
8858
  #
8800
8859
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRestoreTestingSelectionOutput AWS API Documentation