Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.DynamoDB.RestoreTableToPointInTime

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Restores the specified table to the specified point in time within EarliestRestorableDateTime and LatestRestorableDateTime. You can restore your table to any point in time during the last 35 days. Any number of users can execute up to 4 concurrent restores (any type of restore) in a given account.

When you restore using point in time recovery, DynamoDB restores your table data to the state based on the selected date and time (day:hour:minute:second) to a new table.

Along with data, the following are also included on the new restored table using point in time recovery:

Global secondary indexes (GSIs)
Local secondary indexes (LSIs)
Provisioned read and write capacity
Encryption settings
All these settings come from the current settings of the source table at the time of restore.

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
Point in time recovery settings

Synopsis

Creating a Request

data RestoreTableToPointInTime Source #

See: newRestoreTableToPointInTime smart constructor.

Constructors

RestoreTableToPointInTime'

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.
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.
provisionedThroughputOverride :: Maybe ProvisionedThroughput
Provisioned throughput settings for the restored table.
restoreDateTime :: Maybe POSIX
Time in the past to restore the table to.
sSESpecificationOverride :: Maybe SSESpecification
The new server-side encryption settings for the restored table.
sourceTableArn :: Maybe Text
The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).
sourceTableName :: Maybe Text
Name of the source table that is being restored.
useLatestRestorableTime :: Maybe Bool
Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.
targetTableName :: Text
The name of the new table to which it must be restored to.

Instances

Instances details

ToJSON RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods toJSON :: RestoreTableToPointInTime -> Value # toEncoding :: RestoreTableToPointInTime -> Encoding # toJSONList :: [RestoreTableToPointInTime] -> Value # toEncodingList :: [RestoreTableToPointInTime] -> Encoding #
ToHeaders RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods toHeaders :: RestoreTableToPointInTime -> [Header] #
ToPath RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods toPath :: RestoreTableToPointInTime -> ByteString #
ToQuery RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods toQuery :: RestoreTableToPointInTime -> QueryString #
AWSRequest RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Associated Types type AWSResponse RestoreTableToPointInTime # Methods request :: (Service -> Service) -> RestoreTableToPointInTime -> Request RestoreTableToPointInTime # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreTableToPointInTime -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreTableToPointInTime))) #
Generic RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Associated Types type Rep RestoreTableToPointInTime :: Type -> Type # Methods from :: RestoreTableToPointInTime -> Rep RestoreTableToPointInTime x # to :: Rep RestoreTableToPointInTime x -> RestoreTableToPointInTime #
Read RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods readsPrec :: Int -> ReadS RestoreTableToPointInTime # readList :: ReadS [RestoreTableToPointInTime] # readPrec :: ReadPrec RestoreTableToPointInTime # readListPrec :: ReadPrec [RestoreTableToPointInTime] #
Show RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods showsPrec :: Int -> RestoreTableToPointInTime -> ShowS # show :: RestoreTableToPointInTime -> String # showList :: [RestoreTableToPointInTime] -> ShowS #
NFData RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods rnf :: RestoreTableToPointInTime -> () #
Eq RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods (==) :: RestoreTableToPointInTime -> RestoreTableToPointInTime -> Bool # (/=) :: RestoreTableToPointInTime -> RestoreTableToPointInTime -> Bool #
Hashable RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime Methods hashWithSalt :: Int -> RestoreTableToPointInTime -> Int # hash :: RestoreTableToPointInTime -> Int #
type AWSResponse RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime type AWSResponse RestoreTableToPointInTime = RestoreTableToPointInTimeResponse
type Rep RestoreTableToPointInTime Source #
Instance details Defined in Amazonka.DynamoDB.RestoreTableToPointInTime type Rep RestoreTableToPointInTime = D1 ('MetaData "RestoreTableToPointInTime" "Amazonka.DynamoDB.RestoreTableToPointInTime" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "RestoreTableToPointInTime'" '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 "localSecondaryIndexOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [LocalSecondaryIndex])) :: (S1 ('MetaSel ('Just "provisionedThroughputOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProvisionedThroughput)) :: S1 ('MetaSel ('Just "restoreDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))))) :: ((S1 ('MetaSel ('Just "sSESpecificationOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SSESpecification)) :: S1 ('MetaSel ('Just "sourceTableArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "sourceTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "useLatestRestorableTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "targetTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRestoreTableToPointInTime Source #

Arguments

:: Text	`$sel:targetTableName:RestoreTableToPointInTime'`
-> RestoreTableToPointInTime

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

$sel:globalSecondaryIndexOverride:RestoreTableToPointInTime', restoreTableToPointInTime_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:localSecondaryIndexOverride:RestoreTableToPointInTime', restoreTableToPointInTime_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.

RestoreTableToPointInTime, restoreTableToPointInTime_provisionedThroughputOverride - Provisioned throughput settings for the restored table.

RestoreTableToPointInTime, restoreTableToPointInTime_restoreDateTime - Time in the past to restore the table to.

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

RestoreTableToPointInTime, restoreTableToPointInTime_sourceTableArn - The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).

$sel:sourceTableName:RestoreTableToPointInTime', restoreTableToPointInTime_sourceTableName - Name of the source table that is being restored.

$sel:useLatestRestorableTime:RestoreTableToPointInTime', restoreTableToPointInTime_useLatestRestorableTime - Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

$sel:targetTableName:RestoreTableToPointInTime', restoreTableToPointInTime_targetTableName - The name of the new table to which it must be restored to.

Request Lenses

restoreTableToPointInTime_billingModeOverride :: Lens' RestoreTableToPointInTime (Maybe BillingMode) Source #

The billing mode of the restored table.

restoreTableToPointInTime_globalSecondaryIndexOverride :: Lens' RestoreTableToPointInTime (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.

restoreTableToPointInTime_localSecondaryIndexOverride :: Lens' RestoreTableToPointInTime (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.

restoreTableToPointInTime_provisionedThroughputOverride :: Lens' RestoreTableToPointInTime (Maybe ProvisionedThroughput) Source #

Provisioned throughput settings for the restored table.

restoreTableToPointInTime_restoreDateTime :: Lens' RestoreTableToPointInTime (Maybe UTCTime) Source #

Time in the past to restore the table to.

restoreTableToPointInTime_sSESpecificationOverride :: Lens' RestoreTableToPointInTime (Maybe SSESpecification) Source #

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

restoreTableToPointInTime_sourceTableArn :: Lens' RestoreTableToPointInTime (Maybe Text) Source #

The DynamoDB table that will be restored. This value is an Amazon Resource Name (ARN).

restoreTableToPointInTime_sourceTableName :: Lens' RestoreTableToPointInTime (Maybe Text) Source #

Name of the source table that is being restored.

restoreTableToPointInTime_useLatestRestorableTime :: Lens' RestoreTableToPointInTime (Maybe Bool) Source #

Restore the table to the latest possible time. LatestRestorableDateTime is typically 5 minutes before the current time.

restoreTableToPointInTime_targetTableName :: Lens' RestoreTableToPointInTime Text Source #

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

Destructuring the Response

data RestoreTableToPointInTimeResponse Source #

See: newRestoreTableToPointInTimeResponse smart constructor.

Constructors

RestoreTableToPointInTimeResponse'
Fields tableDescription :: Maybe TableDescription Represents the properties of a table. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newRestoreTableToPointInTimeResponse Source #

Arguments

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

Create a value of RestoreTableToPointInTimeResponse 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:RestoreTableToPointInTimeResponse', restoreTableToPointInTimeResponse_tableDescription - Represents the properties of a table.

$sel:httpStatus:RestoreTableToPointInTimeResponse', restoreTableToPointInTimeResponse_httpStatus - The response's http status code.

Response Lenses

restoreTableToPointInTimeResponse_tableDescription :: Lens' RestoreTableToPointInTimeResponse (Maybe TableDescription) Source #

Represents the properties of a table.

restoreTableToPointInTimeResponse_httpStatus :: Lens' RestoreTableToPointInTimeResponse Int Source #

The response's http status code.