aws-sdk-backup 1.10.0 → 1.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-backup.rb +7 -4
- data/lib/aws-sdk-backup/client.rb +436 -58
- data/lib/aws-sdk-backup/client_api.rb +147 -0
- data/lib/aws-sdk-backup/errors.rb +30 -8
- data/lib/aws-sdk-backup/resource.rb +1 -0
- data/lib/aws-sdk-backup/types.rb +517 -62
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: b506b404fb3b2a29aed6bf3a11a4686caf792c18c1225893010edf06f431c4c9
|
4
|
+
data.tar.gz: fe03cad0a710225a98309c2fdcabea2148110e3af9ba8c119259ed5866fb5a94
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a2dafd8f7a852ca4853d007c2dfc4f77a9fd87f559b86f981428df69ae6c7353ab857b9daca8f57f137fb98cbb8a66ba16d5a758eca79687cf68d2998a5acce
|
7
|
+
data.tar.gz: e1d5a55159523049ed6ea2ca4135d6d6aee018d31712076936887d7599bcc9fa543ab20fc4649fff026cce301c393241179694a529e7652db8ac9b9f1741fc19
|
data/lib/aws-sdk-backup.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-backup/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# backup = Aws::Backup::Client.new
|
28
|
+
# resp = backup.create_backup_plan(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from AWS Backup
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from AWS Backup are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::Backup::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all AWS Backup API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-backup/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::Backup
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.15.0'
|
46
49
|
|
47
50
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/rest_json.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:backup)
|
31
31
|
|
32
32
|
module Aws::Backup
|
33
|
+
# An API client for Backup. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Backup::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Backup
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Backup
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Backup
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Backup
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Backup
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Backup
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Backup
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -209,16 +264,15 @@ module Aws::Backup
|
|
209
264
|
# requests through. Formatted like 'http://proxy.com:123'.
|
210
265
|
#
|
211
266
|
# @option options [Float] :http_open_timeout (15) The number of
|
212
|
-
# seconds to wait when opening a HTTP session before
|
267
|
+
# seconds to wait when opening a HTTP session before raising a
|
213
268
|
# `Timeout::Error`.
|
214
269
|
#
|
215
270
|
# @option options [Integer] :http_read_timeout (60) The default
|
216
271
|
# number of seconds to wait for response data. This value can
|
217
|
-
# safely be set
|
218
|
-
# per-request on the session yeidled by {#session_for}.
|
272
|
+
# safely be set per-request on the session.
|
219
273
|
#
|
220
274
|
# @option options [Float] :http_idle_timeout (5) The number of
|
221
|
-
# seconds a connection is allowed to sit
|
275
|
+
# seconds a connection is allowed to sit idle before it is
|
222
276
|
# considered stale. Stale connections are closed and removed
|
223
277
|
# from the pool before making a request.
|
224
278
|
#
|
@@ -227,7 +281,7 @@ module Aws::Backup
|
|
227
281
|
# request body. This option has no effect unless the request has
|
228
282
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
229
283
|
# disables this behaviour. This value can safely be set per
|
230
|
-
# request on the session
|
284
|
+
# request on the session.
|
231
285
|
#
|
232
286
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
233
287
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -257,8 +311,8 @@ module Aws::Backup
|
|
257
311
|
# Backup plans are documents that contain information that AWS Backup
|
258
312
|
# uses to schedule tasks that create recovery points of resources.
|
259
313
|
#
|
260
|
-
# If you call `CreateBackupPlan` with a plan that already exists,
|
261
|
-
#
|
314
|
+
# If you call `CreateBackupPlan` with a plan that already exists, an
|
315
|
+
# `AlreadyExistsException` is returned.
|
262
316
|
#
|
263
317
|
# @option params [required, Types::BackupPlanInput] :backup_plan
|
264
318
|
# Specifies the body of a backup plan. Includes a `BackupPlanName` and
|
@@ -301,6 +355,15 @@ module Aws::Backup
|
|
301
355
|
# recovery_point_tags: {
|
302
356
|
# "TagKey" => "TagValue",
|
303
357
|
# },
|
358
|
+
# copy_actions: [
|
359
|
+
# {
|
360
|
+
# lifecycle: {
|
361
|
+
# move_to_cold_storage_after_days: 1,
|
362
|
+
# delete_after_days: 1,
|
363
|
+
# },
|
364
|
+
# destination_backup_vault_arn: "ARN", # required
|
365
|
+
# },
|
366
|
+
# ],
|
304
367
|
# },
|
305
368
|
# ],
|
306
369
|
# },
|
@@ -338,13 +401,13 @@ module Aws::Backup
|
|
338
401
|
#
|
339
402
|
# `ConditionValue:"finance"`
|
340
403
|
#
|
341
|
-
# `ConditionType:"
|
404
|
+
# `ConditionType:"STRINGEQUALS"`
|
342
405
|
#
|
343
406
|
# * `ConditionKey:"importance"`
|
344
407
|
#
|
345
408
|
# `ConditionValue:"critical"`
|
346
409
|
#
|
347
|
-
# `ConditionType:"
|
410
|
+
# `ConditionType:"STRINGEQUALS"`
|
348
411
|
#
|
349
412
|
# Using these patterns would back up all Amazon Elastic Block Store
|
350
413
|
# (Amazon EBS) volumes that are tagged as `"department=finance"`,
|
@@ -365,11 +428,6 @@ module Aws::Backup
|
|
365
428
|
# Specifies the body of a request to assign a set of resources to a
|
366
429
|
# backup plan.
|
367
430
|
#
|
368
|
-
# It includes an array of resources, an optional array of patterns to
|
369
|
-
# exclude resources, an optional role to provide access to the AWS
|
370
|
-
# service the resource belongs to, and an optional array of tags used to
|
371
|
-
# identify a set of resources.
|
372
|
-
#
|
373
431
|
# @option params [String] :creator_request_id
|
374
432
|
# A unique string that identifies the request and allows failed requests
|
375
433
|
# to be retried without the risk of executing the operation twice.
|
@@ -545,7 +603,7 @@ module Aws::Backup
|
|
545
603
|
# @option params [required, String] :backup_vault_name
|
546
604
|
# The name of a logical container where backups are stored. Backup
|
547
605
|
# vaults are identified by names that are unique to the account used to
|
548
|
-
# create them and
|
606
|
+
# create them and the AWS Region where they are created. They consist of
|
549
607
|
# lowercase letters, numbers, and hyphens.
|
550
608
|
#
|
551
609
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
@@ -751,8 +809,52 @@ module Aws::Backup
|
|
751
809
|
req.send_request(options)
|
752
810
|
end
|
753
811
|
|
812
|
+
# Returns metadata associated with creating a copy of a resource.
|
813
|
+
#
|
814
|
+
# @option params [required, String] :copy_job_id
|
815
|
+
# Uniquely identifies a copy job.
|
816
|
+
#
|
817
|
+
# @return [Types::DescribeCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
818
|
+
#
|
819
|
+
# * {Types::DescribeCopyJobOutput#copy_job #copy_job} => Types::CopyJob
|
820
|
+
#
|
821
|
+
# @example Request syntax with placeholder values
|
822
|
+
#
|
823
|
+
# resp = client.describe_copy_job({
|
824
|
+
# copy_job_id: "string", # required
|
825
|
+
# })
|
826
|
+
#
|
827
|
+
# @example Response structure
|
828
|
+
#
|
829
|
+
# resp.copy_job.copy_job_id #=> String
|
830
|
+
# resp.copy_job.source_backup_vault_arn #=> String
|
831
|
+
# resp.copy_job.source_recovery_point_arn #=> String
|
832
|
+
# resp.copy_job.destination_backup_vault_arn #=> String
|
833
|
+
# resp.copy_job.destination_recovery_point_arn #=> String
|
834
|
+
# resp.copy_job.resource_arn #=> String
|
835
|
+
# resp.copy_job.creation_date #=> Time
|
836
|
+
# resp.copy_job.completion_date #=> Time
|
837
|
+
# resp.copy_job.state #=> String, one of "CREATED", "RUNNING", "COMPLETED", "FAILED"
|
838
|
+
# resp.copy_job.status_message #=> String
|
839
|
+
# resp.copy_job.backup_size_in_bytes #=> Integer
|
840
|
+
# resp.copy_job.iam_role_arn #=> String
|
841
|
+
# resp.copy_job.created_by.backup_plan_id #=> String
|
842
|
+
# resp.copy_job.created_by.backup_plan_arn #=> String
|
843
|
+
# resp.copy_job.created_by.backup_plan_version #=> String
|
844
|
+
# resp.copy_job.created_by.backup_rule_id #=> String
|
845
|
+
# resp.copy_job.resource_type #=> String
|
846
|
+
#
|
847
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJob AWS API Documentation
|
848
|
+
#
|
849
|
+
# @overload describe_copy_job(params = {})
|
850
|
+
# @param [Hash] params ({})
|
851
|
+
def describe_copy_job(params = {}, options = {})
|
852
|
+
req = build_request(:describe_copy_job, params)
|
853
|
+
req.send_request(options)
|
854
|
+
end
|
855
|
+
|
754
856
|
# Returns information about a saved resource, including the last time it
|
755
|
-
# was backed
|
857
|
+
# was backed up, its Amazon Resource Name (ARN), and the AWS service
|
756
858
|
# type of the saved resource.
|
757
859
|
#
|
758
860
|
# @option params [required, String] :resource_arn
|
@@ -861,6 +963,31 @@ module Aws::Backup
|
|
861
963
|
req.send_request(options)
|
862
964
|
end
|
863
965
|
|
966
|
+
# Returns the current service opt-in settings for the region. If the
|
967
|
+
# service has a value set to true, AWS Backup will attempt to protect
|
968
|
+
# that service's resources in this region, when included in an
|
969
|
+
# on-demand backup or scheduled backup plan. If the value is set to
|
970
|
+
# false for a service, AWS Backup will not attempt to protect that
|
971
|
+
# service's resources in this region.
|
972
|
+
#
|
973
|
+
# @return [Types::DescribeRegionSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
974
|
+
#
|
975
|
+
# * {Types::DescribeRegionSettingsOutput#resource_type_opt_in_preference #resource_type_opt_in_preference} => Hash<String,Boolean>
|
976
|
+
#
|
977
|
+
# @example Response structure
|
978
|
+
#
|
979
|
+
# resp.resource_type_opt_in_preference #=> Hash
|
980
|
+
# resp.resource_type_opt_in_preference["ResourceType"] #=> Boolean
|
981
|
+
#
|
982
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings AWS API Documentation
|
983
|
+
#
|
984
|
+
# @overload describe_region_settings(params = {})
|
985
|
+
# @param [Hash] params ({})
|
986
|
+
def describe_region_settings(params = {}, options = {})
|
987
|
+
req = build_request(:describe_region_settings, params)
|
988
|
+
req.send_request(options)
|
989
|
+
end
|
990
|
+
|
864
991
|
# Returns metadata associated with a restore job that is specified by a
|
865
992
|
# job ID.
|
866
993
|
#
|
@@ -981,6 +1108,10 @@ module Aws::Backup
|
|
981
1108
|
# resp.backup_plan.rules[0].recovery_point_tags #=> Hash
|
982
1109
|
# resp.backup_plan.rules[0].recovery_point_tags["TagKey"] #=> String
|
983
1110
|
# resp.backup_plan.rules[0].rule_id #=> String
|
1111
|
+
# resp.backup_plan.rules[0].copy_actions #=> Array
|
1112
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1113
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1114
|
+
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
984
1115
|
# resp.backup_plan_id #=> String
|
985
1116
|
# resp.backup_plan_arn #=> String
|
986
1117
|
# resp.version_id #=> String
|
@@ -1027,6 +1158,10 @@ module Aws::Backup
|
|
1027
1158
|
# resp.backup_plan.rules[0].recovery_point_tags #=> Hash
|
1028
1159
|
# resp.backup_plan.rules[0].recovery_point_tags["TagKey"] #=> String
|
1029
1160
|
# resp.backup_plan.rules[0].rule_id #=> String
|
1161
|
+
# resp.backup_plan.rules[0].copy_actions #=> Array
|
1162
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1163
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1164
|
+
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1030
1165
|
#
|
1031
1166
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON AWS API Documentation
|
1032
1167
|
#
|
@@ -1066,6 +1201,10 @@ module Aws::Backup
|
|
1066
1201
|
# resp.backup_plan_document.rules[0].recovery_point_tags #=> Hash
|
1067
1202
|
# resp.backup_plan_document.rules[0].recovery_point_tags["TagKey"] #=> String
|
1068
1203
|
# resp.backup_plan_document.rules[0].rule_id #=> String
|
1204
|
+
# resp.backup_plan_document.rules[0].copy_actions #=> Array
|
1205
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1206
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1207
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1069
1208
|
#
|
1070
1209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate AWS API Documentation
|
1071
1210
|
#
|
@@ -1188,7 +1327,7 @@ module Aws::Backup
|
|
1188
1327
|
# resp.backup_vault_arn #=> String
|
1189
1328
|
# resp.sns_topic_arn #=> String
|
1190
1329
|
# resp.backup_vault_events #=> Array
|
1191
|
-
# resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED"
|
1330
|
+
# resp.backup_vault_events[0] #=> String, one of "BACKUP_JOB_STARTED", "BACKUP_JOB_COMPLETED", "BACKUP_JOB_SUCCESSFUL", "BACKUP_JOB_FAILED", "BACKUP_JOB_EXPIRED", "RESTORE_JOB_STARTED", "RESTORE_JOB_COMPLETED", "RESTORE_JOB_SUCCESSFUL", "RESTORE_JOB_FAILED", "COPY_JOB_STARTED", "COPY_JOB_SUCCESSFUL", "COPY_JOB_FAILED", "RECOVERY_POINT_MODIFIED", "BACKUP_PLAN_CREATED", "BACKUP_PLAN_MODIFIED"
|
1192
1331
|
#
|
1193
1332
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications AWS API Documentation
|
1194
1333
|
#
|
@@ -1199,15 +1338,8 @@ module Aws::Backup
|
|
1199
1338
|
req.send_request(options)
|
1200
1339
|
end
|
1201
1340
|
|
1202
|
-
# Returns
|
1203
|
-
#
|
1204
|
-
# lists the metadata key-value pairs that are required to restore the
|
1205
|
-
# recovery point.
|
1206
|
-
#
|
1207
|
-
# These sets can be the same, or the restore metadata set can contain
|
1208
|
-
# different values if the target service to be restored has changed
|
1209
|
-
# since the recovery point was created and now requires additional or
|
1210
|
-
# different information in order to be restored.
|
1341
|
+
# Returns a set of metadata key-value pairs that were used to create the
|
1342
|
+
# backup.
|
1211
1343
|
#
|
1212
1344
|
# @option params [required, String] :backup_vault_name
|
1213
1345
|
# The name of a logical container where backups are stored. Backup
|
@@ -1302,21 +1434,23 @@ module Aws::Backup
|
|
1302
1434
|
# @option params [String] :by_resource_type
|
1303
1435
|
# Returns only backup jobs for the specified resources:
|
1304
1436
|
#
|
1437
|
+
# * `DynamoDB` for Amazon DynamoDB
|
1438
|
+
#
|
1305
1439
|
# * `EBS` for Amazon Elastic Block Store
|
1306
1440
|
#
|
1307
|
-
# * `
|
1441
|
+
# * `EFS` for Amazon Elastic File System
|
1308
1442
|
#
|
1309
1443
|
# * `RDS` for Amazon Relational Database Service
|
1310
1444
|
#
|
1311
|
-
# * `
|
1312
|
-
#
|
1313
|
-
# * `EFS` for Amazon Elastic File System
|
1445
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
1314
1446
|
#
|
1315
1447
|
# @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1316
1448
|
#
|
1317
1449
|
# * {Types::ListBackupJobsOutput#backup_jobs #backup_jobs} => Array<Types::BackupJob>
|
1318
1450
|
# * {Types::ListBackupJobsOutput#next_token #next_token} => String
|
1319
1451
|
#
|
1452
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1453
|
+
#
|
1320
1454
|
# @example Request syntax with placeholder values
|
1321
1455
|
#
|
1322
1456
|
# resp = client.list_backup_jobs({
|
@@ -1381,6 +1515,8 @@ module Aws::Backup
|
|
1381
1515
|
# * {Types::ListBackupPlanTemplatesOutput#next_token #next_token} => String
|
1382
1516
|
# * {Types::ListBackupPlanTemplatesOutput#backup_plan_templates_list #backup_plan_templates_list} => Array<Types::BackupPlanTemplatesListMember>
|
1383
1517
|
#
|
1518
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1519
|
+
#
|
1384
1520
|
# @example Request syntax with placeholder values
|
1385
1521
|
#
|
1386
1522
|
# resp = client.list_backup_plan_templates({
|
@@ -1425,6 +1561,8 @@ module Aws::Backup
|
|
1425
1561
|
# * {Types::ListBackupPlanVersionsOutput#next_token #next_token} => String
|
1426
1562
|
# * {Types::ListBackupPlanVersionsOutput#backup_plan_versions_list #backup_plan_versions_list} => Array<Types::BackupPlansListMember>
|
1427
1563
|
#
|
1564
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1565
|
+
#
|
1428
1566
|
# @example Request syntax with placeholder values
|
1429
1567
|
#
|
1430
1568
|
# resp = client.list_backup_plan_versions({
|
@@ -1477,6 +1615,8 @@ module Aws::Backup
|
|
1477
1615
|
# * {Types::ListBackupPlansOutput#next_token #next_token} => String
|
1478
1616
|
# * {Types::ListBackupPlansOutput#backup_plans_list #backup_plans_list} => Array<Types::BackupPlansListMember>
|
1479
1617
|
#
|
1618
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1619
|
+
#
|
1480
1620
|
# @example Request syntax with placeholder values
|
1481
1621
|
#
|
1482
1622
|
# resp = client.list_backup_plans({
|
@@ -1527,6 +1667,8 @@ module Aws::Backup
|
|
1527
1667
|
# * {Types::ListBackupSelectionsOutput#next_token #next_token} => String
|
1528
1668
|
# * {Types::ListBackupSelectionsOutput#backup_selections_list #backup_selections_list} => Array<Types::BackupSelectionsListMember>
|
1529
1669
|
#
|
1670
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1671
|
+
#
|
1530
1672
|
# @example Request syntax with placeholder values
|
1531
1673
|
#
|
1532
1674
|
# resp = client.list_backup_selections({
|
@@ -1572,6 +1714,8 @@ module Aws::Backup
|
|
1572
1714
|
# * {Types::ListBackupVaultsOutput#backup_vault_list #backup_vault_list} => Array<Types::BackupVaultListMember>
|
1573
1715
|
# * {Types::ListBackupVaultsOutput#next_token #next_token} => String
|
1574
1716
|
#
|
1717
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1718
|
+
#
|
1575
1719
|
# @example Request syntax with placeholder values
|
1576
1720
|
#
|
1577
1721
|
# resp = client.list_backup_vaults({
|
@@ -1599,6 +1743,97 @@ module Aws::Backup
|
|
1599
1743
|
req.send_request(options)
|
1600
1744
|
end
|
1601
1745
|
|
1746
|
+
# Returns metadata about your copy jobs.
|
1747
|
+
#
|
1748
|
+
# @option params [String] :next_token
|
1749
|
+
# The next item following a partial list of returned items. For example,
|
1750
|
+
# if a request is made to return maxResults number of items, NextToken
|
1751
|
+
# allows you to return more items in your list starting at the location
|
1752
|
+
# pointed to by the next token.
|
1753
|
+
#
|
1754
|
+
# @option params [Integer] :max_results
|
1755
|
+
# The maximum number of items to be returned.
|
1756
|
+
#
|
1757
|
+
# @option params [String] :by_resource_arn
|
1758
|
+
# Returns only copy jobs that match the specified resource Amazon
|
1759
|
+
# Resource Name (ARN).
|
1760
|
+
#
|
1761
|
+
# @option params [String] :by_state
|
1762
|
+
# Returns only copy jobs that are in the specified state.
|
1763
|
+
#
|
1764
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
1765
|
+
# Returns only copy jobs that were created before the specified date.
|
1766
|
+
#
|
1767
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_after
|
1768
|
+
# Returns only copy jobs that were created after the specified date.
|
1769
|
+
#
|
1770
|
+
# @option params [String] :by_resource_type
|
1771
|
+
# Returns only backup jobs for the specified resources:
|
1772
|
+
#
|
1773
|
+
# * `EBS` for Amazon Elastic Block Store
|
1774
|
+
#
|
1775
|
+
# * `EFS` for Amazon Elastic File System
|
1776
|
+
#
|
1777
|
+
# * `RDS` for Amazon Relational Database Service
|
1778
|
+
#
|
1779
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
1780
|
+
#
|
1781
|
+
# @option params [String] :by_destination_vault_arn
|
1782
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
1783
|
+
# vault to copy from; for example,
|
1784
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
1785
|
+
#
|
1786
|
+
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1787
|
+
#
|
1788
|
+
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
1789
|
+
# * {Types::ListCopyJobsOutput#next_token #next_token} => String
|
1790
|
+
#
|
1791
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1792
|
+
#
|
1793
|
+
# @example Request syntax with placeholder values
|
1794
|
+
#
|
1795
|
+
# resp = client.list_copy_jobs({
|
1796
|
+
# next_token: "string",
|
1797
|
+
# max_results: 1,
|
1798
|
+
# by_resource_arn: "ARN",
|
1799
|
+
# by_state: "CREATED", # accepts CREATED, RUNNING, COMPLETED, FAILED
|
1800
|
+
# by_created_before: Time.now,
|
1801
|
+
# by_created_after: Time.now,
|
1802
|
+
# by_resource_type: "ResourceType",
|
1803
|
+
# by_destination_vault_arn: "string",
|
1804
|
+
# })
|
1805
|
+
#
|
1806
|
+
# @example Response structure
|
1807
|
+
#
|
1808
|
+
# resp.copy_jobs #=> Array
|
1809
|
+
# resp.copy_jobs[0].copy_job_id #=> String
|
1810
|
+
# resp.copy_jobs[0].source_backup_vault_arn #=> String
|
1811
|
+
# resp.copy_jobs[0].source_recovery_point_arn #=> String
|
1812
|
+
# resp.copy_jobs[0].destination_backup_vault_arn #=> String
|
1813
|
+
# resp.copy_jobs[0].destination_recovery_point_arn #=> String
|
1814
|
+
# resp.copy_jobs[0].resource_arn #=> String
|
1815
|
+
# resp.copy_jobs[0].creation_date #=> Time
|
1816
|
+
# resp.copy_jobs[0].completion_date #=> Time
|
1817
|
+
# resp.copy_jobs[0].state #=> String, one of "CREATED", "RUNNING", "COMPLETED", "FAILED"
|
1818
|
+
# resp.copy_jobs[0].status_message #=> String
|
1819
|
+
# resp.copy_jobs[0].backup_size_in_bytes #=> Integer
|
1820
|
+
# resp.copy_jobs[0].iam_role_arn #=> String
|
1821
|
+
# resp.copy_jobs[0].created_by.backup_plan_id #=> String
|
1822
|
+
# resp.copy_jobs[0].created_by.backup_plan_arn #=> String
|
1823
|
+
# resp.copy_jobs[0].created_by.backup_plan_version #=> String
|
1824
|
+
# resp.copy_jobs[0].created_by.backup_rule_id #=> String
|
1825
|
+
# resp.copy_jobs[0].resource_type #=> String
|
1826
|
+
# resp.next_token #=> String
|
1827
|
+
#
|
1828
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobs AWS API Documentation
|
1829
|
+
#
|
1830
|
+
# @overload list_copy_jobs(params = {})
|
1831
|
+
# @param [Hash] params ({})
|
1832
|
+
def list_copy_jobs(params = {}, options = {})
|
1833
|
+
req = build_request(:list_copy_jobs, params)
|
1834
|
+
req.send_request(options)
|
1835
|
+
end
|
1836
|
+
|
1602
1837
|
# Returns an array of resources successfully backed up by AWS Backup,
|
1603
1838
|
# including the time the resource was saved, an Amazon Resource Name
|
1604
1839
|
# (ARN) of the resource, and a resource type.
|
@@ -1617,6 +1852,8 @@ module Aws::Backup
|
|
1617
1852
|
# * {Types::ListProtectedResourcesOutput#results #results} => Array<Types::ProtectedResource>
|
1618
1853
|
# * {Types::ListProtectedResourcesOutput#next_token #next_token} => String
|
1619
1854
|
#
|
1855
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1856
|
+
#
|
1620
1857
|
# @example Request syntax with placeholder values
|
1621
1858
|
#
|
1622
1859
|
# resp = client.list_protected_resources({
|
@@ -1682,6 +1919,8 @@ module Aws::Backup
|
|
1682
1919
|
# * {Types::ListRecoveryPointsByBackupVaultOutput#next_token #next_token} => String
|
1683
1920
|
# * {Types::ListRecoveryPointsByBackupVaultOutput#recovery_points #recovery_points} => Array<Types::RecoveryPointByBackupVault>
|
1684
1921
|
#
|
1922
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1923
|
+
#
|
1685
1924
|
# @example Request syntax with placeholder values
|
1686
1925
|
#
|
1687
1926
|
# resp = client.list_recovery_points_by_backup_vault({
|
@@ -1751,6 +1990,8 @@ module Aws::Backup
|
|
1751
1990
|
# * {Types::ListRecoveryPointsByResourceOutput#next_token #next_token} => String
|
1752
1991
|
# * {Types::ListRecoveryPointsByResourceOutput#recovery_points #recovery_points} => Array<Types::RecoveryPointByResource>
|
1753
1992
|
#
|
1993
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1994
|
+
#
|
1754
1995
|
# @example Request syntax with placeholder values
|
1755
1996
|
#
|
1756
1997
|
# resp = client.list_recovery_points_by_resource({
|
@@ -1796,6 +2037,8 @@ module Aws::Backup
|
|
1796
2037
|
# * {Types::ListRestoreJobsOutput#restore_jobs #restore_jobs} => Array<Types::RestoreJobsListMember>
|
1797
2038
|
# * {Types::ListRestoreJobsOutput#next_token #next_token} => String
|
1798
2039
|
#
|
2040
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2041
|
+
#
|
1799
2042
|
# @example Request syntax with placeholder values
|
1800
2043
|
#
|
1801
2044
|
# resp = client.list_restore_jobs({
|
@@ -1831,6 +2074,10 @@ module Aws::Backup
|
|
1831
2074
|
# Returns a list of key-value pairs assigned to a target recovery point,
|
1832
2075
|
# backup plan, or backup vault.
|
1833
2076
|
#
|
2077
|
+
# <note markdown="1"> `ListTags` are currently only supported with Amazon EFS backups.
|
2078
|
+
#
|
2079
|
+
# </note>
|
2080
|
+
#
|
1834
2081
|
# @option params [required, String] :resource_arn
|
1835
2082
|
# An Amazon Resource Name (ARN) that uniquely identifies a resource. The
|
1836
2083
|
# format of the ARN depends on the type of resource. Valid targets for
|
@@ -1850,6 +2097,8 @@ module Aws::Backup
|
|
1850
2097
|
# * {Types::ListTagsOutput#next_token #next_token} => String
|
1851
2098
|
# * {Types::ListTagsOutput#tags #tags} => Hash<String,String>
|
1852
2099
|
#
|
2100
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2101
|
+
#
|
1853
2102
|
# @example Request syntax with placeholder values
|
1854
2103
|
#
|
1855
2104
|
# resp = client.list_tags({
|
@@ -1929,7 +2178,7 @@ module Aws::Backup
|
|
1929
2178
|
# resp = client.put_backup_vault_notifications({
|
1930
2179
|
# backup_vault_name: "BackupVaultName", # required
|
1931
2180
|
# sns_topic_arn: "ARN", # required
|
1932
|
-
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED
|
2181
|
+
# backup_vault_events: ["BACKUP_JOB_STARTED"], # required, accepts BACKUP_JOB_STARTED, BACKUP_JOB_COMPLETED, BACKUP_JOB_SUCCESSFUL, BACKUP_JOB_FAILED, BACKUP_JOB_EXPIRED, RESTORE_JOB_STARTED, RESTORE_JOB_COMPLETED, RESTORE_JOB_SUCCESSFUL, RESTORE_JOB_FAILED, COPY_JOB_STARTED, COPY_JOB_SUCCESSFUL, COPY_JOB_FAILED, RECOVERY_POINT_MODIFIED, BACKUP_PLAN_CREATED, BACKUP_PLAN_MODIFIED
|
1933
2182
|
# })
|
1934
2183
|
#
|
1935
2184
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications AWS API Documentation
|
@@ -1959,19 +2208,16 @@ module Aws::Backup
|
|
1959
2208
|
#
|
1960
2209
|
# @option params [String] :idempotency_token
|
1961
2210
|
# A customer chosen string that can be used to distinguish between calls
|
1962
|
-
# to `StartBackupJob`.
|
1963
|
-
# Therefore, if you call `StartBackupJob` multiple times with the same
|
1964
|
-
# idempotency token within one hour, AWS Backup recognizes that you are
|
1965
|
-
# requesting only one backup job and initiates only one. If you change
|
1966
|
-
# the idempotency token for each call, AWS Backup recognizes that you
|
1967
|
-
# are requesting to start multiple backups.
|
2211
|
+
# to `StartBackupJob`.
|
1968
2212
|
#
|
1969
2213
|
# @option params [Integer] :start_window_minutes
|
1970
|
-
#
|
2214
|
+
# A value in minutes after a backup is scheduled before a job will be
|
2215
|
+
# canceled if it doesn't start successfully. This value is optional.
|
1971
2216
|
#
|
1972
2217
|
# @option params [Integer] :complete_window_minutes
|
1973
|
-
#
|
1974
|
-
#
|
2218
|
+
# A value in minutes after a backup job is successfully started before
|
2219
|
+
# it must be completed or it will be canceled by AWS Backup. This value
|
2220
|
+
# is optional.
|
1975
2221
|
#
|
1976
2222
|
# @option params [Types::Lifecycle] :lifecycle
|
1977
2223
|
# The lifecycle defines when a protected resource is transitioned to
|
@@ -2028,6 +2274,75 @@ module Aws::Backup
|
|
2028
2274
|
req.send_request(options)
|
2029
2275
|
end
|
2030
2276
|
|
2277
|
+
# Starts a job to create a one-time copy of the specified resource.
|
2278
|
+
#
|
2279
|
+
# @option params [required, String] :recovery_point_arn
|
2280
|
+
# An ARN that uniquely identifies a recovery point to use for the copy
|
2281
|
+
# job; for example,
|
2282
|
+
# arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
|
2283
|
+
#
|
2284
|
+
# @option params [required, String] :source_backup_vault_name
|
2285
|
+
# The name of a logical source container where backups are stored.
|
2286
|
+
# Backup vaults are identified by names that are unique to the account
|
2287
|
+
# used to create them and the AWS Region where they are created. They
|
2288
|
+
# consist of lowercase letters, numbers, and hyphens.
|
2289
|
+
#
|
2290
|
+
# @option params [required, String] :destination_backup_vault_arn
|
2291
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
2292
|
+
# backup vault to copy to; for example,
|
2293
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
2294
|
+
#
|
2295
|
+
# @option params [required, String] :iam_role_arn
|
2296
|
+
# Specifies the IAM role ARN used to copy the target recovery point; for
|
2297
|
+
# example, `arn:aws:iam::123456789012:role/S3Access`.
|
2298
|
+
#
|
2299
|
+
# @option params [String] :idempotency_token
|
2300
|
+
# A customer chosen string that can be used to distinguish between calls
|
2301
|
+
# to `StartCopyJob`.
|
2302
|
+
#
|
2303
|
+
# @option params [Types::Lifecycle] :lifecycle
|
2304
|
+
# Contains an array of `Transition` objects specifying how long in days
|
2305
|
+
# before a recovery point transitions to cold storage or is deleted.
|
2306
|
+
#
|
2307
|
+
# Backups transitioned to cold storage must be stored in cold storage
|
2308
|
+
# for a minimum of 90 days. Therefore, on the console, the “expire after
|
2309
|
+
# days” setting must be 90 days greater than the “transition to cold
|
2310
|
+
# after days” setting. The “transition to cold after days” setting
|
2311
|
+
# cannot be changed after a backup has been transitioned to cold.
|
2312
|
+
#
|
2313
|
+
# @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2314
|
+
#
|
2315
|
+
# * {Types::StartCopyJobOutput#copy_job_id #copy_job_id} => String
|
2316
|
+
# * {Types::StartCopyJobOutput#creation_date #creation_date} => Time
|
2317
|
+
#
|
2318
|
+
# @example Request syntax with placeholder values
|
2319
|
+
#
|
2320
|
+
# resp = client.start_copy_job({
|
2321
|
+
# recovery_point_arn: "ARN", # required
|
2322
|
+
# source_backup_vault_name: "BackupVaultName", # required
|
2323
|
+
# destination_backup_vault_arn: "ARN", # required
|
2324
|
+
# iam_role_arn: "IAMRoleArn", # required
|
2325
|
+
# idempotency_token: "string",
|
2326
|
+
# lifecycle: {
|
2327
|
+
# move_to_cold_storage_after_days: 1,
|
2328
|
+
# delete_after_days: 1,
|
2329
|
+
# },
|
2330
|
+
# })
|
2331
|
+
#
|
2332
|
+
# @example Response structure
|
2333
|
+
#
|
2334
|
+
# resp.copy_job_id #=> String
|
2335
|
+
# resp.creation_date #=> Time
|
2336
|
+
#
|
2337
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJob AWS API Documentation
|
2338
|
+
#
|
2339
|
+
# @overload start_copy_job(params = {})
|
2340
|
+
# @param [Hash] params ({})
|
2341
|
+
def start_copy_job(params = {}, options = {})
|
2342
|
+
req = build_request(:start_copy_job, params)
|
2343
|
+
req.send_request(options)
|
2344
|
+
end
|
2345
|
+
|
2031
2346
|
# Recovers the saved resource identified by an Amazon Resource Name
|
2032
2347
|
# (ARN).
|
2033
2348
|
#
|
@@ -2040,8 +2355,37 @@ module Aws::Backup
|
|
2040
2355
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
2041
2356
|
#
|
2042
2357
|
# @option params [required, Hash<String,String>] :metadata
|
2043
|
-
# A set of metadata key-value pairs.
|
2044
|
-
#
|
2358
|
+
# A set of metadata key-value pairs. Contains information, such as a
|
2359
|
+
# resource name, required to restore a recovery point.
|
2360
|
+
#
|
2361
|
+
# You can get configuration metadata about a resource at the time it was
|
2362
|
+
# backed up by calling `GetRecoveryPointRestoreMetadata`. However,
|
2363
|
+
# values in addition to those provided by
|
2364
|
+
# `GetRecoveryPointRestoreMetadata` might be required to restore a
|
2365
|
+
# resource. For example, you might need to provide a new resource name
|
2366
|
+
# if the original already exists.
|
2367
|
+
#
|
2368
|
+
# You need to specify specific metadata to restore an Amazon Elastic
|
2369
|
+
# File System (Amazon EFS) instance:
|
2370
|
+
#
|
2371
|
+
# * `file-system-id`\: ID of the Amazon EFS file system that is backed
|
2372
|
+
# up by AWS Backup. Returned in `GetRecoveryPointRestoreMetadata`.
|
2373
|
+
#
|
2374
|
+
# * `Encrypted`\: A Boolean value that, if true, specifies that the file
|
2375
|
+
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
2376
|
+
# set to `true`.
|
2377
|
+
#
|
2378
|
+
# * `KmsKeyId`\: Specifies the AWS KMS key that is used to encrypt the
|
2379
|
+
# restored file system.
|
2380
|
+
#
|
2381
|
+
# * `PerformanceMode`\: Specifies the throughput mode of the file
|
2382
|
+
# system.
|
2383
|
+
#
|
2384
|
+
# * `CreationToken`\: A user-supplied value that ensures the uniqueness
|
2385
|
+
# (idempotency) of the request.
|
2386
|
+
#
|
2387
|
+
# * `newFileSystem`\: A Boolean value that, if true, specifies that the
|
2388
|
+
# recovery point is restored to a new Amazon EFS file system.
|
2045
2389
|
#
|
2046
2390
|
# @option params [required, String] :iam_role_arn
|
2047
2391
|
# The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
|
@@ -2050,12 +2394,7 @@ module Aws::Backup
|
|
2050
2394
|
#
|
2051
2395
|
# @option params [String] :idempotency_token
|
2052
2396
|
# A customer chosen string that can be used to distinguish between calls
|
2053
|
-
# to `StartRestoreJob`.
|
2054
|
-
# Therefore, if you call `StartRestoreJob` multiple times with the same
|
2055
|
-
# idempotency token within one hour, AWS Backup recognizes that you are
|
2056
|
-
# requesting only one restore job and initiates only one. If you change
|
2057
|
-
# the idempotency token for each call, AWS Backup recognizes that you
|
2058
|
-
# are requesting to start multiple restores.
|
2397
|
+
# to `StartRestoreJob`.
|
2059
2398
|
#
|
2060
2399
|
# @option params [String] :resource_type
|
2061
2400
|
# Starts a job to restore a recovery point for one of the following
|
@@ -2063,7 +2402,7 @@ module Aws::Backup
|
|
2063
2402
|
#
|
2064
2403
|
# * `EBS` for Amazon Elastic Block Store
|
2065
2404
|
#
|
2066
|
-
# * `
|
2405
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
2067
2406
|
#
|
2068
2407
|
# * `RDS` for Amazon Relational Database Service
|
2069
2408
|
#
|
@@ -2220,6 +2559,15 @@ module Aws::Backup
|
|
2220
2559
|
# recovery_point_tags: {
|
2221
2560
|
# "TagKey" => "TagValue",
|
2222
2561
|
# },
|
2562
|
+
# copy_actions: [
|
2563
|
+
# {
|
2564
|
+
# lifecycle: {
|
2565
|
+
# move_to_cold_storage_after_days: 1,
|
2566
|
+
# delete_after_days: 1,
|
2567
|
+
# },
|
2568
|
+
# destination_backup_vault_arn: "ARN", # required
|
2569
|
+
# },
|
2570
|
+
# ],
|
2223
2571
|
# },
|
2224
2572
|
# ],
|
2225
2573
|
# },
|
@@ -2311,6 +2659,36 @@ module Aws::Backup
|
|
2311
2659
|
req.send_request(options)
|
2312
2660
|
end
|
2313
2661
|
|
2662
|
+
# Updates the current service opt-in settings for the region. If the
|
2663
|
+
# service has a value set to true, AWS Backup will attempt to protect
|
2664
|
+
# that service's resources in this region, when included in an
|
2665
|
+
# on-demand backup or scheduled backup plan. If the value is set to
|
2666
|
+
# false for a service, AWS Backup will not attempt to protect that
|
2667
|
+
# service's resources in this region.
|
2668
|
+
#
|
2669
|
+
# @option params [Hash<String,Boolean>] :resource_type_opt_in_preference
|
2670
|
+
# Updates the list of services along with the opt-in preferences for the
|
2671
|
+
# region.
|
2672
|
+
#
|
2673
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2674
|
+
#
|
2675
|
+
# @example Request syntax with placeholder values
|
2676
|
+
#
|
2677
|
+
# resp = client.update_region_settings({
|
2678
|
+
# resource_type_opt_in_preference: {
|
2679
|
+
# "ResourceType" => false,
|
2680
|
+
# },
|
2681
|
+
# })
|
2682
|
+
#
|
2683
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettings AWS API Documentation
|
2684
|
+
#
|
2685
|
+
# @overload update_region_settings(params = {})
|
2686
|
+
# @param [Hash] params ({})
|
2687
|
+
def update_region_settings(params = {}, options = {})
|
2688
|
+
req = build_request(:update_region_settings, params)
|
2689
|
+
req.send_request(options)
|
2690
|
+
end
|
2691
|
+
|
2314
2692
|
# @!endgroup
|
2315
2693
|
|
2316
2694
|
# @param params ({})
|
@@ -2324,7 +2702,7 @@ module Aws::Backup
|
|
2324
2702
|
params: params,
|
2325
2703
|
config: config)
|
2326
2704
|
context[:gem_name] = 'aws-sdk-backup'
|
2327
|
-
context[:gem_version] = '1.
|
2705
|
+
context[:gem_version] = '1.15.0'
|
2328
2706
|
Seahorse::Client::Request.new(handlers, context)
|
2329
2707
|
end
|
2330
2708
|
|