Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DynamoDB.RestoreTableFromBackup

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new table from an existing backup. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

You can call RestoreTableFromBackup at a maximum rate of 10 times per second.

You must manually set up the following on the restored table:

Auto scaling policies
IAM policies
Amazon CloudWatch metrics and alarms
Tags
Stream settings
Time to Live (TTL) settings

Synopsis

Creating a Request

data RestoreTableFromBackup Source #

See: newRestoreTableFromBackup smart constructor.

Constructors

RestoreTableFromBackup'

Fields

billingModeOverride :: Maybe BillingMode
The billing mode of the restored table.
globalSecondaryIndexOverride :: Maybe [GlobalSecondaryIndex]
List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
provisionedThroughputOverride :: Maybe ProvisionedThroughput
Provisioned throughput settings for the restored table.
sSESpecificationOverride :: Maybe SSESpecification
The new server-side encryption settings for the restored table.
localSecondaryIndexOverride :: Maybe [LocalSecondaryIndex]
List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.
targetTableName :: Text
The name of the new table to which the backup must be restored.
backupArn :: Text
The Amazon Resource Name (ARN) associated with the backup.

Instances

Instances details

Eq RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods (==) :: RestoreTableFromBackup -> RestoreTableFromBackup -> Bool # (/=) :: RestoreTableFromBackup -> RestoreTableFromBackup -> Bool #
Read RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods readsPrec :: Int -> ReadS RestoreTableFromBackup # readList :: ReadS [RestoreTableFromBackup] # readPrec :: ReadPrec RestoreTableFromBackup # readListPrec :: ReadPrec [RestoreTableFromBackup] #
Show RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods showsPrec :: Int -> RestoreTableFromBackup -> ShowS # show :: RestoreTableFromBackup -> String # showList :: [RestoreTableFromBackup] -> ShowS #
Generic RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Associated Types type Rep RestoreTableFromBackup :: Type -> Type # Methods from :: RestoreTableFromBackup -> Rep RestoreTableFromBackup x # to :: Rep RestoreTableFromBackup x -> RestoreTableFromBackup #
NFData RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods rnf :: RestoreTableFromBackup -> () #
Hashable RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods hashWithSalt :: Int -> RestoreTableFromBackup -> Int # hash :: RestoreTableFromBackup -> Int #
ToJSON RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods toJSON :: RestoreTableFromBackup -> Value # toEncoding :: RestoreTableFromBackup -> Encoding # toJSONList :: [RestoreTableFromBackup] -> Value # toEncodingList :: [RestoreTableFromBackup] -> Encoding #
AWSRequest RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Associated Types type AWSResponse RestoreTableFromBackup # Methods request :: RestoreTableFromBackup -> Request RestoreTableFromBackup # response :: MonadResource m => Logger -> Service -> Proxy RestoreTableFromBackup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreTableFromBackup))) #
ToHeaders RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods toHeaders :: RestoreTableFromBackup -> [Header] #
ToPath RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods toPath :: RestoreTableFromBackup -> ByteString #
ToQuery RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods toQuery :: RestoreTableFromBackup -> QueryString #
type Rep RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup type Rep RestoreTableFromBackup = D1 ('MetaData "RestoreTableFromBackup" "Amazonka.DynamoDB.RestoreTableFromBackup" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "RestoreTableFromBackup'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "billingModeOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BillingMode)) :: (S1 ('MetaSel ('Just "globalSecondaryIndexOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GlobalSecondaryIndex])) :: S1 ('MetaSel ('Just "provisionedThroughputOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughput)))) :: ((S1 ('MetaSel ('Just "sSESpecificationOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSESpecification)) :: S1 ('MetaSel ('Just "localSecondaryIndexOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocalSecondaryIndex]))) :: (S1 ('MetaSel ('Just "targetTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "backupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse RestoreTableFromBackup Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup type AWSResponse RestoreTableFromBackup = RestoreTableFromBackupResponse

newRestoreTableFromBackup Source #

Arguments

:: Text	`$sel:targetTableName:RestoreTableFromBackup'`
-> Text	`$sel:backupArn:RestoreTableFromBackup'`
-> RestoreTableFromBackup

Create a value of RestoreTableFromBackup 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:billingModeOverride:RestoreTableFromBackup', restoreTableFromBackup_billingModeOverride - The billing mode of the restored table.

$sel:globalSecondaryIndexOverride:RestoreTableFromBackup', restoreTableFromBackup_globalSecondaryIndexOverride - List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

$sel:provisionedThroughputOverride:RestoreTableFromBackup', restoreTableFromBackup_provisionedThroughputOverride - Provisioned throughput settings for the restored table.

$sel:sSESpecificationOverride:RestoreTableFromBackup', restoreTableFromBackup_sSESpecificationOverride - The new server-side encryption settings for the restored table.

$sel:localSecondaryIndexOverride:RestoreTableFromBackup', restoreTableFromBackup_localSecondaryIndexOverride - List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

$sel:targetTableName:RestoreTableFromBackup', restoreTableFromBackup_targetTableName - The name of the new table to which the backup must be restored.

$sel:backupArn:RestoreTableFromBackup', restoreTableFromBackup_backupArn - The Amazon Resource Name (ARN) associated with the backup.

Request Lenses

restoreTableFromBackup_billingModeOverride :: Lens' RestoreTableFromBackup (Maybe BillingMode) Source #

The billing mode of the restored table.

restoreTableFromBackup_globalSecondaryIndexOverride :: Lens' RestoreTableFromBackup (Maybe [GlobalSecondaryIndex]) Source #

List of global secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

restoreTableFromBackup_provisionedThroughputOverride :: Lens' RestoreTableFromBackup (Maybe ProvisionedThroughput) Source #

Provisioned throughput settings for the restored table.

restoreTableFromBackup_sSESpecificationOverride :: Lens' RestoreTableFromBackup (Maybe SSESpecification) Source #

The new server-side encryption settings for the restored table.

restoreTableFromBackup_localSecondaryIndexOverride :: Lens' RestoreTableFromBackup (Maybe [LocalSecondaryIndex]) Source #

List of local secondary indexes for the restored table. The indexes provided should match existing secondary indexes. You can choose to exclude some or all of the indexes at the time of restore.

restoreTableFromBackup_targetTableName :: Lens' RestoreTableFromBackup Text Source #

The name of the new table to which the backup must be restored.

restoreTableFromBackup_backupArn :: Lens' RestoreTableFromBackup Text Source #

The Amazon Resource Name (ARN) associated with the backup.

Destructuring the Response

data RestoreTableFromBackupResponse Source #

See: newRestoreTableFromBackupResponse smart constructor.

Constructors

RestoreTableFromBackupResponse'
Fields tableDescription :: Maybe TableDescription The description of the table created from an existing backup. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq RestoreTableFromBackupResponse Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods (==) :: RestoreTableFromBackupResponse -> RestoreTableFromBackupResponse -> Bool # (/=) :: RestoreTableFromBackupResponse -> RestoreTableFromBackupResponse -> Bool #
Read RestoreTableFromBackupResponse Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods readsPrec :: Int -> ReadS RestoreTableFromBackupResponse # readList :: ReadS [RestoreTableFromBackupResponse] # readPrec :: ReadPrec RestoreTableFromBackupResponse # readListPrec :: ReadPrec [RestoreTableFromBackupResponse] #
Show RestoreTableFromBackupResponse Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods showsPrec :: Int -> RestoreTableFromBackupResponse -> ShowS # show :: RestoreTableFromBackupResponse -> String # showList :: [RestoreTableFromBackupResponse] -> ShowS #
Generic RestoreTableFromBackupResponse Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Associated Types type Rep RestoreTableFromBackupResponse :: Type -> Type # Methods from :: RestoreTableFromBackupResponse -> Rep RestoreTableFromBackupResponse x # to :: Rep RestoreTableFromBackupResponse x -> RestoreTableFromBackupResponse #
NFData RestoreTableFromBackupResponse Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup Methods rnf :: RestoreTableFromBackupResponse -> () #
type Rep RestoreTableFromBackupResponse Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableFromBackup type Rep RestoreTableFromBackupResponse = D1 ('MetaData "RestoreTableFromBackupResponse" "Amazonka.DynamoDB.RestoreTableFromBackup" "libZSservicesZSamazonka-dynamodbZSamazonka-dynamodb" 'False) (C1 ('MetaCons "RestoreTableFromBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TableDescription)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newRestoreTableFromBackupResponse Source #

Arguments

:: Int	`$sel:httpStatus:RestoreTableFromBackupResponse'`
-> RestoreTableFromBackupResponse

Create a value of RestoreTableFromBackupResponse 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:tableDescription:RestoreTableFromBackupResponse', restoreTableFromBackupResponse_tableDescription - The description of the table created from an existing backup.

$sel:httpStatus:RestoreTableFromBackupResponse', restoreTableFromBackupResponse_httpStatus - The response's http status code.

Response Lenses

restoreTableFromBackupResponse_tableDescription :: Lens' RestoreTableFromBackupResponse (Maybe TableDescription) Source #

The description of the table created from an existing backup.

restoreTableFromBackupResponse_httpStatus :: Lens' RestoreTableFromBackupResponse Int Source #

The response's http status code.