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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb

Overview

Note:

When making an API call, you may pass StartRestoreJobInput data as a hash:

{
  recovery_point_arn: "ARN", # required
  metadata: { # required
    "MetadataKey" => "MetadataValue",
  },
  iam_role_arn: "IAMRoleArn", # required
  idempotency_token: "string",
  resource_type: "ResourceType",
}

Instance Attribute Summary collapse

Instance Attribute Details

#iam_role_arnString

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.

Returns:

  • (String)


3828
3829
3830
3831
3832
3833
3834
3835
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3828

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type)
  include Aws::Structure
end

#idempotency_tokenString

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

Returns:

  • (String)


3828
3829
3830
3831
3832
3833
3834
3835
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3828

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type)
  include Aws::Structure
end

#metadataHash<String,String>

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.

Returns:

  • (Hash<String,String>)


3828
3829
3830
3831
3832
3833
3834
3835
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3828

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type)
  include Aws::Structure
end

#recovery_point_arnString

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)


3828
3829
3830
3831
3832
3833
3834
3835
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3828

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type)
  include Aws::Structure
end

#resource_typeString

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

  • EBS for Amazon Elastic Block Store

  • Storage Gateway for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

Returns:

  • (String)


3828
3829
3830
3831
3832
3833
3834
3835
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3828

class StartRestoreJobInput < Struct.new(
  :recovery_point_arn,
  :metadata,
  :iam_role_arn,
  :idempotency_token,
  :resource_type)
  include Aws::Structure
end