aws-sdk-backup 1.17.0 → 1.22.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 +179 -44
- data/lib/aws-sdk-backup/client_api.rb +39 -1
- data/lib/aws-sdk-backup/types.rb +299 -61
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 37a06a07c9745d2a3f44563afa9db98cc825c4520c93bae7d714bcbce31751dd
|
4
|
+
data.tar.gz: c951b78aa10d4f7524f5fbd2ee6bcbe44d3035fefd6418a7564d98f0d3501985
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d3f6ecadeb81d63f8ce0b8d235c3b8637b7c16455992784c10a74e007d67591feeb5d80f83ee1bf7732a810d2303f88f9262cdd0302d99195f255da8f9086079
|
7
|
+
data.tar.gz: 1218ae1de7d70c49afc2b9a494d68ee77e4c136b2976238d4fa872fb2909b50db6c8415c468defd51c99e085a13090abd0a27cb7ebe3d940ccb8df3c673dfb14
|
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.22.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,13 +738,14 @@ 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.
|
716
745
|
#
|
717
746
|
# @return [Types::DescribeBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
718
747
|
#
|
748
|
+
# * {Types::DescribeBackupJobOutput#account_id #account_id} => String
|
719
749
|
# * {Types::DescribeBackupJobOutput#backup_job_id #backup_job_id} => String
|
720
750
|
# * {Types::DescribeBackupJobOutput#backup_vault_name #backup_vault_name} => String
|
721
751
|
# * {Types::DescribeBackupJobOutput#backup_vault_arn #backup_vault_arn} => String
|
@@ -733,6 +763,8 @@ module Aws::Backup
|
|
733
763
|
# * {Types::DescribeBackupJobOutput#bytes_transferred #bytes_transferred} => Integer
|
734
764
|
# * {Types::DescribeBackupJobOutput#expected_completion_date #expected_completion_date} => Time
|
735
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
|
736
768
|
#
|
737
769
|
# @example Request syntax with placeholder values
|
738
770
|
#
|
@@ -742,6 +774,7 @@ module Aws::Backup
|
|
742
774
|
#
|
743
775
|
# @example Response structure
|
744
776
|
#
|
777
|
+
# resp.account_id #=> String
|
745
778
|
# resp.backup_job_id #=> String
|
746
779
|
# resp.backup_vault_name #=> String
|
747
780
|
# resp.backup_vault_arn #=> String
|
@@ -762,6 +795,9 @@ module Aws::Backup
|
|
762
795
|
# resp.bytes_transferred #=> Integer
|
763
796
|
# resp.expected_completion_date #=> Time
|
764
797
|
# resp.start_by #=> Time
|
798
|
+
# resp.backup_options #=> Hash
|
799
|
+
# resp.backup_options["BackupOptionKey"] #=> String
|
800
|
+
# resp.backup_type #=> String
|
765
801
|
#
|
766
802
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob AWS API Documentation
|
767
803
|
#
|
@@ -830,6 +866,7 @@ module Aws::Backup
|
|
830
866
|
#
|
831
867
|
# @example Response structure
|
832
868
|
#
|
869
|
+
# resp.copy_job.account_id #=> String
|
833
870
|
# resp.copy_job.copy_job_id #=> String
|
834
871
|
# resp.copy_job.source_backup_vault_arn #=> String
|
835
872
|
# resp.copy_job.source_recovery_point_arn #=> String
|
@@ -967,12 +1004,12 @@ module Aws::Backup
|
|
967
1004
|
req.send_request(options)
|
968
1005
|
end
|
969
1006
|
|
970
|
-
# Returns the current service opt-in settings for the
|
971
|
-
# service has a value set to true
|
972
|
-
#
|
973
|
-
#
|
974
|
-
#
|
975
|
-
#
|
1007
|
+
# Returns the current service opt-in settings for the Region. If the
|
1008
|
+
# service has a value set to `true`, AWS Backup tries to protect that
|
1009
|
+
# service's resources in this Region, when included in an on-demand
|
1010
|
+
# backup or scheduled backup plan. If the value is set to `false` for a
|
1011
|
+
# service, AWS Backup does not try to protect that service's resources
|
1012
|
+
# in this Region.
|
976
1013
|
#
|
977
1014
|
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
978
1015
|
#
|
@@ -1000,6 +1037,7 @@ module Aws::Backup
|
|
1000
1037
|
#
|
1001
1038
|
# @return [Types::DescribeRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1002
1039
|
#
|
1040
|
+
# * {Types::DescribeRestoreJobOutput#account_id #account_id} => String
|
1003
1041
|
# * {Types::DescribeRestoreJobOutput#restore_job_id #restore_job_id} => String
|
1004
1042
|
# * {Types::DescribeRestoreJobOutput#recovery_point_arn #recovery_point_arn} => String
|
1005
1043
|
# * {Types::DescribeRestoreJobOutput#creation_date #creation_date} => Time
|
@@ -1011,6 +1049,7 @@ module Aws::Backup
|
|
1011
1049
|
# * {Types::DescribeRestoreJobOutput#iam_role_arn #iam_role_arn} => String
|
1012
1050
|
# * {Types::DescribeRestoreJobOutput#expected_completion_time_minutes #expected_completion_time_minutes} => Integer
|
1013
1051
|
# * {Types::DescribeRestoreJobOutput#created_resource_arn #created_resource_arn} => String
|
1052
|
+
# * {Types::DescribeRestoreJobOutput#resource_type #resource_type} => String
|
1014
1053
|
#
|
1015
1054
|
# @example Request syntax with placeholder values
|
1016
1055
|
#
|
@@ -1020,6 +1059,7 @@ module Aws::Backup
|
|
1020
1059
|
#
|
1021
1060
|
# @example Response structure
|
1022
1061
|
#
|
1062
|
+
# resp.account_id #=> String
|
1023
1063
|
# resp.restore_job_id #=> String
|
1024
1064
|
# resp.recovery_point_arn #=> String
|
1025
1065
|
# resp.creation_date #=> Time
|
@@ -1031,6 +1071,7 @@ module Aws::Backup
|
|
1031
1071
|
# resp.iam_role_arn #=> String
|
1032
1072
|
# resp.expected_completion_time_minutes #=> Integer
|
1033
1073
|
# resp.created_resource_arn #=> String
|
1074
|
+
# resp.resource_type #=> String
|
1034
1075
|
#
|
1035
1076
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJob AWS API Documentation
|
1036
1077
|
#
|
@@ -1070,7 +1111,8 @@ module Aws::Backup
|
|
1070
1111
|
req.send_request(options)
|
1071
1112
|
end
|
1072
1113
|
|
1073
|
-
# Returns
|
1114
|
+
# Returns `BackupPlan` details for the specified `BackupPlanId`. Returns
|
1115
|
+
# the body of a backup plan in JSON format, in addition to plan
|
1074
1116
|
# metadata.
|
1075
1117
|
#
|
1076
1118
|
# @option params [required, String] :backup_plan_id
|
@@ -1090,6 +1132,7 @@ module Aws::Backup
|
|
1090
1132
|
# * {Types::GetBackupPlanOutput#creation_date #creation_date} => Time
|
1091
1133
|
# * {Types::GetBackupPlanOutput#deletion_date #deletion_date} => Time
|
1092
1134
|
# * {Types::GetBackupPlanOutput#last_execution_date #last_execution_date} => Time
|
1135
|
+
# * {Types::GetBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
|
1093
1136
|
#
|
1094
1137
|
# @example Request syntax with placeholder values
|
1095
1138
|
#
|
@@ -1116,6 +1159,10 @@ module Aws::Backup
|
|
1116
1159
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1117
1160
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1118
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
|
1119
1166
|
# resp.backup_plan_id #=> String
|
1120
1167
|
# resp.backup_plan_arn #=> String
|
1121
1168
|
# resp.version_id #=> String
|
@@ -1123,6 +1170,10 @@ module Aws::Backup
|
|
1123
1170
|
# resp.creation_date #=> Time
|
1124
1171
|
# resp.deletion_date #=> Time
|
1125
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
|
1126
1177
|
#
|
1127
1178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlan AWS API Documentation
|
1128
1179
|
#
|
@@ -1166,6 +1217,10 @@ module Aws::Backup
|
|
1166
1217
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1167
1218
|
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1168
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
|
1169
1224
|
#
|
1170
1225
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON AWS API Documentation
|
1171
1226
|
#
|
@@ -1209,6 +1264,10 @@ module Aws::Backup
|
|
1209
1264
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1210
1265
|
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1211
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
|
1212
1271
|
#
|
1213
1272
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate AWS API Documentation
|
1214
1273
|
#
|
@@ -1405,7 +1464,7 @@ module Aws::Backup
|
|
1405
1464
|
req.send_request(options)
|
1406
1465
|
end
|
1407
1466
|
|
1408
|
-
# Returns
|
1467
|
+
# Returns a list of existing backup jobs for an authenticated account.
|
1409
1468
|
#
|
1410
1469
|
# @option params [String] :next_token
|
1411
1470
|
# The next item following a partial list of returned items. For example,
|
@@ -1442,12 +1501,18 @@ module Aws::Backup
|
|
1442
1501
|
#
|
1443
1502
|
# * `EBS` for Amazon Elastic Block Store
|
1444
1503
|
#
|
1504
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
1505
|
+
#
|
1445
1506
|
# * `EFS` for Amazon Elastic File System
|
1446
1507
|
#
|
1447
1508
|
# * `RDS` for Amazon Relational Database Service
|
1448
1509
|
#
|
1449
1510
|
# * `Storage Gateway` for AWS Storage Gateway
|
1450
1511
|
#
|
1512
|
+
# @option params [String] :by_account_id
|
1513
|
+
# The account ID to list the jobs from. Returns only backup jobs
|
1514
|
+
# associated with the specified account ID.
|
1515
|
+
#
|
1451
1516
|
# @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1452
1517
|
#
|
1453
1518
|
# * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
|
@@ -1466,11 +1531,13 @@ module Aws::Backup
|
|
1466
1531
|
# by_created_before: Time.now,
|
1467
1532
|
# by_created_after: Time.now,
|
1468
1533
|
# by_resource_type: "ResourceType",
|
1534
|
+
# by_account_id: "AccountId",
|
1469
1535
|
# })
|
1470
1536
|
#
|
1471
1537
|
# @example Response structure
|
1472
1538
|
#
|
1473
1539
|
# resp.backup_jobs #=> Array
|
1540
|
+
# resp.backup_jobs[0].account_id #=> String
|
1474
1541
|
# resp.backup_jobs[0].backup_job_id #=> String
|
1475
1542
|
# resp.backup_jobs[0].backup_vault_name #=> String
|
1476
1543
|
# resp.backup_jobs[0].backup_vault_arn #=> String
|
@@ -1491,6 +1558,9 @@ module Aws::Backup
|
|
1491
1558
|
# resp.backup_jobs[0].start_by #=> Time
|
1492
1559
|
# resp.backup_jobs[0].resource_type #=> String
|
1493
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
|
1494
1564
|
# resp.next_token #=> String
|
1495
1565
|
#
|
1496
1566
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs AWS API Documentation
|
@@ -1587,6 +1657,10 @@ module Aws::Backup
|
|
1587
1657
|
# resp.backup_plan_versions_list[0].backup_plan_name #=> String
|
1588
1658
|
# resp.backup_plan_versions_list[0].creator_request_id #=> String
|
1589
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
|
1590
1664
|
#
|
1591
1665
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanVersions AWS API Documentation
|
1592
1666
|
#
|
@@ -1597,7 +1671,9 @@ module Aws::Backup
|
|
1597
1671
|
req.send_request(options)
|
1598
1672
|
end
|
1599
1673
|
|
1600
|
-
# 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
|
1601
1677
|
# Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan
|
1602
1678
|
# names, and creator request IDs.
|
1603
1679
|
#
|
@@ -1641,6 +1717,10 @@ module Aws::Backup
|
|
1641
1717
|
# resp.backup_plans_list[0].backup_plan_name #=> String
|
1642
1718
|
# resp.backup_plans_list[0].creator_request_id #=> String
|
1643
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
|
1644
1724
|
#
|
1645
1725
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlans AWS API Documentation
|
1646
1726
|
#
|
@@ -1774,8 +1854,12 @@ module Aws::Backup
|
|
1774
1854
|
# @option params [String] :by_resource_type
|
1775
1855
|
# Returns only backup jobs for the specified resources:
|
1776
1856
|
#
|
1857
|
+
# * `DynamoDB` for Amazon DynamoDB
|
1858
|
+
#
|
1777
1859
|
# * `EBS` for Amazon Elastic Block Store
|
1778
1860
|
#
|
1861
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
1862
|
+
#
|
1779
1863
|
# * `EFS` for Amazon Elastic File System
|
1780
1864
|
#
|
1781
1865
|
# * `RDS` for Amazon Relational Database Service
|
@@ -1787,6 +1871,10 @@ module Aws::Backup
|
|
1787
1871
|
# vault to copy from; for example,
|
1788
1872
|
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
1789
1873
|
#
|
1874
|
+
# @option params [String] :by_account_id
|
1875
|
+
# The account ID to list the jobs from. Returns only copy jobs
|
1876
|
+
# associated with the specified account ID.
|
1877
|
+
#
|
1790
1878
|
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1791
1879
|
#
|
1792
1880
|
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
@@ -1805,11 +1893,13 @@ module Aws::Backup
|
|
1805
1893
|
# by_created_after: Time.now,
|
1806
1894
|
# by_resource_type: "ResourceType",
|
1807
1895
|
# by_destination_vault_arn: "string",
|
1896
|
+
# by_account_id: "AccountId",
|
1808
1897
|
# })
|
1809
1898
|
#
|
1810
1899
|
# @example Response structure
|
1811
1900
|
#
|
1812
1901
|
# resp.copy_jobs #=> Array
|
1902
|
+
# resp.copy_jobs[0].account_id #=> String
|
1813
1903
|
# resp.copy_jobs[0].copy_job_id #=> String
|
1814
1904
|
# resp.copy_jobs[0].source_backup_vault_arn #=> String
|
1815
1905
|
# resp.copy_jobs[0].source_recovery_point_arn #=> String
|
@@ -2036,6 +2126,19 @@ module Aws::Backup
|
|
2036
2126
|
# @option params [Integer] :max_results
|
2037
2127
|
# The maximum number of items to be returned.
|
2038
2128
|
#
|
2129
|
+
# @option params [String] :by_account_id
|
2130
|
+
# The account ID to list the jobs from. Returns only restore jobs
|
2131
|
+
# associated with the specified account ID.
|
2132
|
+
#
|
2133
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
2134
|
+
# Returns only restore jobs that were created before the specified date.
|
2135
|
+
#
|
2136
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_after
|
2137
|
+
# Returns only restore jobs that were created after the specified date.
|
2138
|
+
#
|
2139
|
+
# @option params [String] :by_status
|
2140
|
+
# Returns only restore jobs associated with the specified job status.
|
2141
|
+
#
|
2039
2142
|
# @return [Types::ListRestoreJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2040
2143
|
#
|
2041
2144
|
# * {Types::ListRestoreJobsOutput#restore_jobs #restore_jobs} => Array<Types::RestoreJobsListMember>
|
@@ -2048,11 +2151,16 @@ module Aws::Backup
|
|
2048
2151
|
# resp = client.list_restore_jobs({
|
2049
2152
|
# next_token: "string",
|
2050
2153
|
# max_results: 1,
|
2154
|
+
# by_account_id: "AccountId",
|
2155
|
+
# by_created_before: Time.now,
|
2156
|
+
# by_created_after: Time.now,
|
2157
|
+
# by_status: "PENDING", # accepts PENDING, RUNNING, COMPLETED, ABORTED, FAILED
|
2051
2158
|
# })
|
2052
2159
|
#
|
2053
2160
|
# @example Response structure
|
2054
2161
|
#
|
2055
2162
|
# resp.restore_jobs #=> Array
|
2163
|
+
# resp.restore_jobs[0].account_id #=> String
|
2056
2164
|
# resp.restore_jobs[0].restore_job_id #=> String
|
2057
2165
|
# resp.restore_jobs[0].recovery_point_arn #=> String
|
2058
2166
|
# resp.restore_jobs[0].creation_date #=> Time
|
@@ -2064,6 +2172,7 @@ module Aws::Backup
|
|
2064
2172
|
# resp.restore_jobs[0].iam_role_arn #=> String
|
2065
2173
|
# resp.restore_jobs[0].expected_completion_time_minutes #=> Integer
|
2066
2174
|
# resp.restore_jobs[0].created_resource_arn #=> String
|
2175
|
+
# resp.restore_jobs[0].resource_type #=> String
|
2067
2176
|
# resp.next_token #=> String
|
2068
2177
|
#
|
2069
2178
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobs AWS API Documentation
|
@@ -2194,7 +2303,7 @@ module Aws::Backup
|
|
2194
2303
|
req.send_request(options)
|
2195
2304
|
end
|
2196
2305
|
|
2197
|
-
# Starts
|
2306
|
+
# Starts an on-demand backup job for the specified resource.
|
2198
2307
|
#
|
2199
2308
|
# @option params [required, String] :backup_vault_name
|
2200
2309
|
# The name of a logical container where backups are stored. Backup
|
@@ -2239,6 +2348,13 @@ module Aws::Backup
|
|
2239
2348
|
# To help organize your resources, you can assign your own metadata to
|
2240
2349
|
# the resources that you create. Each tag is a key-value pair.
|
2241
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
|
+
#
|
2242
2358
|
# @return [Types::StartBackupJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2243
2359
|
#
|
2244
2360
|
# * {Types::StartBackupJobOutput#backup_job_id #backup_job_id} => String
|
@@ -2261,6 +2377,9 @@ module Aws::Backup
|
|
2261
2377
|
# recovery_point_tags: {
|
2262
2378
|
# "TagKey" => "TagValue",
|
2263
2379
|
# },
|
2380
|
+
# backup_options: {
|
2381
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
2382
|
+
# },
|
2264
2383
|
# })
|
2265
2384
|
#
|
2266
2385
|
# @example Response structure
|
@@ -2372,8 +2491,9 @@ module Aws::Backup
|
|
2372
2491
|
# You need to specify specific metadata to restore an Amazon Elastic
|
2373
2492
|
# File System (Amazon EFS) instance:
|
2374
2493
|
#
|
2375
|
-
# * `file-system-id`\: ID of the Amazon EFS file system that is
|
2376
|
-
# 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`.
|
2377
2497
|
#
|
2378
2498
|
# * `Encrypted`\: A Boolean value that, if true, specifies that the file
|
2379
2499
|
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
@@ -2404,15 +2524,17 @@ module Aws::Backup
|
|
2404
2524
|
# Starts a job to restore a recovery point for one of the following
|
2405
2525
|
# resources:
|
2406
2526
|
#
|
2527
|
+
# * `DynamoDB` for Amazon DynamoDB
|
2528
|
+
#
|
2407
2529
|
# * `EBS` for Amazon Elastic Block Store
|
2408
2530
|
#
|
2409
|
-
# * `
|
2531
|
+
# * `EC2` for Amazon Elastic Compute Cloud
|
2410
2532
|
#
|
2411
|
-
# * `
|
2533
|
+
# * `EFS` for Amazon Elastic File System
|
2412
2534
|
#
|
2413
|
-
# * `
|
2535
|
+
# * `RDS` for Amazon Relational Database Service
|
2414
2536
|
#
|
2415
|
-
# * `
|
2537
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
2416
2538
|
#
|
2417
2539
|
# @return [Types::StartRestoreJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2418
2540
|
#
|
@@ -2525,9 +2647,9 @@ module Aws::Backup
|
|
2525
2647
|
req.send_request(options)
|
2526
2648
|
end
|
2527
2649
|
|
2528
|
-
#
|
2529
|
-
#
|
2530
|
-
#
|
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`.
|
2531
2653
|
#
|
2532
2654
|
# @option params [required, String] :backup_plan_id
|
2533
2655
|
# Uniquely identifies a backup plan.
|
@@ -2542,6 +2664,7 @@ module Aws::Backup
|
|
2542
2664
|
# * {Types::UpdateBackupPlanOutput#backup_plan_arn #backup_plan_arn} => String
|
2543
2665
|
# * {Types::UpdateBackupPlanOutput#creation_date #creation_date} => Time
|
2544
2666
|
# * {Types::UpdateBackupPlanOutput#version_id #version_id} => String
|
2667
|
+
# * {Types::UpdateBackupPlanOutput#advanced_backup_settings #advanced_backup_settings} => Array<Types::AdvancedBackupSetting>
|
2545
2668
|
#
|
2546
2669
|
# @example Request syntax with placeholder values
|
2547
2670
|
#
|
@@ -2574,6 +2697,14 @@ module Aws::Backup
|
|
2574
2697
|
# ],
|
2575
2698
|
# },
|
2576
2699
|
# ],
|
2700
|
+
# advanced_backup_settings: [
|
2701
|
+
# {
|
2702
|
+
# resource_type: "ResourceType",
|
2703
|
+
# backup_options: {
|
2704
|
+
# "BackupOptionKey" => "BackupOptionValue",
|
2705
|
+
# },
|
2706
|
+
# },
|
2707
|
+
# ],
|
2577
2708
|
# },
|
2578
2709
|
# })
|
2579
2710
|
#
|
@@ -2583,6 +2714,10 @@ module Aws::Backup
|
|
2583
2714
|
# resp.backup_plan_arn #=> String
|
2584
2715
|
# resp.creation_date #=> Time
|
2585
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
|
2586
2721
|
#
|
2587
2722
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlan AWS API Documentation
|
2588
2723
|
#
|
@@ -2663,16 +2798,16 @@ module Aws::Backup
|
|
2663
2798
|
req.send_request(options)
|
2664
2799
|
end
|
2665
2800
|
|
2666
|
-
# Updates the current service opt-in settings for the
|
2667
|
-
# service has a value set to true
|
2668
|
-
#
|
2669
|
-
#
|
2670
|
-
#
|
2671
|
-
#
|
2801
|
+
# Updates the current service opt-in settings for the Region. If the
|
2802
|
+
# service has a value set to `true`, AWS Backup tries to protect that
|
2803
|
+
# service's resources in this Region, when included in an on-demand
|
2804
|
+
# backup or scheduled backup plan. If the value is set to `false` for a
|
2805
|
+
# service, AWS Backup does not try to protect that service's resources
|
2806
|
+
# in this Region.
|
2672
2807
|
#
|
2673
2808
|
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2674
2809
|
# Updates the list of services along with the opt-in preferences for the
|
2675
|
-
#
|
2810
|
+
# Region.
|
2676
2811
|
#
|
2677
2812
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2678
2813
|
#
|
@@ -2706,7 +2841,7 @@ module Aws::Backup
|
|
2706
2841
|
params: params,
|
2707
2842
|
config: config)
|
2708
2843
|
context[:gem_name] = 'aws-sdk-backup'
|
2709
|
-
context[:gem_version] = '1.
|
2844
|
+
context[:gem_version] = '1.22.0'
|
2710
2845
|
Seahorse::Client::Request.new(handlers, context)
|
2711
2846
|
end
|
2712
2847
|
|