NAME

Paws::Backup::StartRestoreJob - Arguments for method StartRestoreJob on Paws::Backup

DESCRIPTION

This class represents the parameters used for calling the method StartRestoreJob on the AWS Backup service. Use the attributes of this class as arguments to method StartRestoreJob.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartRestoreJob.

SYNOPSIS

    my $backup = Paws->service('Backup');
    my $StartRestoreJobOutput = $backup->StartRestoreJob(
      IamRoleArn       => 'MyIAMRoleArn',
      Metadata         => { 'MyMetadataKey' => 'MyMetadataValue', },
      RecoveryPointArn => 'MyARN',
      IdempotencyToken => 'Mystring',                                 # OPTIONAL
      ResourceType     => 'MyResourceType',                           # OPTIONAL
    );

    # Results:
    my $RestoreJobId = $StartRestoreJobOutput->RestoreJobId;

    # Returns a L<Paws::Backup::StartRestoreJobOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/backup/StartRestoreJob

ATTRIBUTES

REQUIRED IamRoleArn => Str

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.

IdempotencyToken => Str

A customer chosen string that can be used to distinguish between calls to StartRestoreJob.

REQUIRED Metadata => Paws::Backup::Metadata

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 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. You can specify a key from another AWS account provided that key it is properly shared with your account via AWS 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\"]".

REQUIRED RecoveryPointArn => Str

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

ResourceType => Str

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

• Aurora for Amazon Aurora

• Storage Gateway for AWS Storage Gateway

SEE ALSO

This class forms part of Paws, documenting arguments for method StartRestoreJob in Paws::Backup

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues