aws-sdk-backup 1.21.0 → 1.26.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8095a8acf5ba240ba4b41c83d8790831934e94b1af562f06f12005a6dc5ff479
4
- data.tar.gz: 68a51ec8256f3b79cce2ee5760184445f645479dbfc098cda5c787b18f5d5c8a
3
+ metadata.gz: 5a2da2d0b24a6598093a2ce086bb3e7bc3a01f86f7378ce5960740b4777491c9
4
+ data.tar.gz: 0e6cef251009ca80a97a7c192447f54a25ca8533659a111725aab903bba47b26
5
5
  SHA512:
6
- metadata.gz: fb85cf34b4cd712905061f8b709b4b8615ff7b57f6c6f20642b0ba56bd0939e770f32a8039e1cdf5e20f5f66461bc858ccbf3526a378bd409f386f0e5c81ed18
7
- data.tar.gz: 726d04b095ad7c4035f2f4baa2c0ac7d38031d9dc7fbd8052f3ed4459baec0e9039046193a30daa4536cc2966b08485f0286075bf10613cb6bb88df6a898a6f2
6
+ metadata.gz: 9cef63b5084ce21e60247a0c8ccde705a4c2c8c9500ca34314e56dc22eada36470aed50c371cbb02e9036bc7256fef8a734a7937aabac012db19af3d0058cd8a
7
+ data.tar.gz: 6e303867550d1efd2a3053fb012c080232aa3a77ae4d66a3bb79a8d904b59e2fc88b054311205142f283401c0b42359d8b11beba063b87340f438bc9262b76ee
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-backup/customizations'
48
48
  # @!group service
49
49
  module Aws::Backup
50
50
 
51
- GEM_VERSION = '1.21.0'
51
+ GEM_VERSION = '1.26.0'
52
52
 
53
53
  end
@@ -327,8 +327,9 @@ module Aws::Backup
327
327
 
328
328
  # @!group API Operations
329
329
 
330
- # Backup plans are documents that contain information that AWS Backup
331
- # uses to schedule tasks that create recovery points of resources.
330
+ # Creates a backup plan using a backup plan name and backup rules. A
331
+ # backup plan is a document that contains information that AWS Backup
332
+ # uses to schedule tasks that create recovery points for resources.
332
333
  #
333
334
  # If you call `CreateBackupPlan` with a plan that already exists, an
334
335
  # `AlreadyExistsException` is returned.
@@ -344,7 +345,7 @@ module Aws::Backup
344
345
  #
345
346
  # @option params [String] :creator_request_id
346
347
  # Identifies the request and allows failed requests to be retried
347
- # without the risk of executing the operation twice. If the request
348
+ # without the risk of running the operation twice. If the request
348
349
  # includes a `CreatorRequestId` that matches an existing backup plan,
349
350
  # that plan is returned. This parameter is optional.
350
351
  #
@@ -354,6 +355,7 @@ module Aws::Backup
354
355
  # * {Types::CreateBackupPlanOutput#backup_plan_arn #backup_plan_arn} => String
355
356
  # * {Types::CreateBackupPlanOutput#creation_date #creation_date} => Time
356
357
  # * {Types::CreateBackupPlanOutput#version_id #version_id} => String
358
+ # * {Types::CreateBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
357
359
  #
358
360
  # @example Request syntax with placeholder values
359
361
  #
@@ -385,6 +387,14 @@ module Aws::Backup
385
387
  # ],
386
388
  # },
387
389
  # ],
390
+ # advanced_backup_settings: [
391
+ # {
392
+ # resource_type: "ResourceType",
393
+ # backup_options: {
394
+ # "BackupOptionKey" => "BackupOptionValue",
395
+ # },
396
+ # },
397
+ # ],
388
398
  # },
389
399
  # backup_plan_tags: {
390
400
  # "TagKey" => "TagValue",
@@ -398,6 +408,10 @@ module Aws::Backup
398
408
  # resp.backup_plan_arn #=> String
399
409
  # resp.creation_date #=> Time
400
410
  # resp.version_id #=> String
411
+ # resp.advanced_backup_settings #=> Array
412
+ # resp.advanced_backup_settings[0].resource_type #=> String
413
+ # resp.advanced_backup_settings[0].backup_options #=> Hash
414
+ # resp.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
401
415
  #
402
416
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlan AWS API Documentation
403
417
  #
@@ -431,12 +445,12 @@ module Aws::Backup
431
445
  # Using these patterns would back up all Amazon Elastic Block Store
432
446
  # (Amazon EBS) volumes that are tagged as `"department=finance"`,
433
447
  # `"importance=critical"`, in addition to an EBS volume with the
434
- # specified volume Id.
448
+ # specified volume ID.
435
449
  #
436
450
  # Resources and conditions are additive in that all resources that match
437
451
  # the pattern are selected. This shouldn't be confused with a logical
438
452
  # AND, where all conditions must match. The matching patterns are
439
- # logically 'put together using the OR operator. In other words, all
453
+ # logically put together using the OR operator. In other words, all
440
454
  # patterns that match are selected for backup.
441
455
  #
442
456
  # @option params [required, String] :backup_plan_id
@@ -449,7 +463,7 @@ module Aws::Backup
449
463
  #
450
464
  # @option params [String] :creator_request_id
451
465
  # A unique string that identifies the request and allows failed requests
452
- # to be retried without the risk of executing the operation twice.
466
+ # to be retried without the risk of running the operation twice.
453
467
  #
454
468
  # @return [Types::CreateBackupSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
455
469
  #
@@ -504,7 +518,7 @@ module Aws::Backup
504
518
  # The name of a logical container where backups are stored. Backup
505
519
  # vaults are identified by names that are unique to the account used to
506
520
  # create them and the AWS Region where they are created. They consist of
507
- # lowercase letters, numbers, and hyphens.
521
+ # letters, numbers, and hyphens.
508
522
  #
509
523
  # @option params [Hash<String,String>] :backup_vault_tags
510
524
  # Metadata that you can assign to help organize the resources that you
@@ -517,7 +531,7 @@ module Aws::Backup
517
531
  #
518
532
  # @option params [String] :creator_request_id
519
533
  # A unique string that identifies the request and allows failed requests
520
- # to be retried without the risk of executing the operation twice.
534
+ # to be retried without the risk of running the operation twice.
521
535
  #
522
536
  # @return [Types::CreateBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
523
537
  #
@@ -724,7 +738,7 @@ module Aws::Backup
724
738
  req.send_request(options)
725
739
  end
726
740
 
727
- # Returns metadata associated with creating a backup of a resource.
741
+ # Returns backup job details for the specified `BackupJobId`.
728
742
  #
729
743
  # @option params [required, String] :backup_job_id
730
744
  # Uniquely identifies a request to AWS Backup to back up a resource.
@@ -749,6 +763,8 @@ module Aws::Backup
749
763
  # * {Types::DescribeBackupJobOutput#bytes_transferred #bytes_transferred} => Integer
750
764
  # * {Types::DescribeBackupJobOutput#expected_completion_date #expected_completion_date} => Time
751
765
  # * {Types::DescribeBackupJobOutput#start_by #start_by} => Time
766
+ # * {Types::DescribeBackupJobOutput#backup_options #backup_options} => Hash&lt;String,String&gt;
767
+ # * {Types::DescribeBackupJobOutput#backup_type #backup_type} => String
752
768
  #
753
769
  # @example Request syntax with placeholder values
754
770
  #
@@ -779,6 +795,9 @@ module Aws::Backup
779
795
  # resp.bytes_transferred #=> Integer
780
796
  # resp.expected_completion_date #=> Time
781
797
  # resp.start_by #=> Time
798
+ # resp.backup_options #=> Hash
799
+ # resp.backup_options["BackupOptionKey"] #=> String
800
+ # resp.backup_type #=> String
782
801
  #
783
802
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob AWS API Documentation
784
803
  #
@@ -875,6 +894,29 @@ module Aws::Backup
875
894
  req.send_request(options)
876
895
  end
877
896
 
897
+ # Describes the global settings of the AWS account, including whether it
898
+ # is opted in to cross-account backup.
899
+ #
900
+ # @return [Types::DescribeGlobalSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
901
+ #
902
+ # * {Types::DescribeGlobalSettingsOutput#global_settings #global_settings} => Hash&lt;String,String&gt;
903
+ # * {Types::DescribeGlobalSettingsOutput#last_update_time #last_update_time} => Time
904
+ #
905
+ # @example Response structure
906
+ #
907
+ # resp.global_settings #=> Hash
908
+ # resp.global_settings["GlobalSettingsName"] #=> String
909
+ # resp.last_update_time #=> Time
910
+ #
911
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettings AWS API Documentation
912
+ #
913
+ # @overload describe_global_settings(params = {})
914
+ # @param [Hash] params ({})
915
+ def describe_global_settings(params = {}, options = {})
916
+ req = build_request(:describe_global_settings, params)
917
+ req.send_request(options)
918
+ end
919
+
878
920
  # Returns information about a saved resource, including the last time it
879
921
  # was backed up, its Amazon Resource Name (ARN), and the AWS service
880
922
  # type of the saved resource.
@@ -929,6 +971,7 @@ module Aws::Backup
929
971
  # * {Types::DescribeRecoveryPointOutput#recovery_point_arn #recovery_point_arn} => String
930
972
  # * {Types::DescribeRecoveryPointOutput#backup_vault_name #backup_vault_name} => String
931
973
  # * {Types::DescribeRecoveryPointOutput#backup_vault_arn #backup_vault_arn} => String
974
+ # * {Types::DescribeRecoveryPointOutput#source_backup_vault_arn #source_backup_vault_arn} => String
932
975
  # * {Types::DescribeRecoveryPointOutput#resource_arn #resource_arn} => String
933
976
  # * {Types::DescribeRecoveryPointOutput#resource_type #resource_type} => String
934
977
  # * {Types::DescribeRecoveryPointOutput#created_by #created_by} => Types::RecoveryPointCreator
@@ -956,6 +999,7 @@ module Aws::Backup
956
999
  # resp.recovery_point_arn #=> String
957
1000
  # resp.backup_vault_name #=> String
958
1001
  # resp.backup_vault_arn #=> String
1002
+ # resp.source_backup_vault_arn #=> String
959
1003
  # resp.resource_arn #=> String
960
1004
  # resp.resource_type #=> String
961
1005
  # resp.created_by.backup_plan_id #=> String
@@ -985,12 +1029,13 @@ module Aws::Backup
985
1029
  req.send_request(options)
986
1030
  end
987
1031
 
988
- # Returns the current service opt-in settings for the Region. If the
989
- # service has a value set to `true`, AWS Backup attempts to protect that
990
- # service's resources in this Region, when included in an on-demand
991
- # backup or scheduled backup plan. If the value is set to `false` for a
992
- # service, AWS Backup does not attempt to protect that service's
993
- # resources in this Region.
1032
+ # Returns the current service opt-in settings for the Region. If
1033
+ # service-opt-in is enabled for a service, AWS Backup tries to protect
1034
+ # that service's resources in this Region, when the resource is
1035
+ # included in an on-demand backup or scheduled backup plan. Otherwise,
1036
+ # AWS Backup does not try to protect that service's resources in this
1037
+ # Region, AWS Backup does not try to protect that service's resources
1038
+ # in this Region.
994
1039
  #
995
1040
  # @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
996
1041
  #
@@ -1092,7 +1137,8 @@ module Aws::Backup
1092
1137
  req.send_request(options)
1093
1138
  end
1094
1139
 
1095
- # Returns the body of a backup plan in JSON format, in addition to plan
1140
+ # Returns `BackupPlan` details for the specified `BackupPlanId`. Returns
1141
+ # the body of a backup plan in JSON format, in addition to plan
1096
1142
  # metadata.
1097
1143
  #
1098
1144
  # @option params [required, String] :backup_plan_id
@@ -1112,6 +1158,7 @@ module Aws::Backup
1112
1158
  # * {Types::GetBackupPlanOutput#creation_date #creation_date} => Time
1113
1159
  # * {Types::GetBackupPlanOutput#deletion_date #deletion_date} => Time
1114
1160
  # * {Types::GetBackupPlanOutput#last_execution_date #last_execution_date} => Time
1161
+ # * {Types::GetBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array&lt;Types::AdvancedBackupSetting&gt;
1115
1162
  #
1116
1163
  # @example Request syntax with placeholder values
1117
1164
  #
@@ -1138,6 +1185,10 @@ module Aws::Backup
1138
1185
  # resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
1139
1186
  # resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
1140
1187
  # resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
1188
+ # resp.backup_plan.advanced_backup_settings #=> Array
1189
+ # resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
1190
+ # resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
1191
+ # resp.backup_plan.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
1141
1192
  # resp.backup_plan_id #=> String
1142
1193
  # resp.backup_plan_arn #=> String
1143
1194
  # resp.version_id #=> String
@@ -1145,6 +1196,10 @@ module Aws::Backup
1145
1196
  # resp.creation_date #=> Time
1146
1197
  # resp.deletion_date #=> Time
1147
1198
  # resp.last_execution_date #=> Time
1199
+ # resp.advanced_backup_settings #=> Array
1200
+ # resp.advanced_backup_settings[0].resource_type #=> String
1201
+ # resp.advanced_backup_settings[0].backup_options #=> Hash
1202
+ # resp.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
1148
1203
  #
1149
1204
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlan AWS API Documentation
1150
1205
  #
@@ -1188,6 +1243,10 @@ module Aws::Backup
1188
1243
  # resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
1189
1244
  # resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
1190
1245
  # resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
1246
+ # resp.backup_plan.advanced_backup_settings #=> Array
1247
+ # resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
1248
+ # resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
1249
+ # resp.backup_plan.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
1191
1250
  #
1192
1251
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON AWS API Documentation
1193
1252
  #
@@ -1231,6 +1290,10 @@ module Aws::Backup
1231
1290
  # resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
1232
1291
  # resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
1233
1292
  # resp.backup_plan_document.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
1293
+ # resp.backup_plan_document.advanced_backup_settings #=> Array
1294
+ # resp.backup_plan_document.advanced_backup_settings[0].resource_type #=> String
1295
+ # resp.backup_plan_document.advanced_backup_settings[0].backup_options #=> Hash
1296
+ # resp.backup_plan_document.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
1234
1297
  #
1235
1298
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate AWS API Documentation
1236
1299
  #
@@ -1427,7 +1490,7 @@ module Aws::Backup
1427
1490
  req.send_request(options)
1428
1491
  end
1429
1492
 
1430
- # Returns metadata about your backup jobs.
1493
+ # Returns a list of existing backup jobs for an authenticated account.
1431
1494
  #
1432
1495
  # @option params [String] :next_token
1433
1496
  # The next item following a partial list of returned items. For example,
@@ -1470,12 +1533,17 @@ module Aws::Backup
1470
1533
  #
1471
1534
  # * `RDS` for Amazon Relational Database Service
1472
1535
  #
1536
+ # * `Aurora` for Amazon Aurora
1537
+ #
1473
1538
  # * `Storage Gateway` for AWS Storage Gateway
1474
1539
  #
1475
1540
  # @option params [String] :by_account_id
1476
1541
  # The account ID to list the jobs from. Returns only backup jobs
1477
1542
  # associated with the specified account ID.
1478
1543
  #
1544
+ # If used from an AWS Organizations management account, passing `*`
1545
+ # returns all jobs across the organization.
1546
+ #
1479
1547
  # @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1480
1548
  #
1481
1549
  # * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array&lt;Types::BackupJob&gt;
@@ -1521,6 +1589,9 @@ module Aws::Backup
1521
1589
  # resp.backup_jobs[0].start_by #=> Time
1522
1590
  # resp.backup_jobs[0].resource_type #=> String
1523
1591
  # resp.backup_jobs[0].bytes_transferred #=> Integer
1592
+ # resp.backup_jobs[0].backup_options #=> Hash
1593
+ # resp.backup_jobs[0].backup_options["BackupOptionKey"] #=> String
1594
+ # resp.backup_jobs[0].backup_type #=> String
1524
1595
  # resp.next_token #=> String
1525
1596
  #
1526
1597
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs AWS API Documentation
@@ -1617,6 +1688,10 @@ module Aws::Backup
1617
1688
  # resp.backup_plan_versions_list[0].backup_plan_name #=> String
1618
1689
  # resp.backup_plan_versions_list[0].creator_request_id #=> String
1619
1690
  # resp.backup_plan_versions_list[0].last_execution_date #=> Time
1691
+ # resp.backup_plan_versions_list[0].advanced_backup_settings #=> Array
1692
+ # resp.backup_plan_versions_list[0].advanced_backup_settings[0].resource_type #=> String
1693
+ # resp.backup_plan_versions_list[0].advanced_backup_settings[0].backup_options #=> Hash
1694
+ # resp.backup_plan_versions_list[0].advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
1620
1695
  #
1621
1696
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanVersions AWS API Documentation
1622
1697
  #
@@ -1627,7 +1702,9 @@ module Aws::Backup
1627
1702
  req.send_request(options)
1628
1703
  end
1629
1704
 
1630
- # Returns metadata of your saved backup plans, including Amazon Resource
1705
+ # Returns a list of existing backup plans for an authenticated account.
1706
+ # The list is populated only if the advanced option is set for the
1707
+ # backup plan. The list contains information such as Amazon Resource
1631
1708
  # Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan
1632
1709
  # names, and creator request IDs.
1633
1710
  #
@@ -1671,6 +1748,10 @@ module Aws::Backup
1671
1748
  # resp.backup_plans_list[0].backup_plan_name #=> String
1672
1749
  # resp.backup_plans_list[0].creator_request_id #=> String
1673
1750
  # resp.backup_plans_list[0].last_execution_date #=> Time
1751
+ # resp.backup_plans_list[0].advanced_backup_settings #=> Array
1752
+ # resp.backup_plans_list[0].advanced_backup_settings[0].resource_type #=> String
1753
+ # resp.backup_plans_list[0].advanced_backup_settings[0].backup_options #=> Hash
1754
+ # resp.backup_plans_list[0].advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
1674
1755
  #
1675
1756
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlans AWS API Documentation
1676
1757
  #
@@ -1814,6 +1895,8 @@ module Aws::Backup
1814
1895
  #
1815
1896
  # * `RDS` for Amazon Relational Database Service
1816
1897
  #
1898
+ # * `Aurora` for Amazon Aurora
1899
+ #
1817
1900
  # * `Storage Gateway` for AWS Storage Gateway
1818
1901
  #
1819
1902
  # @option params [String] :by_destination_vault_arn
@@ -1985,6 +2068,7 @@ module Aws::Backup
1985
2068
  # resp.recovery_points[0].recovery_point_arn #=> String
1986
2069
  # resp.recovery_points[0].backup_vault_name #=> String
1987
2070
  # resp.recovery_points[0].backup_vault_arn #=> String
2071
+ # resp.recovery_points[0].source_backup_vault_arn #=> String
1988
2072
  # resp.recovery_points[0].resource_arn #=> String
1989
2073
  # resp.recovery_points[0].resource_type #=> String
1990
2074
  # resp.recovery_points[0].created_by.backup_plan_id #=> String
@@ -2253,7 +2337,7 @@ module Aws::Backup
2253
2337
  req.send_request(options)
2254
2338
  end
2255
2339
 
2256
- # Starts a job to create a one-time backup of the specified resource.
2340
+ # Starts an on-demand backup job for the specified resource.
2257
2341
  #
2258
2342
  # @option params [required, String] :backup_vault_name
2259
2343
  # The name of a logical container where backups are stored. Backup
@@ -2275,12 +2359,15 @@ module Aws::Backup
2275
2359
  #
2276
2360
  # @option params [Integer] :start_window_minutes
2277
2361
  # A value in minutes after a backup is scheduled before a job will be
2278
- # canceled if it doesn't start successfully. This value is optional.
2362
+ # canceled if it doesn't start successfully. This value is optional,
2363
+ # and the default is 8 hours.
2279
2364
  #
2280
2365
  # @option params [Integer] :complete_window_minutes
2281
- # A value in minutes after a backup job is successfully started before
2282
- # it must be completed or it will be canceled by AWS Backup. This value
2283
- # is optional.
2366
+ # A value in minutes during which a successfully started backup must
2367
+ # complete, or else AWS Backup will cancel the job. This value is
2368
+ # optional. This value begins counting down from when the backup was
2369
+ # scheduled. It does not add additional time for `StartWindowMinutes`,
2370
+ # or if the backup started later than scheduled.
2284
2371
  #
2285
2372
  # @option params [Types::Lifecycle] :lifecycle
2286
2373
  # The lifecycle defines when a protected resource is transitioned to
@@ -2294,10 +2381,22 @@ module Aws::Backup
2294
2381
  # setting. The “transition to cold after days” setting cannot be changed
2295
2382
  # after a backup has been transitioned to cold.
2296
2383
  #
2384
+ # Only Amazon EFS file system backups can be transitioned to cold
2385
+ # storage.
2386
+ #
2297
2387
  # @option params [Hash<String,String>] :recovery_point_tags
2298
2388
  # To help organize your resources, you can assign your own metadata to
2299
2389
  # the resources that you create. Each tag is a key-value pair.
2300
2390
  #
2391
+ # @option params [Hash<String,String>] :backup_options
2392
+ # Specifies the backup option for a selected resource. This option is
2393
+ # only available for Windows VSS backup jobs.
2394
+ #
2395
+ # Valid values: Set to `"WindowsVSS”:“enabled"` to enable WindowsVSS
2396
+ # backup option and create a VSS Windows backup. Set to
2397
+ # “WindowsVSS”:”disabled” to create a regular backup. The WindowsVSS
2398
+ # option is not enabled by default.
2399
+ #
2301
2400
  # @return [Types::StartBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2302
2401
  #
2303
2402
  # * {Types::StartBackupJobOutput#backup_job_id #backup_job_id} => String
@@ -2320,6 +2419,9 @@ module Aws::Backup
2320
2419
  # recovery_point_tags: {
2321
2420
  # "TagKey" => "TagValue",
2322
2421
  # },
2422
+ # backup_options: {
2423
+ # "BackupOptionKey" => "BackupOptionValue",
2424
+ # },
2323
2425
  # })
2324
2426
  #
2325
2427
  # @example Response structure
@@ -2373,6 +2475,9 @@ module Aws::Backup
2373
2475
  # after days” setting. The “transition to cold after days” setting
2374
2476
  # cannot be changed after a backup has been transitioned to cold.
2375
2477
  #
2478
+ # Only Amazon EFS file system backups can be transitioned to cold
2479
+ # storage.
2480
+ #
2376
2481
  # @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2377
2482
  #
2378
2483
  # * {Types::StartCopyJobOutput#copy_job_id #copy_job_id} => String
@@ -2409,10 +2514,6 @@ module Aws::Backup
2409
2514
  # Recovers the saved resource identified by an Amazon Resource Name
2410
2515
  # (ARN).
2411
2516
  #
2412
- # If the resource ARN is included in the request, then the last complete
2413
- # backup of that resource is recovered. If the ARN of a recovery point
2414
- # is supplied, then that recovery point is restored.
2415
- #
2416
2517
  # @option params [required, String] :recovery_point_arn
2417
2518
  # An ARN that uniquely identifies a recovery point; for example,
2418
2519
  # `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
@@ -2431,15 +2532,18 @@ module Aws::Backup
2431
2532
  # You need to specify specific metadata to restore an Amazon Elastic
2432
2533
  # File System (Amazon EFS) instance:
2433
2534
  #
2434
- # * `file-system-id`\: ID of the Amazon EFS file system that is backed
2435
- # up by AWS Backup. Returned in `GetRecoveryPointRestoreMetadata`.
2535
+ # * `file-system-id`\: The ID of the Amazon EFS file system that is
2536
+ # backed up by AWS Backup. Returned in
2537
+ # `GetRecoveryPointRestoreMetadata`.
2436
2538
  #
2437
2539
  # * `Encrypted`\: A Boolean value that, if true, specifies that the file
2438
2540
  # system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
2439
2541
  # set to `true`.
2440
2542
  #
2441
2543
  # * `KmsKeyId`\: Specifies the AWS KMS key that is used to encrypt the
2442
- # restored file system.
2544
+ # restored file system. You can specify a key from another AWS account
2545
+ # provided that key it is properly shared with your account via AWS
2546
+ # KMS.
2443
2547
  #
2444
2548
  # * `PerformanceMode`\: Specifies the throughput mode of the file
2445
2549
  # system.
@@ -2450,6 +2554,12 @@ module Aws::Backup
2450
2554
  # * `newFileSystem`\: A Boolean value that, if true, specifies that the
2451
2555
  # recovery point is restored to a new Amazon EFS file system.
2452
2556
  #
2557
+ # * `ItemsToRestore `\: An array of one to five strings where each
2558
+ # string is a file path. Use `ItemsToRestore` to restore specific
2559
+ # files or directories rather than the entire file system. This
2560
+ # parameter is optional. For example,
2561
+ # `"itemsToRestore":"["/my.test"]"`.
2562
+ #
2453
2563
  # @option params [required, String] :iam_role_arn
2454
2564
  # The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
2455
2565
  # create the target recovery point; for example,
@@ -2473,6 +2583,8 @@ module Aws::Backup
2473
2583
  #
2474
2584
  # * `RDS` for Amazon Relational Database Service
2475
2585
  #
2586
+ # * `Aurora` for Amazon Aurora
2587
+ #
2476
2588
  # * `Storage Gateway` for AWS Storage Gateway
2477
2589
  #
2478
2590
  # @return [Types::StartRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
@@ -2586,9 +2698,9 @@ module Aws::Backup
2586
2698
  req.send_request(options)
2587
2699
  end
2588
2700
 
2589
- # Replaces the body of a saved backup plan identified by its
2590
- # `backupPlanId` with the input document in JSON format. The new version
2591
- # is uniquely identified by a `VersionId`.
2701
+ # Updates an existing backup plan identified by its `backupPlanId` with
2702
+ # the input document in JSON format. The new version is uniquely
2703
+ # identified by a `VersionId`.
2592
2704
  #
2593
2705
  # @option params [required, String] :backup_plan_id
2594
2706
  # Uniquely identifies a backup plan.
@@ -2603,6 +2715,7 @@ module Aws::Backup
2603
2715
  # * {Types::UpdateBackupPlanOutput#backup_plan_arn #backup_plan_arn} => String
2604
2716
  # * {Types::UpdateBackupPlanOutput#creation_date #creation_date} => Time
2605
2717
  # * {Types::UpdateBackupPlanOutput#version_id #version_id} => String
2718
+ # * {Types::UpdateBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array&lt;Types::AdvancedBackupSetting&gt;
2606
2719
  #
2607
2720
  # @example Request syntax with placeholder values
2608
2721
  #
@@ -2635,6 +2748,14 @@ module Aws::Backup
2635
2748
  # ],
2636
2749
  # },
2637
2750
  # ],
2751
+ # advanced_backup_settings: [
2752
+ # {
2753
+ # resource_type: "ResourceType",
2754
+ # backup_options: {
2755
+ # "BackupOptionKey" => "BackupOptionValue",
2756
+ # },
2757
+ # },
2758
+ # ],
2638
2759
  # },
2639
2760
  # })
2640
2761
  #
@@ -2644,6 +2765,10 @@ module Aws::Backup
2644
2765
  # resp.backup_plan_arn #=> String
2645
2766
  # resp.creation_date #=> Time
2646
2767
  # resp.version_id #=> String
2768
+ # resp.advanced_backup_settings #=> Array
2769
+ # resp.advanced_backup_settings[0].resource_type #=> String
2770
+ # resp.advanced_backup_settings[0].backup_options #=> Hash
2771
+ # resp.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
2647
2772
  #
2648
2773
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlan AWS API Documentation
2649
2774
  #
@@ -2654,6 +2779,31 @@ module Aws::Backup
2654
2779
  req.send_request(options)
2655
2780
  end
2656
2781
 
2782
+ # Updates the current global settings for the AWS account. Use the
2783
+ # `DescribeGlobalSettings` API to determine the current settings.
2784
+ #
2785
+ # @option params [Hash<String,String>] :global_settings
2786
+ # A list of resources along with the opt-in preferences for the account.
2787
+ #
2788
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2789
+ #
2790
+ # @example Request syntax with placeholder values
2791
+ #
2792
+ # resp = client.update_global_settings({
2793
+ # global_settings: {
2794
+ # "GlobalSettingsName" => "GlobalSettingsValue",
2795
+ # },
2796
+ # })
2797
+ #
2798
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettings AWS API Documentation
2799
+ #
2800
+ # @overload update_global_settings(params = {})
2801
+ # @param [Hash] params ({})
2802
+ def update_global_settings(params = {}, options = {})
2803
+ req = build_request(:update_global_settings, params)
2804
+ req.send_request(options)
2805
+ end
2806
+
2657
2807
  # Sets the transition lifecycle of a recovery point.
2658
2808
  #
2659
2809
  # The lifecycle defines when a protected resource is transitioned to
@@ -2666,6 +2816,9 @@ module Aws::Backup
2666
2816
  # setting. The “transition to cold after days” setting cannot be changed
2667
2817
  # after a backup has been transitioned to cold.
2668
2818
  #
2819
+ # Only Amazon EFS file system backups can be transitioned to cold
2820
+ # storage.
2821
+ #
2669
2822
  # @option params [required, String] :backup_vault_name
2670
2823
  # The name of a logical container where backups are stored. Backup
2671
2824
  # vaults are identified by names that are unique to the account used to
@@ -2724,16 +2877,17 @@ module Aws::Backup
2724
2877
  req.send_request(options)
2725
2878
  end
2726
2879
 
2727
- # Updates the current service opt-in settings for the Region. If the
2728
- # service has a value set to `true`, AWS Backup attempts to protect that
2729
- # service's resources in this Region, when included in an on-demand
2730
- # backup or scheduled backup plan. If the value is set to `false` for a
2731
- # service, AWS Backup does not attempt to protect that service's
2732
- # resources in this Region.
2880
+ # Updates the current service opt-in settings for the Region. If
2881
+ # service-opt-in is enabled for a service, AWS Backup tries to protect
2882
+ # that service's resources in this Region, when the resource is
2883
+ # included in an on-demand backup or scheduled backup plan. Otherwise,
2884
+ # AWS Backup does not try to protect that service's resources in this
2885
+ # Region. Use the `DescribeRegionSettings` API to determine the resource
2886
+ # types that are supported.
2733
2887
  #
2734
2888
  # @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
2735
2889
  # Updates the list of services along with the opt-in preferences for the
2736
- # region.
2890
+ # Region.
2737
2891
  #
2738
2892
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2739
2893
  #
@@ -2767,7 +2921,7 @@ module Aws::Backup
2767
2921
  params: params,
2768
2922
  config: config)
2769
2923
  context[:gem_name] = 'aws-sdk-backup'
2770
- context[:gem_version] = '1.21.0'
2924
+ context[:gem_version] = '1.26.0'
2771
2925
  Seahorse::Client::Request.new(handlers, context)
2772
2926
  end
2773
2927