You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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)


3403
3404
3405
3406
3407
3408
3409
3410
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3403

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. Idempotency tokens time out after one hour. Therefore, if you call StartRestoreJob multiple times with the same idempotency token within one hour, AWS Backup recognizes that you are requesting only one restore job and initiates only one. If you change the idempotency token for each call, AWS Backup recognizes that you are requesting to start multiple restores.

Returns:

  • (String)


3403
3404
3405
3406
3407
3408
3409
3410
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3403

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. Lists the metadata that the recovery point was created with.

Returns:

  • (Hash<String,String>)


3403
3404
3405
3406
3407
3408
3409
3410
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3403

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)


3403
3404
3405
3406
3407
3408
3409
3410
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3403

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

  • SGW for AWS Storage Gateway

  • RDS for Amazon Relational Database Service

  • DDB for Amazon DynamoDB

  • EFS for Amazon Elastic File System

Returns:

  • (String)


3403
3404
3405
3406
3407
3408
3409
3410
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 3403

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