libZSservicesZSamazonka-backupZSamazonka-backup
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Backup.StartRestoreJob

Description

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Synopsis

Creating a Request

data StartRestoreJob Source #

See: newStartRestoreJob smart constructor.

Constructors

StartRestoreJob' 

Fields

  • idempotencyToken :: Maybe Text

    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.

  • resourceType :: Maybe Text

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

    • DynamoDB for Amazon DynamoDB
    • EBS for Amazon Elastic Block Store
    • EC2 for Amazon Elastic Compute Cloud
    • EFS for Amazon Elastic File System
    • RDS for Amazon Relational Database Service
    • Aurora for Amazon Aurora
    • Storage Gateway for Storage Gateway
  • recoveryPointArn :: Text

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

  • metadata :: Sensitive (HashMap Text Text)

    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 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 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. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".
  • iamRoleArn :: Text

    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.

Instances

Instances details
Eq StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

(==) :: StartRestoreJob -> StartRestoreJob -> Bool #

(/=) :: StartRestoreJob -> StartRestoreJob -> Bool #

Show StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

showsPrec :: Int -> StartRestoreJob -> ShowS #

show :: StartRestoreJob -> String #

showList :: [StartRestoreJob] -> ShowS #

Generic StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Associated Types

type Rep StartRestoreJob :: Type -> Type #

Methods

from :: StartRestoreJob -> Rep StartRestoreJob x #

to :: Rep StartRestoreJob x -> StartRestoreJob #

NFData StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

rnf :: StartRestoreJob -> () #

Hashable StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

hashWithSalt :: Int -> StartRestoreJob -> Int #

hash :: StartRestoreJob -> Int #

ToJSON StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

toJSON :: StartRestoreJob -> Value #

toEncoding :: StartRestoreJob -> Encoding #

toJSONList :: [StartRestoreJob] -> Value #

toEncodingList :: [StartRestoreJob] -> Encoding #

AWSRequest StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Associated Types

type AWSResponse StartRestoreJob #

Methods

request :: StartRestoreJob -> Request StartRestoreJob #

response :: MonadResource m => Logger -> Service -> Proxy StartRestoreJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartRestoreJob))) #

ToHeaders StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

toHeaders :: StartRestoreJob -> [Header] #

ToPath StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

toPath :: StartRestoreJob -> ByteString #

ToQuery StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

toQuery :: StartRestoreJob -> QueryString #

type Rep StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

type Rep StartRestoreJob = D1 ('MetaData "StartRestoreJob" "Amazonka.Backup.StartRestoreJob" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "StartRestoreJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "recoveryPointArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "metadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive (HashMap Text Text))) :*: S1 ('MetaSel ('Just "iamRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse StartRestoreJob Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

type AWSResponse StartRestoreJob = StartRestoreJobResponse

newStartRestoreJob Source #

Arguments

:: Text

$sel:recoveryPointArn:StartRestoreJob'

-> Text

$sel:iamRoleArn:StartRestoreJob'

-> StartRestoreJob 

Create a value of StartRestoreJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:idempotencyToken:StartRestoreJob', startRestoreJob_idempotencyToken - 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.

$sel:resourceType:StartRestoreJob', startRestoreJob_resourceType - Starts a job to restore a recovery point for one of the following resources:

  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • RDS for Amazon Relational Database Service
  • Aurora for Amazon Aurora
  • Storage Gateway for Storage Gateway

$sel:recoveryPointArn:StartRestoreJob', startRestoreJob_recoveryPointArn - An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

$sel:metadata:StartRestoreJob', startRestoreJob_metadata - 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 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 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. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

$sel:iamRoleArn:StartRestoreJob', startRestoreJob_iamRoleArn - 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.

Request Lenses

startRestoreJob_idempotencyToken :: Lens' StartRestoreJob (Maybe Text) Source #

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.

startRestoreJob_resourceType :: Lens' StartRestoreJob (Maybe Text) Source #

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

  • DynamoDB for Amazon DynamoDB
  • EBS for Amazon Elastic Block Store
  • EC2 for Amazon Elastic Compute Cloud
  • EFS for Amazon Elastic File System
  • RDS for Amazon Relational Database Service
  • Aurora for Amazon Aurora
  • Storage Gateway for Storage Gateway

startRestoreJob_recoveryPointArn :: Lens' StartRestoreJob Text Source #

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

startRestoreJob_metadata :: Lens' StartRestoreJob (HashMap Text Text) Source #

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 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 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. Use ItemsToRestore to restore specific files or directories rather than the entire file system. This parameter is optional. For example, "itemsToRestore":"[\"/my.test\"]".

startRestoreJob_iamRoleArn :: Lens' StartRestoreJob Text Source #

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.

Destructuring the Response

data StartRestoreJobResponse Source #

See: newStartRestoreJobResponse smart constructor.

Constructors

StartRestoreJobResponse' 

Fields

Instances

Instances details
Eq StartRestoreJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

(==) :: StartRestoreJobResponse -> StartRestoreJobResponse -> Bool #

(/=) :: StartRestoreJobResponse -> StartRestoreJobResponse -> Bool #

Read StartRestoreJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

readsPrec :: Int -> ReadS StartRestoreJobResponse #

readList :: ReadS [StartRestoreJobResponse] #

readPrec :: ReadPrec StartRestoreJobResponse #

readListPrec :: ReadPrec [StartRestoreJobResponse] #

Show StartRestoreJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

showsPrec :: Int -> StartRestoreJobResponse -> ShowS #

show :: StartRestoreJobResponse -> String #

showList :: [StartRestoreJobResponse] -> ShowS #

Generic StartRestoreJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Associated Types

type Rep StartRestoreJobResponse :: Type -> Type #

Methods

from :: StartRestoreJobResponse -> Rep StartRestoreJobResponse x #

to :: Rep StartRestoreJobResponse x -> StartRestoreJobResponse #

NFData StartRestoreJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

Methods

rnf :: StartRestoreJobResponse -> () #

type Rep StartRestoreJobResponse Source # 
Instance details

Defined in Amazonka.Backup.StartRestoreJob

type Rep StartRestoreJobResponse = D1 ('MetaData "StartRestoreJobResponse" "Amazonka.Backup.StartRestoreJob" "libZSservicesZSamazonka-backupZSamazonka-backup" 'False) (C1 ('MetaCons "StartRestoreJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restoreJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStartRestoreJobResponse Source #

Arguments

:: Int

$sel:httpStatus:StartRestoreJobResponse'

-> StartRestoreJobResponse 

Create a value of StartRestoreJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restoreJobId:StartRestoreJobResponse', startRestoreJobResponse_restoreJobId - Uniquely identifies the job that restores a recovery point.

$sel:httpStatus:StartRestoreJobResponse', startRestoreJobResponse_httpStatus - The response's http status code.

Response Lenses

startRestoreJobResponse_restoreJobId :: Lens' StartRestoreJobResponse (Maybe Text) Source #

Uniquely identifies the job that restores a recovery point.

startRestoreJobResponse_httpStatus :: Lens' StartRestoreJobResponse Int Source #

The response's http status code.