Class: Aws::Backup::Types::StartRestoreJobInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::Backup::Types::StartRestoreJobInput
- Defined in:
- gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb
Overview
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",
idempotency_token: "string",
resource_type: "ResourceType",
}
Constant Summary collapse
- SENSITIVE =
[:metadata]
Instance Attribute Summary collapse
-
#iam_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the target recovery point; 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
#iam_role_arn ⇒ String
The Amazon Resource Name (ARN) of the IAM role that Backup uses to
create the target recovery point; for example,
arn:aws:iam::123456789012:role/S3Access
.
6124 6125 6126 6127 6128 6129 6130 6131 6132 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6124 class StartRestoreJobInput < Struct.new( :recovery_point_arn, :metadata, :iam_role_arn, :idempotency_token, :resource_type) 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.
6124 6125 6126 6127 6128 6129 6130 6131 6132 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6124 class StartRestoreJobInput < Struct.new( :recovery_point_arn, :metadata, :iam_role_arn, :idempotency_token, :resource_type) SENSITIVE = [:metadata] include Aws::Structure end |
#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 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 Amazon Web Services KMS key that is used to encrypt the restored file system. You can specify a key from another Amazon Web Services account provided that key it is properly shared with your account via Amazon Web Services 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. UseItemsToRestore
to restore specific files or directories rather than the entire file system. This parameter is optional. For example,"itemsToRestore":"["/my.test"]"
.
6124 6125 6126 6127 6128 6129 6130 6131 6132 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6124 class StartRestoreJobInput < Struct.new( :recovery_point_arn, :metadata, :iam_role_arn, :idempotency_token, :resource_type) 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
.
6124 6125 6126 6127 6128 6129 6130 6131 6132 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6124 class StartRestoreJobInput < Struct.new( :recovery_point_arn, :metadata, :iam_role_arn, :idempotency_token, :resource_type) SENSITIVE = [:metadata] include Aws::Structure end |
#resource_type ⇒ String
Starts a job to restore a recovery point for one of the following resources:
Aurora
for Amazon AuroraDocumentDB
for Amazon DocumentDB (with MongoDB compatibility)DynamoDB
for Amazon DynamoDBEBS
for Amazon Elastic Block StoreEC2
for Amazon Elastic Compute CloudEFS
for Amazon Elastic File SystemFSx
for Amazon FSxNeptune
for Amazon NeptuneRDS
for Amazon Relational Database ServiceStorage Gateway
for Storage GatewayS3
for Amazon S3VirtualMachine
for virtual machines
6124 6125 6126 6127 6128 6129 6130 6131 6132 |
# File 'gems/aws-sdk-backup/lib/aws-sdk-backup/types.rb', line 6124 class StartRestoreJobInput < Struct.new( :recovery_point_arn, :metadata, :iam_role_arn, :idempotency_token, :resource_type) SENSITIVE = [:metadata] include Aws::Structure end |