aws-sdk-backup 1.18.0 → 1.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-backup.rb +3 -2
- data/lib/aws-sdk-backup/client.rb +123 -34
- data/lib/aws-sdk-backup/client_api.rb +25 -0
- data/lib/aws-sdk-backup/types.rb +191 -41
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 0035143af9052545ab4ef1314b66fc4978a25d51843fe713d450341c25a85a3e
|
4
|
+
data.tar.gz: 4c7cb2fc97e924869da64bb41b3ec132a8f26d23219264463b09bfc8d3250901
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8c805cacfea172afa0bcbd5e89b707a3ffa6cc70e0139fd339270be9d9ca3aee8dc740a555b70abb94fac9d61d45f99ffd13cd09edcc63172ceafb33359d33b7
|
7
|
+
data.tar.gz: 7a7d93e2e2cdbc693b2d7c0eaa2ed9b3212d9956a62d3d53b9020d7dcb357eacb7657ffb3d445a118aa08cb183334f2924c3815c78345a36f7e28c717bceae31
|
data/lib/aws-sdk-backup.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-backup/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::Backup
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.23.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::Backup
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::Backup
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -312,8 +327,9 @@ module Aws::Backup
|
|
312
327
|
|
313
328
|
# @!group API Operations
|
314
329
|
|
315
|
-
#
|
316
|
-
#
|
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.
|
317
333
|
#
|
318
334
|
# If you call `CreateBackupPlan` with a plan that already exists, an
|
319
335
|
# `AlreadyExistsException` is returned.
|
@@ -329,7 +345,7 @@ module Aws::Backup
|
|
329
345
|
#
|
330
346
|
# @option params [String] :creator_request_id
|
331
347
|
# Identifies the request and allows failed requests to be retried
|
332
|
-
# without the risk of
|
348
|
+
# without the risk of running the operation twice. If the request
|
333
349
|
# includes a `CreatorRequestId` that matches an existing backup plan,
|
334
350
|
# that plan is returned. This parameter is optional.
|
335
351
|
#
|
@@ -339,6 +355,7 @@ module Aws::Backup
|
|
339
355
|
# * {Types::CreateBackupPlanOutput#backup_plan_arn #backup_plan_arn} => String
|
340
356
|
# * {Types::CreateBackupPlanOutput#creation_date #creation_date} => Time
|
341
357
|
# * {Types::CreateBackupPlanOutput#version_id #version_id} => String
|
358
|
+
# * {Types::CreateBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
|
342
359
|
#
|
343
360
|
# @example Request syntax with placeholder values
|
344
361
|
#
|
@@ -370,6 +387,14 @@ module Aws::Backup
|
|
370
387
|
# ],
|
371
388
|
# },
|
372
389
|
# ],
|
390
|
+
# advanced_backup_settings: [
|
391
|
+
# {
|
392
|
+
# resource_type: "ResourceType",
|
393
|
+
# backup_options: {
|
394
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
395
|
+
# },
|
396
|
+
# },
|
397
|
+
# ],
|
373
398
|
# },
|
374
399
|
# backup_plan_tags: {
|
375
400
|
# "TagKey" => "TagValue",
|
@@ -383,6 +408,10 @@ module Aws::Backup
|
|
383
408
|
# resp.backup_plan_arn #=> String
|
384
409
|
# resp.creation_date #=> Time
|
385
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
|
386
415
|
#
|
387
416
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlan AWS API Documentation
|
388
417
|
#
|
@@ -405,23 +434,23 @@ module Aws::Backup
|
|
405
434
|
#
|
406
435
|
# `ConditionValue:"finance"`
|
407
436
|
#
|
408
|
-
# `ConditionType:"
|
437
|
+
# `ConditionType:"StringEquals"`
|
409
438
|
#
|
410
439
|
# * `ConditionKey:"importance"`
|
411
440
|
#
|
412
441
|
# `ConditionValue:"critical"`
|
413
442
|
#
|
414
|
-
# `ConditionType:"
|
443
|
+
# `ConditionType:"StringEquals"`
|
415
444
|
#
|
416
445
|
# Using these patterns would back up all Amazon Elastic Block Store
|
417
446
|
# (Amazon EBS) volumes that are tagged as `"department=finance"`,
|
418
447
|
# `"importance=critical"`, in addition to an EBS volume with the
|
419
|
-
# specified volume
|
448
|
+
# specified volume ID.
|
420
449
|
#
|
421
450
|
# Resources and conditions are additive in that all resources that match
|
422
451
|
# the pattern are selected. This shouldn't be confused with a logical
|
423
452
|
# AND, where all conditions must match. The matching patterns are
|
424
|
-
# logically
|
453
|
+
# logically put together using the OR operator. In other words, all
|
425
454
|
# patterns that match are selected for backup.
|
426
455
|
#
|
427
456
|
# @option params [required, String] :backup_plan_id
|
@@ -434,7 +463,7 @@ module Aws::Backup
|
|
434
463
|
#
|
435
464
|
# @option params [String] :creator_request_id
|
436
465
|
# A unique string that identifies the request and allows failed requests
|
437
|
-
# to be retried without the risk of
|
466
|
+
# to be retried without the risk of running the operation twice.
|
438
467
|
#
|
439
468
|
# @return [Types::CreateBackupSelectionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
440
469
|
#
|
@@ -502,7 +531,7 @@ module Aws::Backup
|
|
502
531
|
#
|
503
532
|
# @option params [String] :creator_request_id
|
504
533
|
# A unique string that identifies the request and allows failed requests
|
505
|
-
# to be retried without the risk of
|
534
|
+
# to be retried without the risk of running the operation twice.
|
506
535
|
#
|
507
536
|
# @return [Types::CreateBackupVaultOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
508
537
|
#
|
@@ -709,7 +738,7 @@ module Aws::Backup
|
|
709
738
|
req.send_request(options)
|
710
739
|
end
|
711
740
|
|
712
|
-
# Returns
|
741
|
+
# Returns backup job details for the specified `BackupJobId`.
|
713
742
|
#
|
714
743
|
# @option params [required, String] :backup_job_id
|
715
744
|
# Uniquely identifies a request to AWS Backup to back up a resource.
|
@@ -734,6 +763,8 @@ module Aws::Backup
|
|
734
763
|
# * {Types::DescribeBackupJobOutput#bytes_transferred #bytes_transferred} => Integer
|
735
764
|
# * {Types::DescribeBackupJobOutput#expected_completion_date #expected_completion_date} => Time
|
736
765
|
# * {Types::DescribeBackupJobOutput#start_by #start_by} => Time
|
766
|
+
# * {Types::DescribeBackupJobOutput#backup_options #backup_options} => Hash<String,String>
|
767
|
+
# * {Types::DescribeBackupJobOutput#backup_type #backup_type} => String
|
737
768
|
#
|
738
769
|
# @example Request syntax with placeholder values
|
739
770
|
#
|
@@ -764,6 +795,9 @@ module Aws::Backup
|
|
764
795
|
# resp.bytes_transferred #=> Integer
|
765
796
|
# resp.expected_completion_date #=> Time
|
766
797
|
# resp.start_by #=> Time
|
798
|
+
# resp.backup_options #=> Hash
|
799
|
+
# resp.backup_options["BackupOptionKey"] #=> String
|
800
|
+
# resp.backup_type #=> String
|
767
801
|
#
|
768
802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob AWS API Documentation
|
769
803
|
#
|
@@ -971,11 +1005,11 @@ module Aws::Backup
|
|
971
1005
|
end
|
972
1006
|
|
973
1007
|
# Returns the current service opt-in settings for the Region. If the
|
974
|
-
# service has a value set to `true`, AWS Backup
|
1008
|
+
# service has a value set to `true`, AWS Backup tries to protect that
|
975
1009
|
# service's resources in this Region, when included in an on-demand
|
976
1010
|
# backup or scheduled backup plan. If the value is set to `false` for a
|
977
|
-
# service, AWS Backup does not
|
978
|
-
#
|
1011
|
+
# service, AWS Backup does not try to protect that service's resources
|
1012
|
+
# in this Region.
|
979
1013
|
#
|
980
1014
|
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
981
1015
|
#
|
@@ -1077,7 +1111,8 @@ module Aws::Backup
|
|
1077
1111
|
req.send_request(options)
|
1078
1112
|
end
|
1079
1113
|
|
1080
|
-
# Returns
|
1114
|
+
# Returns `BackupPlan` details for the specified `BackupPlanId`. Returns
|
1115
|
+
# the body of a backup plan in JSON format, in addition to plan
|
1081
1116
|
# metadata.
|
1082
1117
|
#
|
1083
1118
|
# @option params [required, String] :backup_plan_id
|
@@ -1097,6 +1132,7 @@ module Aws::Backup
|
|
1097
1132
|
# * {Types::GetBackupPlanOutput#creation_date #creation_date} => Time
|
1098
1133
|
# * {Types::GetBackupPlanOutput#deletion_date #deletion_date} => Time
|
1099
1134
|
# * {Types::GetBackupPlanOutput#last_execution_date #last_execution_date} => Time
|
1135
|
+
# * {Types::GetBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
|
1100
1136
|
#
|
1101
1137
|
# @example Request syntax with placeholder values
|
1102
1138
|
#
|
@@ -1123,6 +1159,10 @@ module Aws::Backup
|
|
1123
1159
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1124
1160
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1125
1161
|
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1162
|
+
# resp.backup_plan.advanced_backup_settings #=> Array
|
1163
|
+
# resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
|
1164
|
+
# resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
|
1165
|
+
# resp.backup_plan.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
1126
1166
|
# resp.backup_plan_id #=> String
|
1127
1167
|
# resp.backup_plan_arn #=> String
|
1128
1168
|
# resp.version_id #=> String
|
@@ -1130,6 +1170,10 @@ module Aws::Backup
|
|
1130
1170
|
# resp.creation_date #=> Time
|
1131
1171
|
# resp.deletion_date #=> Time
|
1132
1172
|
# resp.last_execution_date #=> Time
|
1173
|
+
# resp.advanced_backup_settings #=> Array
|
1174
|
+
# resp.advanced_backup_settings[0].resource_type #=> String
|
1175
|
+
# resp.advanced_backup_settings[0].backup_options #=> Hash
|
1176
|
+
# resp.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
1133
1177
|
#
|
1134
1178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlan AWS API Documentation
|
1135
1179
|
#
|
@@ -1173,6 +1217,10 @@ module Aws::Backup
|
|
1173
1217
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1174
1218
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1175
1219
|
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1220
|
+
# resp.backup_plan.advanced_backup_settings #=> Array
|
1221
|
+
# resp.backup_plan.advanced_backup_settings[0].resource_type #=> String
|
1222
|
+
# resp.backup_plan.advanced_backup_settings[0].backup_options #=> Hash
|
1223
|
+
# resp.backup_plan.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
1176
1224
|
#
|
1177
1225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON AWS API Documentation
|
1178
1226
|
#
|
@@ -1216,6 +1264,10 @@ module Aws::Backup
|
|
1216
1264
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1217
1265
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1218
1266
|
# resp.backup_plan_document.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1267
|
+
# resp.backup_plan_document.advanced_backup_settings #=> Array
|
1268
|
+
# resp.backup_plan_document.advanced_backup_settings[0].resource_type #=> String
|
1269
|
+
# resp.backup_plan_document.advanced_backup_settings[0].backup_options #=> Hash
|
1270
|
+
# resp.backup_plan_document.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
1219
1271
|
#
|
1220
1272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate AWS API Documentation
|
1221
1273
|
#
|
@@ -1412,7 +1464,7 @@ module Aws::Backup
|
|
1412
1464
|
req.send_request(options)
|
1413
1465
|
end
|
1414
1466
|
|
1415
|
-
# Returns
|
1467
|
+
# Returns a list of existing backup jobs for an authenticated account.
|
1416
1468
|
#
|
1417
1469
|
# @option params [String] :next_token
|
1418
1470
|
# The next item following a partial list of returned items. For example,
|
@@ -1506,6 +1558,9 @@ module Aws::Backup
|
|
1506
1558
|
# resp.backup_jobs[0].start_by #=> Time
|
1507
1559
|
# resp.backup_jobs[0].resource_type #=> String
|
1508
1560
|
# resp.backup_jobs[0].bytes_transferred #=> Integer
|
1561
|
+
# resp.backup_jobs[0].backup_options #=> Hash
|
1562
|
+
# resp.backup_jobs[0].backup_options["BackupOptionKey"] #=> String
|
1563
|
+
# resp.backup_jobs[0].backup_type #=> String
|
1509
1564
|
# resp.next_token #=> String
|
1510
1565
|
#
|
1511
1566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs AWS API Documentation
|
@@ -1602,6 +1657,10 @@ module Aws::Backup
|
|
1602
1657
|
# resp.backup_plan_versions_list[0].backup_plan_name #=> String
|
1603
1658
|
# resp.backup_plan_versions_list[0].creator_request_id #=> String
|
1604
1659
|
# resp.backup_plan_versions_list[0].last_execution_date #=> Time
|
1660
|
+
# resp.backup_plan_versions_list[0].advanced_backup_settings #=> Array
|
1661
|
+
# resp.backup_plan_versions_list[0].advanced_backup_settings[0].resource_type #=> String
|
1662
|
+
# resp.backup_plan_versions_list[0].advanced_backup_settings[0].backup_options #=> Hash
|
1663
|
+
# resp.backup_plan_versions_list[0].advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
1605
1664
|
#
|
1606
1665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanVersions AWS API Documentation
|
1607
1666
|
#
|
@@ -1612,7 +1671,9 @@ module Aws::Backup
|
|
1612
1671
|
req.send_request(options)
|
1613
1672
|
end
|
1614
1673
|
|
1615
|
-
# Returns
|
1674
|
+
# Returns a list of existing backup plans for an authenticated account.
|
1675
|
+
# The list is populated only if the advanced option is set for the
|
1676
|
+
# backup plan. The list contains information such as Amazon Resource
|
1616
1677
|
# Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan
|
1617
1678
|
# names, and creator request IDs.
|
1618
1679
|
#
|
@@ -1656,6 +1717,10 @@ module Aws::Backup
|
|
1656
1717
|
# resp.backup_plans_list[0].backup_plan_name #=> String
|
1657
1718
|
# resp.backup_plans_list[0].creator_request_id #=> String
|
1658
1719
|
# resp.backup_plans_list[0].last_execution_date #=> Time
|
1720
|
+
# resp.backup_plans_list[0].advanced_backup_settings #=> Array
|
1721
|
+
# resp.backup_plans_list[0].advanced_backup_settings[0].resource_type #=> String
|
1722
|
+
# resp.backup_plans_list[0].advanced_backup_settings[0].backup_options #=> Hash
|
1723
|
+
# resp.backup_plans_list[0].advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
1659
1724
|
#
|
1660
1725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlans AWS API Documentation
|
1661
1726
|
#
|
@@ -2238,7 +2303,7 @@ module Aws::Backup
|
|
2238
2303
|
req.send_request(options)
|
2239
2304
|
end
|
2240
2305
|
|
2241
|
-
# Starts
|
2306
|
+
# Starts an on-demand backup job for the specified resource.
|
2242
2307
|
#
|
2243
2308
|
# @option params [required, String] :backup_vault_name
|
2244
2309
|
# The name of a logical container where backups are stored. Backup
|
@@ -2283,6 +2348,13 @@ module Aws::Backup
|
|
2283
2348
|
# To help organize your resources, you can assign your own metadata to
|
2284
2349
|
# the resources that you create. Each tag is a key-value pair.
|
2285
2350
|
#
|
2351
|
+
# @option params [Hash<String,String>] :backup_options
|
2352
|
+
# Specifies the backup option for a selected resource. This option is
|
2353
|
+
# only available for Windows VSS backup jobs.
|
2354
|
+
#
|
2355
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
2356
|
+
# Windows backup; otherwise, creates a regular backup.
|
2357
|
+
#
|
2286
2358
|
# @return [Types::StartBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2287
2359
|
#
|
2288
2360
|
# * {Types::StartBackupJobOutput#backup_job_id #backup_job_id} => String
|
@@ -2305,6 +2377,9 @@ module Aws::Backup
|
|
2305
2377
|
# recovery_point_tags: {
|
2306
2378
|
# "TagKey" => "TagValue",
|
2307
2379
|
# },
|
2380
|
+
# backup_options: {
|
2381
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
2382
|
+
# },
|
2308
2383
|
# })
|
2309
2384
|
#
|
2310
2385
|
# @example Response structure
|
@@ -2416,8 +2491,9 @@ module Aws::Backup
|
|
2416
2491
|
# You need to specify specific metadata to restore an Amazon Elastic
|
2417
2492
|
# File System (Amazon EFS) instance:
|
2418
2493
|
#
|
2419
|
-
# * `file-system-id`\: ID of the Amazon EFS file system that is
|
2420
|
-
# up by AWS Backup. Returned in
|
2494
|
+
# * `file-system-id`\: The ID of the Amazon EFS file system that is
|
2495
|
+
# backed up by AWS Backup. Returned in
|
2496
|
+
# `GetRecoveryPointRestoreMetadata`.
|
2421
2497
|
#
|
2422
2498
|
# * `Encrypted`\: A Boolean value that, if true, specifies that the file
|
2423
2499
|
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
@@ -2571,9 +2647,9 @@ module Aws::Backup
|
|
2571
2647
|
req.send_request(options)
|
2572
2648
|
end
|
2573
2649
|
|
2574
|
-
#
|
2575
|
-
#
|
2576
|
-
#
|
2650
|
+
# Updates an existing backup plan identified by its `backupPlanId` with
|
2651
|
+
# the input document in JSON format. The new version is uniquely
|
2652
|
+
# identified by a `VersionId`.
|
2577
2653
|
#
|
2578
2654
|
# @option params [required, String] :backup_plan_id
|
2579
2655
|
# Uniquely identifies a backup plan.
|
@@ -2588,6 +2664,7 @@ module Aws::Backup
|
|
2588
2664
|
# * {Types::UpdateBackupPlanOutput#backup_plan_arn #backup_plan_arn} => String
|
2589
2665
|
# * {Types::UpdateBackupPlanOutput#creation_date #creation_date} => Time
|
2590
2666
|
# * {Types::UpdateBackupPlanOutput#version_id #version_id} => String
|
2667
|
+
# * {Types::UpdateBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
|
2591
2668
|
#
|
2592
2669
|
# @example Request syntax with placeholder values
|
2593
2670
|
#
|
@@ -2620,6 +2697,14 @@ module Aws::Backup
|
|
2620
2697
|
# ],
|
2621
2698
|
# },
|
2622
2699
|
# ],
|
2700
|
+
# advanced_backup_settings: [
|
2701
|
+
# {
|
2702
|
+
# resource_type: "ResourceType",
|
2703
|
+
# backup_options: {
|
2704
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
2705
|
+
# },
|
2706
|
+
# },
|
2707
|
+
# ],
|
2623
2708
|
# },
|
2624
2709
|
# })
|
2625
2710
|
#
|
@@ -2629,6 +2714,10 @@ module Aws::Backup
|
|
2629
2714
|
# resp.backup_plan_arn #=> String
|
2630
2715
|
# resp.creation_date #=> Time
|
2631
2716
|
# resp.version_id #=> String
|
2717
|
+
# resp.advanced_backup_settings #=> Array
|
2718
|
+
# resp.advanced_backup_settings[0].resource_type #=> String
|
2719
|
+
# resp.advanced_backup_settings[0].backup_options #=> Hash
|
2720
|
+
# resp.advanced_backup_settings[0].backup_options["BackupOptionKey"] #=> String
|
2632
2721
|
#
|
2633
2722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlan AWS API Documentation
|
2634
2723
|
#
|
@@ -2710,15 +2799,15 @@ module Aws::Backup
|
|
2710
2799
|
end
|
2711
2800
|
|
2712
2801
|
# Updates the current service opt-in settings for the Region. If the
|
2713
|
-
# service has a value set to `true`, AWS Backup
|
2802
|
+
# service has a value set to `true`, AWS Backup tries to protect that
|
2714
2803
|
# service's resources in this Region, when included in an on-demand
|
2715
2804
|
# backup or scheduled backup plan. If the value is set to `false` for a
|
2716
|
-
# service, AWS Backup does not
|
2717
|
-
#
|
2805
|
+
# service, AWS Backup does not try to protect that service's resources
|
2806
|
+
# in this Region.
|
2718
2807
|
#
|
2719
2808
|
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2720
2809
|
# Updates the list of services along with the opt-in preferences for the
|
2721
|
-
#
|
2810
|
+
# Region.
|
2722
2811
|
#
|
2723
2812
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2724
2813
|
#
|
@@ -2752,7 +2841,7 @@ module Aws::Backup
|
|
2752
2841
|
params: params,
|
2753
2842
|
config: config)
|
2754
2843
|
context[:gem_name] = 'aws-sdk-backup'
|
2755
|
-
context[:gem_version] = '1.
|
2844
|
+
context[:gem_version] = '1.23.0'
|
2756
2845
|
Seahorse::Client::Request.new(handlers, context)
|
2757
2846
|
end
|
2758
2847
|
|
@@ -15,10 +15,15 @@ module Aws::Backup
|
|
15
15
|
|
16
16
|
ARN = Shapes::StringShape.new(name: 'ARN')
|
17
17
|
AccountId = Shapes::StringShape.new(name: 'AccountId')
|
18
|
+
AdvancedBackupSetting = Shapes::StructureShape.new(name: 'AdvancedBackupSetting')
|
19
|
+
AdvancedBackupSettings = Shapes::ListShape.new(name: 'AdvancedBackupSettings')
|
18
20
|
AlreadyExistsException = Shapes::StructureShape.new(name: 'AlreadyExistsException')
|
19
21
|
BackupJob = Shapes::StructureShape.new(name: 'BackupJob')
|
20
22
|
BackupJobState = Shapes::StringShape.new(name: 'BackupJobState')
|
21
23
|
BackupJobsList = Shapes::ListShape.new(name: 'BackupJobsList')
|
24
|
+
BackupOptionKey = Shapes::StringShape.new(name: 'BackupOptionKey')
|
25
|
+
BackupOptionValue = Shapes::StringShape.new(name: 'BackupOptionValue')
|
26
|
+
BackupOptions = Shapes::MapShape.new(name: 'BackupOptions')
|
22
27
|
BackupPlan = Shapes::StructureShape.new(name: 'BackupPlan')
|
23
28
|
BackupPlanInput = Shapes::StructureShape.new(name: 'BackupPlanInput')
|
24
29
|
BackupPlanName = Shapes::StringShape.new(name: 'BackupPlanName')
|
@@ -181,6 +186,12 @@ module Aws::Backup
|
|
181
186
|
string = Shapes::StringShape.new(name: 'string')
|
182
187
|
timestamp = Shapes::TimestampShape.new(name: 'timestamp')
|
183
188
|
|
189
|
+
AdvancedBackupSetting.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
190
|
+
AdvancedBackupSetting.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
191
|
+
AdvancedBackupSetting.struct_class = Types::AdvancedBackupSetting
|
192
|
+
|
193
|
+
AdvancedBackupSettings.member = Shapes::ShapeRef.new(shape: AdvancedBackupSetting)
|
194
|
+
|
184
195
|
AlreadyExistsException.add_member(:code, Shapes::ShapeRef.new(shape: string, location_name: "Code"))
|
185
196
|
AlreadyExistsException.add_member(:message, Shapes::ShapeRef.new(shape: string, location_name: "Message"))
|
186
197
|
AlreadyExistsException.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId"))
|
@@ -207,16 +218,23 @@ module Aws::Backup
|
|
207
218
|
BackupJob.add_member(:start_by, Shapes::ShapeRef.new(shape: timestamp, location_name: "StartBy"))
|
208
219
|
BackupJob.add_member(:resource_type, Shapes::ShapeRef.new(shape: ResourceType, location_name: "ResourceType"))
|
209
220
|
BackupJob.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: Long, location_name: "BytesTransferred"))
|
221
|
+
BackupJob.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
222
|
+
BackupJob.add_member(:backup_type, Shapes::ShapeRef.new(shape: string, location_name: "BackupType"))
|
210
223
|
BackupJob.struct_class = Types::BackupJob
|
211
224
|
|
212
225
|
BackupJobsList.member = Shapes::ShapeRef.new(shape: BackupJob)
|
213
226
|
|
227
|
+
BackupOptions.key = Shapes::ShapeRef.new(shape: BackupOptionKey)
|
228
|
+
BackupOptions.value = Shapes::ShapeRef.new(shape: BackupOptionValue)
|
229
|
+
|
214
230
|
BackupPlan.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, required: true, location_name: "BackupPlanName"))
|
215
231
|
BackupPlan.add_member(:rules, Shapes::ShapeRef.new(shape: BackupRules, required: true, location_name: "Rules"))
|
232
|
+
BackupPlan.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
216
233
|
BackupPlan.struct_class = Types::BackupPlan
|
217
234
|
|
218
235
|
BackupPlanInput.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, required: true, location_name: "BackupPlanName"))
|
219
236
|
BackupPlanInput.add_member(:rules, Shapes::ShapeRef.new(shape: BackupRulesInput, required: true, location_name: "Rules"))
|
237
|
+
BackupPlanInput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
220
238
|
BackupPlanInput.struct_class = Types::BackupPlanInput
|
221
239
|
|
222
240
|
BackupPlanTemplatesList.member = Shapes::ShapeRef.new(shape: BackupPlanTemplatesListMember)
|
@@ -237,6 +255,7 @@ module Aws::Backup
|
|
237
255
|
BackupPlansListMember.add_member(:backup_plan_name, Shapes::ShapeRef.new(shape: BackupPlanName, location_name: "BackupPlanName"))
|
238
256
|
BackupPlansListMember.add_member(:creator_request_id, Shapes::ShapeRef.new(shape: string, location_name: "CreatorRequestId"))
|
239
257
|
BackupPlansListMember.add_member(:last_execution_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastExecutionDate"))
|
258
|
+
BackupPlansListMember.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
240
259
|
BackupPlansListMember.struct_class = Types::BackupPlansListMember
|
241
260
|
|
242
261
|
BackupRule.add_member(:rule_name, Shapes::ShapeRef.new(shape: BackupRuleName, required: true, location_name: "RuleName"))
|
@@ -335,6 +354,7 @@ module Aws::Backup
|
|
335
354
|
CreateBackupPlanOutput.add_member(:backup_plan_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupPlanArn"))
|
336
355
|
CreateBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
337
356
|
CreateBackupPlanOutput.add_member(:version_id, Shapes::ShapeRef.new(shape: string, location_name: "VersionId"))
|
357
|
+
CreateBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
338
358
|
CreateBackupPlanOutput.struct_class = Types::CreateBackupPlanOutput
|
339
359
|
|
340
360
|
CreateBackupSelectionInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -411,6 +431,8 @@ module Aws::Backup
|
|
411
431
|
DescribeBackupJobOutput.add_member(:bytes_transferred, Shapes::ShapeRef.new(shape: Long, location_name: "BytesTransferred"))
|
412
432
|
DescribeBackupJobOutput.add_member(:expected_completion_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "ExpectedCompletionDate"))
|
413
433
|
DescribeBackupJobOutput.add_member(:start_by, Shapes::ShapeRef.new(shape: timestamp, location_name: "StartBy"))
|
434
|
+
DescribeBackupJobOutput.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
435
|
+
DescribeBackupJobOutput.add_member(:backup_type, Shapes::ShapeRef.new(shape: string, location_name: "BackupType"))
|
414
436
|
DescribeBackupJobOutput.struct_class = Types::DescribeBackupJobOutput
|
415
437
|
|
416
438
|
DescribeBackupVaultInput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupVaultName"))
|
@@ -514,6 +536,7 @@ module Aws::Backup
|
|
514
536
|
GetBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
515
537
|
GetBackupPlanOutput.add_member(:deletion_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "DeletionDate"))
|
516
538
|
GetBackupPlanOutput.add_member(:last_execution_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "LastExecutionDate"))
|
539
|
+
GetBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
517
540
|
GetBackupPlanOutput.struct_class = Types::GetBackupPlanOutput
|
518
541
|
|
519
542
|
GetBackupSelectionInput.add_member(:backup_plan_id, Shapes::ShapeRef.new(shape: string, required: true, location: "uri", location_name: "backupPlanId"))
|
@@ -810,6 +833,7 @@ module Aws::Backup
|
|
810
833
|
StartBackupJobInput.add_member(:complete_window_minutes, Shapes::ShapeRef.new(shape: WindowMinutes, location_name: "CompleteWindowMinutes"))
|
811
834
|
StartBackupJobInput.add_member(:lifecycle, Shapes::ShapeRef.new(shape: Lifecycle, location_name: "Lifecycle"))
|
812
835
|
StartBackupJobInput.add_member(:recovery_point_tags, Shapes::ShapeRef.new(shape: Tags, location_name: "RecoveryPointTags"))
|
836
|
+
StartBackupJobInput.add_member(:backup_options, Shapes::ShapeRef.new(shape: BackupOptions, location_name: "BackupOptions"))
|
813
837
|
StartBackupJobInput.struct_class = Types::StartBackupJobInput
|
814
838
|
|
815
839
|
StartBackupJobOutput.add_member(:backup_job_id, Shapes::ShapeRef.new(shape: string, location_name: "BackupJobId"))
|
@@ -863,6 +887,7 @@ module Aws::Backup
|
|
863
887
|
UpdateBackupPlanOutput.add_member(:backup_plan_arn, Shapes::ShapeRef.new(shape: ARN, location_name: "BackupPlanArn"))
|
864
888
|
UpdateBackupPlanOutput.add_member(:creation_date, Shapes::ShapeRef.new(shape: timestamp, location_name: "CreationDate"))
|
865
889
|
UpdateBackupPlanOutput.add_member(:version_id, Shapes::ShapeRef.new(shape: string, location_name: "VersionId"))
|
890
|
+
UpdateBackupPlanOutput.add_member(:advanced_backup_settings, Shapes::ShapeRef.new(shape: AdvancedBackupSettings, location_name: "AdvancedBackupSettings"))
|
866
891
|
UpdateBackupPlanOutput.struct_class = Types::UpdateBackupPlanOutput
|
867
892
|
|
868
893
|
UpdateRecoveryPointLifecycleInput.add_member(:backup_vault_name, Shapes::ShapeRef.new(shape: BackupVaultName, required: true, location: "uri", location_name: "backupVaultName"))
|
data/lib/aws-sdk-backup/types.rb
CHANGED
@@ -10,6 +10,52 @@
|
|
10
10
|
module Aws::Backup
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# A list of backup options for each resource type.
|
14
|
+
#
|
15
|
+
# @note When making an API call, you may pass AdvancedBackupSetting
|
16
|
+
# data as a hash:
|
17
|
+
#
|
18
|
+
# {
|
19
|
+
# resource_type: "ResourceType",
|
20
|
+
# backup_options: {
|
21
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
22
|
+
# },
|
23
|
+
# }
|
24
|
+
#
|
25
|
+
# @!attribute [rw] resource_type
|
26
|
+
# The type of AWS resource to be backed up. For VSS Windows backups,
|
27
|
+
# the only supported resource type is Amazon EC2.
|
28
|
+
#
|
29
|
+
# Valid values: `EC2`.
|
30
|
+
# @return [String]
|
31
|
+
#
|
32
|
+
# @!attribute [rw] backup_options
|
33
|
+
# Specifies the backup option for a selected resource. This option is
|
34
|
+
# only available for Windows VSS backup jobs.
|
35
|
+
#
|
36
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
37
|
+
# Windows backup; otherwise, creates a regular backup.
|
38
|
+
#
|
39
|
+
# If you specify an invalid option, you get an
|
40
|
+
# `InvalidParameterValueException` exception.
|
41
|
+
#
|
42
|
+
# For more information about Windows VSS backups, see [Creating a
|
43
|
+
# VSS-Enabled Windows Backup][1].
|
44
|
+
#
|
45
|
+
#
|
46
|
+
#
|
47
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html
|
48
|
+
# @return [Hash<String,String>]
|
49
|
+
#
|
50
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/AdvancedBackupSetting AWS API Documentation
|
51
|
+
#
|
52
|
+
class AdvancedBackupSetting < Struct.new(
|
53
|
+
:resource_type,
|
54
|
+
:backup_options)
|
55
|
+
SENSITIVE = []
|
56
|
+
include Aws::Structure
|
57
|
+
end
|
58
|
+
|
13
59
|
# The required resource already exists.
|
14
60
|
#
|
15
61
|
# @!attribute [rw] code
|
@@ -141,7 +187,8 @@ module Aws::Backup
|
|
141
187
|
# @!attribute [rw] resource_type
|
142
188
|
# The type of AWS resource to be backed up; for example, an Amazon
|
143
189
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
144
|
-
# Database Service (Amazon RDS) database.
|
190
|
+
# Database Service (Amazon RDS) database. For VSS Windows backups, the
|
191
|
+
# only supported resource type is Amazon EC2.
|
145
192
|
# @return [String]
|
146
193
|
#
|
147
194
|
# @!attribute [rw] bytes_transferred
|
@@ -149,6 +196,20 @@ module Aws::Backup
|
|
149
196
|
# job status was queried.
|
150
197
|
# @return [Integer]
|
151
198
|
#
|
199
|
+
# @!attribute [rw] backup_options
|
200
|
+
# Specifies the backup option for a selected resource. This option is
|
201
|
+
# only available for Windows VSS backup jobs.
|
202
|
+
#
|
203
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
204
|
+
# Windows backup; otherwise, creates a regular backup. If you specify
|
205
|
+
# an invalid option, you get an `InvalidParameterValueException`
|
206
|
+
# exception.
|
207
|
+
# @return [Hash<String,String>]
|
208
|
+
#
|
209
|
+
# @!attribute [rw] backup_type
|
210
|
+
# Represents the type of backup for a backup job.
|
211
|
+
# @return [String]
|
212
|
+
#
|
152
213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupJob AWS API Documentation
|
153
214
|
#
|
154
215
|
class BackupJob < Struct.new(
|
@@ -169,7 +230,9 @@ module Aws::Backup
|
|
169
230
|
:expected_completion_date,
|
170
231
|
:start_by,
|
171
232
|
:resource_type,
|
172
|
-
:bytes_transferred
|
233
|
+
:bytes_transferred,
|
234
|
+
:backup_options,
|
235
|
+
:backup_type)
|
173
236
|
SENSITIVE = []
|
174
237
|
include Aws::Structure
|
175
238
|
end
|
@@ -188,11 +251,16 @@ module Aws::Backup
|
|
188
251
|
# scheduled task that is used to back up a selection of resources.
|
189
252
|
# @return [Array<Types::BackupRule>]
|
190
253
|
#
|
254
|
+
# @!attribute [rw] advanced_backup_settings
|
255
|
+
# Contains a list of `BackupOptions` for each resource type.
|
256
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
257
|
+
#
|
191
258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlan AWS API Documentation
|
192
259
|
#
|
193
260
|
class BackupPlan < Struct.new(
|
194
261
|
:backup_plan_name,
|
195
|
-
:rules
|
262
|
+
:rules,
|
263
|
+
:advanced_backup_settings)
|
196
264
|
SENSITIVE = []
|
197
265
|
include Aws::Structure
|
198
266
|
end
|
@@ -232,6 +300,14 @@ module Aws::Backup
|
|
232
300
|
# ],
|
233
301
|
# },
|
234
302
|
# ],
|
303
|
+
# advanced_backup_settings: [
|
304
|
+
# {
|
305
|
+
# resource_type: "ResourceType",
|
306
|
+
# backup_options: {
|
307
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
308
|
+
# },
|
309
|
+
# },
|
310
|
+
# ],
|
235
311
|
# }
|
236
312
|
#
|
237
313
|
# @!attribute [rw] backup_plan_name
|
@@ -243,11 +319,17 @@ module Aws::Backup
|
|
243
319
|
# scheduled task that is used to back up a selection of resources.
|
244
320
|
# @return [Array<Types::BackupRuleInput>]
|
245
321
|
#
|
322
|
+
# @!attribute [rw] advanced_backup_settings
|
323
|
+
# Specifies a list of `BackupOptions` for each resource type. These
|
324
|
+
# settings are only available for Windows VSS backup jobs.
|
325
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
326
|
+
#
|
246
327
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlanInput AWS API Documentation
|
247
328
|
#
|
248
329
|
class BackupPlanInput < Struct.new(
|
249
330
|
:backup_plan_name,
|
250
|
-
:rules
|
331
|
+
:rules,
|
332
|
+
:advanced_backup_settings)
|
251
333
|
SENSITIVE = []
|
252
334
|
include Aws::Structure
|
253
335
|
end
|
@@ -308,18 +390,22 @@ module Aws::Backup
|
|
308
390
|
#
|
309
391
|
# @!attribute [rw] creator_request_id
|
310
392
|
# A unique string that identifies the request and allows failed
|
311
|
-
# requests to be retried without the risk of
|
393
|
+
# requests to be retried without the risk of running the operation
|
312
394
|
# twice.
|
313
395
|
# @return [String]
|
314
396
|
#
|
315
397
|
# @!attribute [rw] last_execution_date
|
316
|
-
# The last time a job to back up resources was
|
317
|
-
#
|
318
|
-
#
|
319
|
-
#
|
398
|
+
# The last time a job to back up resources was run with this rule. A
|
399
|
+
# date and time, in Unix format and Coordinated Universal Time (UTC).
|
400
|
+
# The value of `LastExecutionDate` is accurate to milliseconds. For
|
401
|
+
# example, the value 1516925490.087 represents Friday, January 26,
|
320
402
|
# 2018 12:11:30.087 AM.
|
321
403
|
# @return [Time]
|
322
404
|
#
|
405
|
+
# @!attribute [rw] advanced_backup_settings
|
406
|
+
# Contains a list of `BackupOptions` for a resource type.
|
407
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
408
|
+
#
|
323
409
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/BackupPlansListMember AWS API Documentation
|
324
410
|
#
|
325
411
|
class BackupPlansListMember < Struct.new(
|
@@ -330,7 +416,8 @@ module Aws::Backup
|
|
330
416
|
:version_id,
|
331
417
|
:backup_plan_name,
|
332
418
|
:creator_request_id,
|
333
|
-
:last_execution_date
|
419
|
+
:last_execution_date,
|
420
|
+
:advanced_backup_settings)
|
334
421
|
SENSITIVE = []
|
335
422
|
include Aws::Structure
|
336
423
|
end
|
@@ -523,7 +610,7 @@ module Aws::Backup
|
|
523
610
|
#
|
524
611
|
# @!attribute [rw] iam_role_arn
|
525
612
|
# The ARN of the IAM role that AWS Backup uses to authenticate when
|
526
|
-
#
|
613
|
+
# backing up the target resource; for example,
|
527
614
|
# `arn:aws:iam::123456789012:role/S3Access`.
|
528
615
|
# @return [String]
|
529
616
|
#
|
@@ -534,7 +621,7 @@ module Aws::Backup
|
|
534
621
|
#
|
535
622
|
# @!attribute [rw] list_of_tags
|
536
623
|
# An array of conditions used to specify a set of resources to assign
|
537
|
-
# to a backup plan; for example, `"
|
624
|
+
# to a backup plan; for example, `"StringEquals":
|
538
625
|
# \{"ec2:ResourceTag/Department": "accounting"`.
|
539
626
|
# @return [Array<Types::Condition>]
|
540
627
|
#
|
@@ -573,7 +660,7 @@ module Aws::Backup
|
|
573
660
|
#
|
574
661
|
# @!attribute [rw] creator_request_id
|
575
662
|
# A unique string that identifies the request and allows failed
|
576
|
-
# requests to be retried without the risk of
|
663
|
+
# requests to be retried without the risk of running the operation
|
577
664
|
# twice.
|
578
665
|
# @return [String]
|
579
666
|
#
|
@@ -626,7 +713,7 @@ module Aws::Backup
|
|
626
713
|
#
|
627
714
|
# @!attribute [rw] creator_request_id
|
628
715
|
# A unique string that identifies the request and allows failed
|
629
|
-
# requests to be retried without the risk of
|
716
|
+
# requests to be retried without the risk of running the operation
|
630
717
|
# twice.
|
631
718
|
# @return [String]
|
632
719
|
#
|
@@ -679,7 +766,7 @@ module Aws::Backup
|
|
679
766
|
end
|
680
767
|
|
681
768
|
# Contains an array of triplets made up of a condition type (such as
|
682
|
-
# `
|
769
|
+
# `StringEquals`), a key, and a value. Conditions are used to filter
|
683
770
|
# resources in a selection that is assigned to a backup plan.
|
684
771
|
#
|
685
772
|
# @note When making an API call, you may pass Condition
|
@@ -692,7 +779,7 @@ module Aws::Backup
|
|
692
779
|
# }
|
693
780
|
#
|
694
781
|
# @!attribute [rw] condition_type
|
695
|
-
# An operation, such as `
|
782
|
+
# An operation, such as `StringEquals`, that is applied to a key-value
|
696
783
|
# pair used to filter resources in a selection.
|
697
784
|
# @return [String]
|
698
785
|
#
|
@@ -895,6 +982,14 @@ module Aws::Backup
|
|
895
982
|
# ],
|
896
983
|
# },
|
897
984
|
# ],
|
985
|
+
# advanced_backup_settings: [
|
986
|
+
# {
|
987
|
+
# resource_type: "ResourceType",
|
988
|
+
# backup_options: {
|
989
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
990
|
+
# },
|
991
|
+
# },
|
992
|
+
# ],
|
898
993
|
# },
|
899
994
|
# backup_plan_tags: {
|
900
995
|
# "TagKey" => "TagValue",
|
@@ -915,7 +1010,7 @@ module Aws::Backup
|
|
915
1010
|
#
|
916
1011
|
# @!attribute [rw] creator_request_id
|
917
1012
|
# Identifies the request and allows failed requests to be retried
|
918
|
-
# without the risk of
|
1013
|
+
# without the risk of running the operation twice. If the request
|
919
1014
|
# includes a `CreatorRequestId` that matches an existing backup plan,
|
920
1015
|
# that plan is returned. This parameter is optional.
|
921
1016
|
# @return [String]
|
@@ -952,13 +1047,19 @@ module Aws::Backup
|
|
952
1047
|
# at most 1,024 bytes long. They cannot be edited.
|
953
1048
|
# @return [String]
|
954
1049
|
#
|
1050
|
+
# @!attribute [rw] advanced_backup_settings
|
1051
|
+
# A list of `BackupOptions` settings for a resource type. This option
|
1052
|
+
# is only available for Windows VSS backup jobs.
|
1053
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
1054
|
+
#
|
955
1055
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlanOutput AWS API Documentation
|
956
1056
|
#
|
957
1057
|
class CreateBackupPlanOutput < Struct.new(
|
958
1058
|
:backup_plan_id,
|
959
1059
|
:backup_plan_arn,
|
960
1060
|
:creation_date,
|
961
|
-
:version_id
|
1061
|
+
:version_id,
|
1062
|
+
:advanced_backup_settings)
|
962
1063
|
SENSITIVE = []
|
963
1064
|
include Aws::Structure
|
964
1065
|
end
|
@@ -995,7 +1096,7 @@ module Aws::Backup
|
|
995
1096
|
#
|
996
1097
|
# @!attribute [rw] creator_request_id
|
997
1098
|
# A unique string that identifies the request and allows failed
|
998
|
-
# requests to be retried without the risk of
|
1099
|
+
# requests to be retried without the risk of running the operation
|
999
1100
|
# twice.
|
1000
1101
|
# @return [String]
|
1001
1102
|
#
|
@@ -1067,7 +1168,7 @@ module Aws::Backup
|
|
1067
1168
|
#
|
1068
1169
|
# @!attribute [rw] creator_request_id
|
1069
1170
|
# A unique string that identifies the request and allows failed
|
1070
|
-
# requests to be retried without the risk of
|
1171
|
+
# requests to be retried without the risk of running the operation
|
1071
1172
|
# twice.
|
1072
1173
|
# @return [String]
|
1073
1174
|
#
|
@@ -1150,7 +1251,7 @@ module Aws::Backup
|
|
1150
1251
|
#
|
1151
1252
|
# @!attribute [rw] version_id
|
1152
1253
|
# Unique, randomly generated, Unicode, UTF-8 encoded strings that are
|
1153
|
-
# at most 1,024 bytes long. Version
|
1254
|
+
# at most 1,024 bytes long. Version IDs cannot be edited.
|
1154
1255
|
# @return [String]
|
1155
1256
|
#
|
1156
1257
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupPlanOutput AWS API Documentation
|
@@ -1435,6 +1536,18 @@ module Aws::Backup
|
|
1435
1536
|
# 12:11:30.087 AM.
|
1436
1537
|
# @return [Time]
|
1437
1538
|
#
|
1539
|
+
# @!attribute [rw] backup_options
|
1540
|
+
# Represents the options specified as part of backup plan or on-demand
|
1541
|
+
# backup job.
|
1542
|
+
# @return [Hash<String,String>]
|
1543
|
+
#
|
1544
|
+
# @!attribute [rw] backup_type
|
1545
|
+
# Represents the actual backup type selected for a backup job. For
|
1546
|
+
# example, if a successful WindowsVSS backup was taken, `BackupType`
|
1547
|
+
# returns “WindowsVSS”. If `BackupType` is empty, then it is a regular
|
1548
|
+
# backup.
|
1549
|
+
# @return [String]
|
1550
|
+
#
|
1438
1551
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJobOutput AWS API Documentation
|
1439
1552
|
#
|
1440
1553
|
class DescribeBackupJobOutput < Struct.new(
|
@@ -1455,7 +1568,9 @@ module Aws::Backup
|
|
1455
1568
|
:resource_type,
|
1456
1569
|
:bytes_transferred,
|
1457
1570
|
:expected_completion_date,
|
1458
|
-
:start_by
|
1571
|
+
:start_by,
|
1572
|
+
:backup_options,
|
1573
|
+
:backup_type)
|
1459
1574
|
SENSITIVE = []
|
1460
1575
|
include Aws::Structure
|
1461
1576
|
end
|
@@ -1510,7 +1625,7 @@ module Aws::Backup
|
|
1510
1625
|
#
|
1511
1626
|
# @!attribute [rw] creator_request_id
|
1512
1627
|
# A unique string that identifies the request and allows failed
|
1513
|
-
# requests to be retried without the risk of
|
1628
|
+
# requests to be retried without the risk of running the operation
|
1514
1629
|
# twice.
|
1515
1630
|
# @return [String]
|
1516
1631
|
#
|
@@ -1781,7 +1896,7 @@ module Aws::Backup
|
|
1781
1896
|
|
1782
1897
|
# @!attribute [rw] resource_type_opt_in_preference
|
1783
1898
|
# Returns a list of all services along with the opt-in preferences in
|
1784
|
-
# the
|
1899
|
+
# the Region.
|
1785
1900
|
# @return [Hash<String,Boolean>]
|
1786
1901
|
#
|
1787
1902
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettingsOutput AWS API Documentation
|
@@ -2046,7 +2161,7 @@ module Aws::Backup
|
|
2046
2161
|
#
|
2047
2162
|
# @!attribute [rw] creator_request_id
|
2048
2163
|
# A unique string that identifies the request and allows failed
|
2049
|
-
# requests to be retried without the risk of
|
2164
|
+
# requests to be retried without the risk of running the operation
|
2050
2165
|
# twice.
|
2051
2166
|
# @return [String]
|
2052
2167
|
#
|
@@ -2065,13 +2180,18 @@ module Aws::Backup
|
|
2065
2180
|
# @return [Time]
|
2066
2181
|
#
|
2067
2182
|
# @!attribute [rw] last_execution_date
|
2068
|
-
# The last time a job to back up resources was
|
2069
|
-
#
|
2070
|
-
#
|
2071
|
-
#
|
2072
|
-
#
|
2183
|
+
# The last time a job to back up resources was run with this backup
|
2184
|
+
# plan. A date and time, in Unix format and Coordinated Universal Time
|
2185
|
+
# (UTC). The value of `LastExecutionDate` is accurate to milliseconds.
|
2186
|
+
# For example, the value 1516925490.087 represents Friday, January 26,
|
2187
|
+
# 2018 12:11:30.087 AM.
|
2073
2188
|
# @return [Time]
|
2074
2189
|
#
|
2190
|
+
# @!attribute [rw] advanced_backup_settings
|
2191
|
+
# Contains a list of `BackupOptions` for each resource type. The list
|
2192
|
+
# is populated only if the advanced option is set for the backup plan.
|
2193
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
2194
|
+
#
|
2075
2195
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanOutput AWS API Documentation
|
2076
2196
|
#
|
2077
2197
|
class GetBackupPlanOutput < Struct.new(
|
@@ -2082,7 +2202,8 @@ module Aws::Backup
|
|
2082
2202
|
:creator_request_id,
|
2083
2203
|
:creation_date,
|
2084
2204
|
:deletion_date,
|
2085
|
-
:last_execution_date
|
2205
|
+
:last_execution_date,
|
2206
|
+
:advanced_backup_settings)
|
2086
2207
|
SENSITIVE = []
|
2087
2208
|
include Aws::Structure
|
2088
2209
|
end
|
@@ -2136,7 +2257,7 @@ module Aws::Backup
|
|
2136
2257
|
#
|
2137
2258
|
# @!attribute [rw] creator_request_id
|
2138
2259
|
# A unique string that identifies the request and allows failed
|
2139
|
-
# requests to be retried without the risk of
|
2260
|
+
# requests to be retried without the risk of running the operation
|
2140
2261
|
# twice.
|
2141
2262
|
# @return [String]
|
2142
2263
|
#
|
@@ -2299,7 +2420,7 @@ module Aws::Backup
|
|
2299
2420
|
# @return [String]
|
2300
2421
|
#
|
2301
2422
|
# @!attribute [rw] restore_metadata
|
2302
|
-
# The set of metadata key-value pairs that
|
2423
|
+
# The set of metadata key-value pairs that describe the original
|
2303
2424
|
# configuration of the backed-up resource. These values vary depending
|
2304
2425
|
# on the service that is being restored.
|
2305
2426
|
# @return [Hash<String,String>]
|
@@ -3301,7 +3422,8 @@ module Aws::Backup
|
|
3301
3422
|
# @!attribute [rw] resource_type
|
3302
3423
|
# The type of AWS resource; for example, an Amazon Elastic Block Store
|
3303
3424
|
# (Amazon EBS) volume or an Amazon Relational Database Service (Amazon
|
3304
|
-
# RDS) database.
|
3425
|
+
# RDS) database. For VSS Windows backups, the only supported resource
|
3426
|
+
# type is Amazon EC2.
|
3305
3427
|
# @return [String]
|
3306
3428
|
#
|
3307
3429
|
# @!attribute [rw] last_backup_time
|
@@ -3415,7 +3537,8 @@ module Aws::Backup
|
|
3415
3537
|
# @!attribute [rw] resource_type
|
3416
3538
|
# The type of AWS resource saved as a recovery point; for example, an
|
3417
3539
|
# Amazon Elastic Block Store (Amazon EBS) volume or an Amazon
|
3418
|
-
# Relational Database Service (Amazon RDS) database.
|
3540
|
+
# Relational Database Service (Amazon RDS) database. For VSS Windows
|
3541
|
+
# backups, the only supported resource type is Amazon EC2.
|
3419
3542
|
# @return [String]
|
3420
3543
|
#
|
3421
3544
|
# @!attribute [rw] created_by
|
@@ -3685,7 +3808,8 @@ module Aws::Backup
|
|
3685
3808
|
# @!attribute [rw] resource_type
|
3686
3809
|
# The resource type of the listed restore jobs; for example, an Amazon
|
3687
3810
|
# Elastic Block Store (Amazon EBS) volume or an Amazon Relational
|
3688
|
-
# Database Service (Amazon RDS) database.
|
3811
|
+
# Database Service (Amazon RDS) database. For VSS Windows backups, the
|
3812
|
+
# only supported resource type is Amazon EC2.
|
3689
3813
|
# @return [String]
|
3690
3814
|
#
|
3691
3815
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/RestoreJobsListMember AWS API Documentation
|
@@ -3750,6 +3874,9 @@ module Aws::Backup
|
|
3750
3874
|
# recovery_point_tags: {
|
3751
3875
|
# "TagKey" => "TagValue",
|
3752
3876
|
# },
|
3877
|
+
# backup_options: {
|
3878
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
3879
|
+
# },
|
3753
3880
|
# }
|
3754
3881
|
#
|
3755
3882
|
# @!attribute [rw] backup_vault_name
|
@@ -3803,6 +3930,14 @@ module Aws::Backup
|
|
3803
3930
|
# the resources that you create. Each tag is a key-value pair.
|
3804
3931
|
# @return [Hash<String,String>]
|
3805
3932
|
#
|
3933
|
+
# @!attribute [rw] backup_options
|
3934
|
+
# Specifies the backup option for a selected resource. This option is
|
3935
|
+
# only available for Windows VSS backup jobs.
|
3936
|
+
#
|
3937
|
+
# Valid value: `"WindowsVSS”:“enabled"`. If enabled, creates a VSS
|
3938
|
+
# Windows backup; otherwise, creates a regular backup.
|
3939
|
+
# @return [Hash<String,String>]
|
3940
|
+
#
|
3806
3941
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJobInput AWS API Documentation
|
3807
3942
|
#
|
3808
3943
|
class StartBackupJobInput < Struct.new(
|
@@ -3813,7 +3948,8 @@ module Aws::Backup
|
|
3813
3948
|
:start_window_minutes,
|
3814
3949
|
:complete_window_minutes,
|
3815
3950
|
:lifecycle,
|
3816
|
-
:recovery_point_tags
|
3951
|
+
:recovery_point_tags,
|
3952
|
+
:backup_options)
|
3817
3953
|
SENSITIVE = [:recovery_point_tags]
|
3818
3954
|
include Aws::Structure
|
3819
3955
|
end
|
@@ -3966,8 +4102,9 @@ module Aws::Backup
|
|
3966
4102
|
# You need to specify specific metadata to restore an Amazon Elastic
|
3967
4103
|
# File System (Amazon EFS) instance:
|
3968
4104
|
#
|
3969
|
-
# * `file-system-id`\: ID of the Amazon EFS file system that is
|
3970
|
-
# up by AWS Backup. Returned in
|
4105
|
+
# * `file-system-id`\: The ID of the Amazon EFS file system that is
|
4106
|
+
# backed up by AWS Backup. Returned in
|
4107
|
+
# `GetRecoveryPointRestoreMetadata`.
|
3971
4108
|
#
|
3972
4109
|
# * `Encrypted`\: A Boolean value that, if true, specifies that the
|
3973
4110
|
# file system is encrypted. If `KmsKeyId` is specified, `Encrypted`
|
@@ -4145,6 +4282,14 @@ module Aws::Backup
|
|
4145
4282
|
# ],
|
4146
4283
|
# },
|
4147
4284
|
# ],
|
4285
|
+
# advanced_backup_settings: [
|
4286
|
+
# {
|
4287
|
+
# resource_type: "ResourceType",
|
4288
|
+
# backup_options: {
|
4289
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
4290
|
+
# },
|
4291
|
+
# },
|
4292
|
+
# ],
|
4148
4293
|
# },
|
4149
4294
|
# }
|
4150
4295
|
#
|
@@ -4188,13 +4333,18 @@ module Aws::Backup
|
|
4188
4333
|
# at most 1,024 bytes long. Version Ids cannot be edited.
|
4189
4334
|
# @return [String]
|
4190
4335
|
#
|
4336
|
+
# @!attribute [rw] advanced_backup_settings
|
4337
|
+
# Contains a list of `BackupOptions` for each resource type.
|
4338
|
+
# @return [Array<Types::AdvancedBackupSetting>]
|
4339
|
+
#
|
4191
4340
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlanOutput AWS API Documentation
|
4192
4341
|
#
|
4193
4342
|
class UpdateBackupPlanOutput < Struct.new(
|
4194
4343
|
:backup_plan_id,
|
4195
4344
|
:backup_plan_arn,
|
4196
4345
|
:creation_date,
|
4197
|
-
:version_id
|
4346
|
+
:version_id,
|
4347
|
+
:advanced_backup_settings)
|
4198
4348
|
SENSITIVE = []
|
4199
4349
|
include Aws::Structure
|
4200
4350
|
end
|
@@ -4296,7 +4446,7 @@ module Aws::Backup
|
|
4296
4446
|
#
|
4297
4447
|
# @!attribute [rw] resource_type_opt_in_preference
|
4298
4448
|
# Updates the list of services along with the opt-in preferences for
|
4299
|
-
# the
|
4449
|
+
# the Region.
|
4300
4450
|
# @return [Hash<String,Boolean>]
|
4301
4451
|
#
|
4302
4452
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettingsInput AWS API Documentation
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-backup
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.23.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-09-30 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|
@@ -19,7 +19,7 @@ dependencies:
|
|
19
19
|
version: '3'
|
20
20
|
- - ">="
|
21
21
|
- !ruby/object:Gem::Version
|
22
|
-
version: 3.
|
22
|
+
version: 3.109.0
|
23
23
|
type: :runtime
|
24
24
|
prerelease: false
|
25
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -29,7 +29,7 @@ dependencies:
|
|
29
29
|
version: '3'
|
30
30
|
- - ">="
|
31
31
|
- !ruby/object:Gem::Version
|
32
|
-
version: 3.
|
32
|
+
version: 3.109.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|