aws-sdk-backup 1.10.0 → 1.11.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-backup.rb +1 -1
- data/lib/aws-sdk-backup/client.rb +281 -40
- data/lib/aws-sdk-backup/client_api.rb +111 -0
- data/lib/aws-sdk-backup/types.rb +458 -43
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 76ef3e1b1b9ed1affd3478e2f5277906cb126841
|
4
|
+
data.tar.gz: 501ad2a879690a0f2ef0b86935409a061551a76e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8e300df0165c3dac473afc6f773fc886a6a45d6e077c3a94703f4fadd3b43be78a6e1522024000798fe1d6affe4519bc0d9a9ca4054bfa5775951859178b1c73
|
7
|
+
data.tar.gz: c8efdc1f077a11f9d4ac4b70bffb21f1006f7beae734ba4564b645ddea8419bb184eb4140db40e92d5e9e68348c64e65c3d94ce35d83614696afb196bcff177a
|
data/lib/aws-sdk-backup.rb
CHANGED
@@ -257,8 +257,8 @@ module Aws::Backup
|
|
257
257
|
# Backup plans are documents that contain information that AWS Backup
|
258
258
|
# uses to schedule tasks that create recovery points of resources.
|
259
259
|
#
|
260
|
-
# If you call `CreateBackupPlan` with a plan that already exists,
|
261
|
-
#
|
260
|
+
# If you call `CreateBackupPlan` with a plan that already exists, an
|
261
|
+
# `AlreadyExistsException` is returned.
|
262
262
|
#
|
263
263
|
# @option params [required, Types::BackupPlanInput] :backup_plan
|
264
264
|
# Specifies the body of a backup plan. Includes a `BackupPlanName` and
|
@@ -301,6 +301,15 @@ module Aws::Backup
|
|
301
301
|
# recovery_point_tags: {
|
302
302
|
# "TagKey" => "TagValue",
|
303
303
|
# },
|
304
|
+
# copy_actions: [
|
305
|
+
# {
|
306
|
+
# lifecycle: {
|
307
|
+
# move_to_cold_storage_after_days: 1,
|
308
|
+
# delete_after_days: 1,
|
309
|
+
# },
|
310
|
+
# destination_backup_vault_arn: "ARN", # required
|
311
|
+
# },
|
312
|
+
# ],
|
304
313
|
# },
|
305
314
|
# ],
|
306
315
|
# },
|
@@ -338,13 +347,13 @@ module Aws::Backup
|
|
338
347
|
#
|
339
348
|
# `ConditionValue:"finance"`
|
340
349
|
#
|
341
|
-
# `ConditionType:"
|
350
|
+
# `ConditionType:"STRINGEQUALS"`
|
342
351
|
#
|
343
352
|
# * `ConditionKey:"importance"`
|
344
353
|
#
|
345
354
|
# `ConditionValue:"critical"`
|
346
355
|
#
|
347
|
-
# `ConditionType:"
|
356
|
+
# `ConditionType:"STRINGEQUALS"`
|
348
357
|
#
|
349
358
|
# Using these patterns would back up all Amazon Elastic Block Store
|
350
359
|
# (Amazon EBS) volumes that are tagged as `"department=finance"`,
|
@@ -365,11 +374,6 @@ module Aws::Backup
|
|
365
374
|
# Specifies the body of a request to assign a set of resources to a
|
366
375
|
# backup plan.
|
367
376
|
#
|
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
377
|
# @option params [String] :creator_request_id
|
374
378
|
# A unique string that identifies the request and allows failed requests
|
375
379
|
# to be retried without the risk of executing the operation twice.
|
@@ -751,6 +755,50 @@ module Aws::Backup
|
|
751
755
|
req.send_request(options)
|
752
756
|
end
|
753
757
|
|
758
|
+
# Returns metadata associated with creating a copy of a resource.
|
759
|
+
#
|
760
|
+
# @option params [required, String] :copy_job_id
|
761
|
+
# Uniquely identifies a request to AWS Backup to copy a resource.
|
762
|
+
#
|
763
|
+
# @return [Types::DescribeCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
764
|
+
#
|
765
|
+
# * {Types::DescribeCopyJobOutput#copy_job #copy_job} => Types::CopyJob
|
766
|
+
#
|
767
|
+
# @example Request syntax with placeholder values
|
768
|
+
#
|
769
|
+
# resp = client.describe_copy_job({
|
770
|
+
# copy_job_id: "string", # required
|
771
|
+
# })
|
772
|
+
#
|
773
|
+
# @example Response structure
|
774
|
+
#
|
775
|
+
# resp.copy_job.copy_job_id #=> String
|
776
|
+
# resp.copy_job.source_backup_vault_arn #=> String
|
777
|
+
# resp.copy_job.source_recovery_point_arn #=> String
|
778
|
+
# resp.copy_job.destination_backup_vault_arn #=> String
|
779
|
+
# resp.copy_job.destination_recovery_point_arn #=> String
|
780
|
+
# resp.copy_job.resource_arn #=> String
|
781
|
+
# resp.copy_job.creation_date #=> Time
|
782
|
+
# resp.copy_job.completion_date #=> Time
|
783
|
+
# resp.copy_job.state #=> String, one of "CREATED", "RUNNING", "COMPLETED", "FAILED"
|
784
|
+
# resp.copy_job.status_message #=> String
|
785
|
+
# resp.copy_job.backup_size_in_bytes #=> Integer
|
786
|
+
# resp.copy_job.iam_role_arn #=> String
|
787
|
+
# resp.copy_job.created_by.backup_plan_id #=> String
|
788
|
+
# resp.copy_job.created_by.backup_plan_arn #=> String
|
789
|
+
# resp.copy_job.created_by.backup_plan_version #=> String
|
790
|
+
# resp.copy_job.created_by.backup_rule_id #=> String
|
791
|
+
# resp.copy_job.resource_type #=> String
|
792
|
+
#
|
793
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJob AWS API Documentation
|
794
|
+
#
|
795
|
+
# @overload describe_copy_job(params = {})
|
796
|
+
# @param [Hash] params ({})
|
797
|
+
def describe_copy_job(params = {}, options = {})
|
798
|
+
req = build_request(:describe_copy_job, params)
|
799
|
+
req.send_request(options)
|
800
|
+
end
|
801
|
+
|
754
802
|
# Returns information about a saved resource, including the last time it
|
755
803
|
# was backed-up, its Amazon Resource Name (ARN), and the AWS service
|
756
804
|
# type of the saved resource.
|
@@ -981,6 +1029,10 @@ module Aws::Backup
|
|
981
1029
|
# resp.backup_plan.rules[0].recovery_point_tags #=> Hash
|
982
1030
|
# resp.backup_plan.rules[0].recovery_point_tags["TagKey"] #=> String
|
983
1031
|
# resp.backup_plan.rules[0].rule_id #=> String
|
1032
|
+
# resp.backup_plan.rules[0].copy_actions #=> Array
|
1033
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1034
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1035
|
+
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
984
1036
|
# resp.backup_plan_id #=> String
|
985
1037
|
# resp.backup_plan_arn #=> String
|
986
1038
|
# resp.version_id #=> String
|
@@ -1027,6 +1079,10 @@ module Aws::Backup
|
|
1027
1079
|
# resp.backup_plan.rules[0].recovery_point_tags #=> Hash
|
1028
1080
|
# resp.backup_plan.rules[0].recovery_point_tags["TagKey"] #=> String
|
1029
1081
|
# resp.backup_plan.rules[0].rule_id #=> String
|
1082
|
+
# resp.backup_plan.rules[0].copy_actions #=> Array
|
1083
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1084
|
+
# resp.backup_plan.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1085
|
+
# resp.backup_plan.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1030
1086
|
#
|
1031
1087
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON AWS API Documentation
|
1032
1088
|
#
|
@@ -1066,6 +1122,10 @@ module Aws::Backup
|
|
1066
1122
|
# resp.backup_plan_document.rules[0].recovery_point_tags #=> Hash
|
1067
1123
|
# resp.backup_plan_document.rules[0].recovery_point_tags["TagKey"] #=> String
|
1068
1124
|
# resp.backup_plan_document.rules[0].rule_id #=> String
|
1125
|
+
# resp.backup_plan_document.rules[0].copy_actions #=> Array
|
1126
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.move_to_cold_storage_after_days #=> Integer
|
1127
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].lifecycle.delete_after_days #=> Integer
|
1128
|
+
# resp.backup_plan_document.rules[0].copy_actions[0].destination_backup_vault_arn #=> String
|
1069
1129
|
#
|
1070
1130
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate AWS API Documentation
|
1071
1131
|
#
|
@@ -1188,7 +1248,7 @@ module Aws::Backup
|
|
1188
1248
|
# resp.backup_vault_arn #=> String
|
1189
1249
|
# resp.sns_topic_arn #=> String
|
1190
1250
|
# 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"
|
1251
|
+
# 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
1252
|
#
|
1193
1253
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications AWS API Documentation
|
1194
1254
|
#
|
@@ -1199,15 +1259,8 @@ module Aws::Backup
|
|
1199
1259
|
req.send_request(options)
|
1200
1260
|
end
|
1201
1261
|
|
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.
|
1262
|
+
# Returns a set of metadata key-value pairs that were used to create the
|
1263
|
+
# backup.
|
1211
1264
|
#
|
1212
1265
|
# @option params [required, String] :backup_vault_name
|
1213
1266
|
# The name of a logical container where backups are stored. Backup
|
@@ -1302,15 +1355,15 @@ module Aws::Backup
|
|
1302
1355
|
# @option params [String] :by_resource_type
|
1303
1356
|
# Returns only backup jobs for the specified resources:
|
1304
1357
|
#
|
1358
|
+
# * `DynamoDB` for Amazon DynamoDB
|
1359
|
+
#
|
1305
1360
|
# * `EBS` for Amazon Elastic Block Store
|
1306
1361
|
#
|
1307
|
-
# * `
|
1362
|
+
# * `EFS` for Amazon Elastic File System
|
1308
1363
|
#
|
1309
1364
|
# * `RDS` for Amazon Relational Database Service
|
1310
1365
|
#
|
1311
|
-
# * `
|
1312
|
-
#
|
1313
|
-
# * `EFS` for Amazon Elastic File System
|
1366
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
1314
1367
|
#
|
1315
1368
|
# @return [Types::ListBackupJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1316
1369
|
#
|
@@ -1599,6 +1652,97 @@ module Aws::Backup
|
|
1599
1652
|
req.send_request(options)
|
1600
1653
|
end
|
1601
1654
|
|
1655
|
+
# Returns metadata about your copy jobs.
|
1656
|
+
#
|
1657
|
+
# @option params [String] :next_token
|
1658
|
+
# The next item following a partial list of returned items. For example,
|
1659
|
+
# if a request is made to return maxResults number of items, NextToken
|
1660
|
+
# allows you to return more items in your list starting at the location
|
1661
|
+
# pointed to by the next token.
|
1662
|
+
#
|
1663
|
+
# @option params [Integer] :max_results
|
1664
|
+
# The maximum number of items to be returned.
|
1665
|
+
#
|
1666
|
+
# @option params [String] :by_resource_arn
|
1667
|
+
# Returns only copy jobs that match the specified resource Amazon
|
1668
|
+
# Resource Name (ARN).
|
1669
|
+
#
|
1670
|
+
# @option params [String] :by_state
|
1671
|
+
# Returns only copy jobs that are in the specified state.
|
1672
|
+
#
|
1673
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_before
|
1674
|
+
# Returns only copy jobs that were created before the specified date.
|
1675
|
+
#
|
1676
|
+
# @option params [Time,DateTime,Date,Integer,String] :by_created_after
|
1677
|
+
# Returns only copy jobs that were created after the specified date.
|
1678
|
+
#
|
1679
|
+
# @option params [String] :by_resource_type
|
1680
|
+
# Returns only backup jobs for the specified resources:
|
1681
|
+
#
|
1682
|
+
# * `DynamoDB` for Amazon DynamoDB
|
1683
|
+
#
|
1684
|
+
# * `EBS` for Amazon Elastic Block Store
|
1685
|
+
#
|
1686
|
+
# * `EFS` for Amazon Elastic File System
|
1687
|
+
#
|
1688
|
+
# * `RDS` for Amazon Relational Database Service
|
1689
|
+
#
|
1690
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
1691
|
+
#
|
1692
|
+
# @option params [String] :by_destination_vault_arn
|
1693
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a source backup
|
1694
|
+
# vault to copy from; for example,
|
1695
|
+
# arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
|
1696
|
+
#
|
1697
|
+
# @return [Types::ListCopyJobsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1698
|
+
#
|
1699
|
+
# * {Types::ListCopyJobsOutput#copy_jobs #copy_jobs} => Array<Types::CopyJob>
|
1700
|
+
# * {Types::ListCopyJobsOutput#next_token #next_token} => String
|
1701
|
+
#
|
1702
|
+
# @example Request syntax with placeholder values
|
1703
|
+
#
|
1704
|
+
# resp = client.list_copy_jobs({
|
1705
|
+
# next_token: "string",
|
1706
|
+
# max_results: 1,
|
1707
|
+
# by_resource_arn: "ARN",
|
1708
|
+
# by_state: "CREATED", # accepts CREATED, RUNNING, COMPLETED, FAILED
|
1709
|
+
# by_created_before: Time.now,
|
1710
|
+
# by_created_after: Time.now,
|
1711
|
+
# by_resource_type: "ResourceType",
|
1712
|
+
# by_destination_vault_arn: "string",
|
1713
|
+
# })
|
1714
|
+
#
|
1715
|
+
# @example Response structure
|
1716
|
+
#
|
1717
|
+
# resp.copy_jobs #=> Array
|
1718
|
+
# resp.copy_jobs[0].copy_job_id #=> String
|
1719
|
+
# resp.copy_jobs[0].source_backup_vault_arn #=> String
|
1720
|
+
# resp.copy_jobs[0].source_recovery_point_arn #=> String
|
1721
|
+
# resp.copy_jobs[0].destination_backup_vault_arn #=> String
|
1722
|
+
# resp.copy_jobs[0].destination_recovery_point_arn #=> String
|
1723
|
+
# resp.copy_jobs[0].resource_arn #=> String
|
1724
|
+
# resp.copy_jobs[0].creation_date #=> Time
|
1725
|
+
# resp.copy_jobs[0].completion_date #=> Time
|
1726
|
+
# resp.copy_jobs[0].state #=> String, one of "CREATED", "RUNNING", "COMPLETED", "FAILED"
|
1727
|
+
# resp.copy_jobs[0].status_message #=> String
|
1728
|
+
# resp.copy_jobs[0].backup_size_in_bytes #=> Integer
|
1729
|
+
# resp.copy_jobs[0].iam_role_arn #=> String
|
1730
|
+
# resp.copy_jobs[0].created_by.backup_plan_id #=> String
|
1731
|
+
# resp.copy_jobs[0].created_by.backup_plan_arn #=> String
|
1732
|
+
# resp.copy_jobs[0].created_by.backup_plan_version #=> String
|
1733
|
+
# resp.copy_jobs[0].created_by.backup_rule_id #=> String
|
1734
|
+
# resp.copy_jobs[0].resource_type #=> String
|
1735
|
+
# resp.next_token #=> String
|
1736
|
+
#
|
1737
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobs AWS API Documentation
|
1738
|
+
#
|
1739
|
+
# @overload list_copy_jobs(params = {})
|
1740
|
+
# @param [Hash] params ({})
|
1741
|
+
def list_copy_jobs(params = {}, options = {})
|
1742
|
+
req = build_request(:list_copy_jobs, params)
|
1743
|
+
req.send_request(options)
|
1744
|
+
end
|
1745
|
+
|
1602
1746
|
# Returns an array of resources successfully backed up by AWS Backup,
|
1603
1747
|
# including the time the resource was saved, an Amazon Resource Name
|
1604
1748
|
# (ARN) of the resource, and a resource type.
|
@@ -1929,7 +2073,7 @@ module Aws::Backup
|
|
1929
2073
|
# resp = client.put_backup_vault_notifications({
|
1930
2074
|
# backup_vault_name: "BackupVaultName", # required
|
1931
2075
|
# 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
|
2076
|
+
# 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
2077
|
# })
|
1934
2078
|
#
|
1935
2079
|
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications AWS API Documentation
|
@@ -1959,12 +2103,7 @@ module Aws::Backup
|
|
1959
2103
|
#
|
1960
2104
|
# @option params [String] :idempotency_token
|
1961
2105
|
# 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.
|
2106
|
+
# to `StartBackupJob`.
|
1968
2107
|
#
|
1969
2108
|
# @option params [Integer] :start_window_minutes
|
1970
2109
|
# The amount of time in minutes before beginning a backup.
|
@@ -2028,6 +2167,75 @@ module Aws::Backup
|
|
2028
2167
|
req.send_request(options)
|
2029
2168
|
end
|
2030
2169
|
|
2170
|
+
# Starts a job to create a one-time copy of the specified resource.
|
2171
|
+
#
|
2172
|
+
# @option params [required, String] :recovery_point_arn
|
2173
|
+
# An ARN that uniquely identifies a recovery point to use for the copy
|
2174
|
+
# job; for example,
|
2175
|
+
# arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
|
2176
|
+
#
|
2177
|
+
# @option params [required, String] :source_backup_vault_name
|
2178
|
+
# The name of a logical source container where backups are stored.
|
2179
|
+
# Backup vaults are identified by names that are unique to the account
|
2180
|
+
# used to create them and the AWS Region where they are created. They
|
2181
|
+
# consist of lowercase letters, numbers, and hyphens. >
|
2182
|
+
#
|
2183
|
+
# @option params [required, String] :destination_backup_vault_arn
|
2184
|
+
# An Amazon Resource Name (ARN) that uniquely identifies a destination
|
2185
|
+
# backup vault to copy to; for example,
|
2186
|
+
# `arn:aws:backup:us-east-1:123456789012:vault:aBackupVault`.
|
2187
|
+
#
|
2188
|
+
# @option params [required, String] :iam_role_arn
|
2189
|
+
# Specifies the IAM role ARN used to copy the target recovery point; for
|
2190
|
+
# example, arn:aws:iam::123456789012:role/S3Access.
|
2191
|
+
#
|
2192
|
+
# @option params [String] :idempotency_token
|
2193
|
+
# A customer chosen string that can be used to distinguish between calls
|
2194
|
+
# to `StartCopyJob`.
|
2195
|
+
#
|
2196
|
+
# @option params [Types::Lifecycle] :lifecycle
|
2197
|
+
# Contains an array of `Transition` objects specifying how long in days
|
2198
|
+
# before a recovery point transitions to cold storage or is deleted.
|
2199
|
+
#
|
2200
|
+
# Backups transitioned to cold storage must be stored in cold storage
|
2201
|
+
# for a minimum of 90 days. Therefore, on the console, the “expire after
|
2202
|
+
# days” setting must be 90 days greater than the “transition to cold
|
2203
|
+
# after days” setting. The “transition to cold after days” setting
|
2204
|
+
# cannot be changed after a backup has been transitioned to cold.
|
2205
|
+
#
|
2206
|
+
# @return [Types::StartCopyJobOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2207
|
+
#
|
2208
|
+
# * {Types::StartCopyJobOutput#copy_job_id #copy_job_id} => String
|
2209
|
+
# * {Types::StartCopyJobOutput#creation_date #creation_date} => Time
|
2210
|
+
#
|
2211
|
+
# @example Request syntax with placeholder values
|
2212
|
+
#
|
2213
|
+
# resp = client.start_copy_job({
|
2214
|
+
# recovery_point_arn: "ARN", # required
|
2215
|
+
# source_backup_vault_name: "BackupVaultName", # required
|
2216
|
+
# destination_backup_vault_arn: "ARN", # required
|
2217
|
+
# iam_role_arn: "IAMRoleArn", # required
|
2218
|
+
# idempotency_token: "string",
|
2219
|
+
# lifecycle: {
|
2220
|
+
# move_to_cold_storage_after_days: 1,
|
2221
|
+
# delete_after_days: 1,
|
2222
|
+
# },
|
2223
|
+
# })
|
2224
|
+
#
|
2225
|
+
# @example Response structure
|
2226
|
+
#
|
2227
|
+
# resp.copy_job_id #=> String
|
2228
|
+
# resp.creation_date #=> Time
|
2229
|
+
#
|
2230
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJob AWS API Documentation
|
2231
|
+
#
|
2232
|
+
# @overload start_copy_job(params = {})
|
2233
|
+
# @param [Hash] params ({})
|
2234
|
+
def start_copy_job(params = {}, options = {})
|
2235
|
+
req = build_request(:start_copy_job, params)
|
2236
|
+
req.send_request(options)
|
2237
|
+
end
|
2238
|
+
|
2031
2239
|
# Recovers the saved resource identified by an Amazon Resource Name
|
2032
2240
|
# (ARN).
|
2033
2241
|
#
|
@@ -2040,8 +2248,37 @@ module Aws::Backup
|
|
2040
2248
|
# `arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45`.
|
2041
2249
|
#
|
2042
2250
|
# @option params [required, Hash<String,String>] :metadata
|
2043
|
-
# A set of metadata key-value pairs.
|
2044
|
-
#
|
2251
|
+
# A set of metadata key-value pairs. Contains information, such as a
|
2252
|
+
# resource name, required to restore a recovery point.
|
2253
|
+
#
|
2254
|
+
# You can get configuration metadata about a resource at the time it was
|
2255
|
+
# backed-up by calling `GetRecoveryPointRestoreMetadata`. However,
|
2256
|
+
# values in addition to those provided by
|
2257
|
+
# `GetRecoveryPointRestoreMetadata` might be required to restore a
|
2258
|
+
# resource. For example, you might need to provide a new resource name
|
2259
|
+
# if the original already exists.
|
2260
|
+
#
|
2261
|
+
# You need to specify specific metadata to restore an Amazon Elastic
|
2262
|
+
# File System (Amazon EFS) instance:
|
2263
|
+
#
|
2264
|
+
# * `file-system-id`\: ID of the Amazon EFS file system that is backed
|
2265
|
+
# up by AWS Backup. Returned in `GetRecoveryPointRestoreMetadata`.
|
2266
|
+
#
|
2267
|
+
# * `Encrypted`\: A Boolean value that, if true, specifies that the file
|
2268
|
+
# system is encrypted. If `KmsKeyId` is specified, `Encrypted` must be
|
2269
|
+
# set to `true`.
|
2270
|
+
#
|
2271
|
+
# * `KmsKeyId`\: Specifies the AWS KMS key that is used to encrypt the
|
2272
|
+
# restored file system.
|
2273
|
+
#
|
2274
|
+
# * `PerformanceMode`\: Specifies the throughput mode of the file
|
2275
|
+
# system.
|
2276
|
+
#
|
2277
|
+
# * `CreationToken`\: A user-supplied value that ensures the uniqueness
|
2278
|
+
# (idempotency) of the request.
|
2279
|
+
#
|
2280
|
+
# * `newFileSystem`\: A Boolean value that, if true, specifies that the
|
2281
|
+
# recovery point is restored to a new Amazon EFS file system.
|
2045
2282
|
#
|
2046
2283
|
# @option params [required, String] :iam_role_arn
|
2047
2284
|
# The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
|
@@ -2050,12 +2287,7 @@ module Aws::Backup
|
|
2050
2287
|
#
|
2051
2288
|
# @option params [String] :idempotency_token
|
2052
2289
|
# 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.
|
2290
|
+
# to `StartRestoreJob`.
|
2059
2291
|
#
|
2060
2292
|
# @option params [String] :resource_type
|
2061
2293
|
# Starts a job to restore a recovery point for one of the following
|
@@ -2063,7 +2295,7 @@ module Aws::Backup
|
|
2063
2295
|
#
|
2064
2296
|
# * `EBS` for Amazon Elastic Block Store
|
2065
2297
|
#
|
2066
|
-
# * `
|
2298
|
+
# * `Storage Gateway` for AWS Storage Gateway
|
2067
2299
|
#
|
2068
2300
|
# * `RDS` for Amazon Relational Database Service
|
2069
2301
|
#
|
@@ -2220,6 +2452,15 @@ module Aws::Backup
|
|
2220
2452
|
# recovery_point_tags: {
|
2221
2453
|
# "TagKey" => "TagValue",
|
2222
2454
|
# },
|
2455
|
+
# copy_actions: [
|
2456
|
+
# {
|
2457
|
+
# lifecycle: {
|
2458
|
+
# move_to_cold_storage_after_days: 1,
|
2459
|
+
# delete_after_days: 1,
|
2460
|
+
# },
|
2461
|
+
# destination_backup_vault_arn: "ARN", # required
|
2462
|
+
# },
|
2463
|
+
# ],
|
2223
2464
|
# },
|
2224
2465
|
# ],
|
2225
2466
|
# },
|
@@ -2324,7 +2565,7 @@ module Aws::Backup
|
|
2324
2565
|
params: params,
|
2325
2566
|
config: config)
|
2326
2567
|
context[:gem_name] = 'aws-sdk-backup'
|
2327
|
-
context[:gem_version] = '1.
|
2568
|
+
context[:gem_version] = '1.11.0'
|
2328
2569
|
Seahorse::Client::Request.new(handlers, context)
|
2329
2570
|
end
|
2330
2571
|
|