AWS Backup

{'CopySourceTagsToRestoredResource': 'boolean'}

Recovers the saved resource identified by an Amazon Resource Name (ARN).

See also: AWS API Documentation

Request Syntax

client.start_restore_job(
    RecoveryPointArn='string',
    Metadata={
        'string': 'string'
    },
    IamRoleArn='string',
    IdempotencyToken='string',
    ResourceType='string',
    CopySourceTagsToRestoredResource=True|False
)

type RecoveryPointArn

string

param RecoveryPointArn

[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 .

type Metadata

dict

param Metadata

[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 : The ID of the Amazon EFS file system that is backed up by 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 Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services KMS.

• 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.

• ItemsToRestore : An array of one to five strings where each string is a file path. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]" .

• (string) --

  • (string) --

type IamRoleArn

string

param IamRoleArn

The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target resource; for example: arn:aws:iam::123456789012:role/S3Access .

type IdempotencyToken

string

param IdempotencyToken

A customer-chosen string that you can use to distinguish between otherwise identical calls to StartRestoreJob . Retrying a successful request with the same idempotency token results in a success message with no action taken.

type ResourceType

string

param ResourceType

Starts a job to restore a recovery point for one of the following resources:

• Aurora for Amazon Aurora

• DocumentDB for Amazon DocumentDB (with MongoDB compatibility)

• CloudFormation for CloudFormation

• DynamoDB for Amazon DynamoDB

• EBS for Amazon Elastic Block Store

• EC2 for Amazon Elastic Compute Cloud

• EFS for Amazon Elastic File System

• FSx for Amazon FSx

• Neptune for Amazon Neptune

• RDS for Amazon Relational Database Service

• Redshift for Amazon Redshift

• Storage Gateway for Storage Gateway

• S3 for Amazon S3

• Timestream for Amazon Timestream

• VirtualMachine for virtual machines

type CopySourceTagsToRestoredResource

boolean

param CopySourceTagsToRestoredResource

This is an optional parameter. If this equals True , tags included in the backup will be copied to the restored resource.

This can only be applied to backups created through Backup.

rtype

dict

returns

Response Syntax

{
    'RestoreJobId': 'string'
}

Response Structure

• (dict) --

  • RestoreJobId (string) --

    Uniquely identifies the job that restores a recovery point.