Class: Aws::Backup::Types::StartRestoreJobInput

Inherits:

Struct

• Object
• Struct
• Aws::Backup::Types::StartRestoreJobInput

Includes:

Structure

Defined in:

lib/aws-sdk-backup/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:metadata]

Instance Attribute Summary

• #copy_source_tags_to_restored_resource ⇒ Boolean

  This is an optional parameter.

• #iam_role_arn ⇒ String

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

• #idempotency_token ⇒ String

  A customer-chosen string that you can use to distinguish between otherwise identical calls to ‘StartRestoreJob`.

• #metadata ⇒ Hash<String,String>

  A set of metadata key-value pairs.

• #recovery_point_arn ⇒ String

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

• #resource_type ⇒ String

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

Instance Attribute Details

#copy_source_tags_to_restored_resource ⇒ Boolean

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.

Returns:

• (Boolean)

# File 'lib/aws-sdk-backup/types.rb', line 8350

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type,
  :copy_source_tags_to_restored_resource)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#iam_role_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8350

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type,
  :copy_source_tags_to_restored_resource)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#idempotency_token ⇒ String

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.

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8350

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type,
  :copy_source_tags_to_restored_resource)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

A set of metadata key-value pairs.

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.

For more information about the metadata for each resource, see the following:

• Metadata for Amazon Aurora][1

• Metadata for Amazon DocumentDB][2

• Metadata for CloudFormation][3

• Metadata for Amazon DynamoDB][4

• Metadata for Amazon EBS][5

• Metadata for Amazon EC2][6

• Metadata for Amazon EFS][7

• Metadata for Amazon FSx][8

• Metadata for Amazon Neptune][9

• Metadata for Amazon RDS][10

• Metadata for Amazon Redshift][11

• Metadata for Storage Gateway][12

• Metadata for Amazon S3][13

• Metadata for Amazon Timestream][14

• Metadata for virtual machines][15

[1]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-aur.html#aur-restore-cli [2]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-docdb.html#docdb-restore-cli [3]: docs.aws.amazon.com/aws-backup/latest/devguide/restore-application-stacks.html#restoring-cfn-cli [4]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-dynamodb.html#ddb-restore-cli [5]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ebs.html#ebs-restore-cli [6]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-ec2.html#restoring-ec2-cli [7]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-efs.html#efs-restore-cli [8]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-fsx.html#fsx-restore-cli [9]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-nep.html#nep-restore-cli [10]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-rds.html#rds-restore-cli [11]: docs.aws.amazon.com/aws-backup/latest/devguide/redshift-restores.html#redshift-restore-api [12]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-storage-gateway.html#restoring-sgw-cli [13]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-s3.html#s3-restore-cli [14]: docs.aws.amazon.com/aws-backup/latest/devguide/timestream-restore.html#timestream-restore-api [15]: docs.aws.amazon.com/aws-backup/latest/devguide/restoring-vm.html#vm-restore-cli

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-backup/types.rb', line 8350

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type,
  :copy_source_tags_to_restored_resource)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#recovery_point_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8350

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type,
  :copy_source_tags_to_restored_resource)
  SENSITIVE = [:metadata]
  include Aws::Structure
end

#resource_type ⇒ String

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

• ‘Aurora` - Amazon Aurora

• ‘DocumentDB` - Amazon DocumentDB

• ‘CloudFormation` - CloudFormation

• ‘DynamoDB` - Amazon DynamoDB

• ‘EBS` - Amazon Elastic Block Store

• ‘EC2` - Amazon Elastic Compute Cloud

• ‘EFS` - Amazon Elastic File System

• ‘FSx` - Amazon FSx

• ‘Neptune` - Amazon Neptune

• ‘RDS` - Amazon Relational Database Service

• ‘Redshift` - Amazon Redshift

• ‘Storage Gateway` - Storage Gateway

• ‘S3` - Amazon Simple Storage Service

• ‘Timestream` - Amazon Timestream

• ‘VirtualMachine` - Virtual machines

Returns:

• (String)

# File 'lib/aws-sdk-backup/types.rb', line 8350

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type,
  :copy_source_tags_to_restored_resource)
  SENSITIVE = [:metadata]
  include Aws::Structure
end