You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::Backup::Types::StartRestoreJobInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::StartRestoreJobInput
- Defined in:
- (unknown)
Overview
When passing StartRestoreJobInput as input to an Aws::Client method, you can use a vanilla 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
-
#iam_role_arn ⇒ String
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
. -
#idempotency_token ⇒ String
A customer chosen string that can be used to distinguish between 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
#iam_role_arn ⇒ String
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
.
#idempotency_token ⇒ String
A customer chosen string that can be used to distinguish between calls
to StartRestoreJob
.
#metadata ⇒ Hash<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
: The ID of the Amazon EFS file system that is backed up by AWS Backup. Returned inGetRecoveryPointRestoreMetadata
.Encrypted
: A Boolean value that, if true, specifies that the file system is encrypted. IfKmsKeyId
is specified,Encrypted
must be set totrue
.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
: A serialized list of up to five strings where each string is a file path. UseItemsToRestore
to restore specific files or directories rather than the entire file system. This parameter is optional.
#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:
DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemRDS
for Amazon Relational Database ServiceStorage Gateway
for AWS Storage Gateway