Recovers the saved resource identified by an Amazon Resource Name (ARN).
backup_start_restore_job(RecoveryPointArn, Metadata, IamRoleArn,
IdempotencyToken, ResourceType)
[required] An ARN that uniquely identifies a recovery point; for example,
arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
[required] A set of metadata key-value pairs. Contains information, such as a resource name, required to restore a recovery point.
You can get configuration metadata about a resource at the time it was
backed up by calling GetRecoveryPointRestoreMetadata
. However, values
in addition to those provided by GetRecoveryPointRestoreMetadata
might
be required to restore a resource. For example, you might need to
provide a new resource name if the original already exists.
You need to specify specific metadata to restore an Amazon Elastic File System (Amazon EFS) instance:
file-system-id
: ID of the Amazon EFS file system that is backed up
by AWS Backup. Returned in GetRecoveryPointRestoreMetadata
.
Encrypted
: A Boolean value that, if true, specifies that the file
system is encrypted. If KmsKeyId
is specified, Encrypted
must be
set to true
.
KmsKeyId
: Specifies the AWS KMS key that is used to encrypt the
restored file system.
PerformanceMode
: Specifies the throughput mode of the file system.
CreationToken
: A user-supplied value that ensures the uniqueness
(idempotency) of the request.
newFileSystem
: A Boolean value that, if true, specifies that the
recovery point is restored to a new Amazon EFS file system.
[required] The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to
create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.
A customer chosen string that can be used to distinguish between calls
to StartRestoreJob
.
Starts a job to restore a recovery point for one of the following resources:
DynamoDB
for Amazon DynamoDB
EBS
for Amazon Elastic Block Store
EC2
for Amazon Elastic Compute Cloud
EFS
for Amazon Elastic File System
RDS
for Amazon Relational Database Service
Storage Gateway
for AWS Storage Gateway
svc$start_restore_job( RecoveryPointArn = "string", Metadata = list( "string" ), IamRoleArn = "string", IdempotencyToken = "string", ResourceType = "string" )
If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.