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.KeySpaces.RestoreTable

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Restores the specified table to the specified point in time within the earliest_restorable_timestamp and the current time. For more information about restore points, see Time window for PITR continuous backups in the Amazon Keyspaces Developer Guide.

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, Amazon Keyspaces restores your source table's schema and data to the state based on the selected timestamp (day:hour:minute:second) to a new table. The Time to Live (TTL) settings are also restored to the state based on the selected timestamp.

In addition to the table's schema, data, and TTL settings, RestoreTable restores the capacity mode, encryption, and point-in-time recovery settings from the source table. Unlike the table's schema data and TTL settings, which are restored based on the selected timestamp, these settings are always restored based on the table's settings as of the current time or when the table was deleted.

You can also overwrite these settings during restore:

• Read/write capacity mode

• Provisioned throughput capacity settings

• Point-in-time (PITR) settings

• Tags

For more information, see PITR restore settings in the Amazon Keyspaces Developer Guide.

Note that the following settings are not restored, and you must configure them manually for the new table:

• Automatic scaling policies (for tables that use provisioned capacity mode)

• Identity and Access Management (IAM) policies

• Amazon CloudWatch metrics and alarms

Synopsis

data RestoreTable = RestoreTable' {
}
newRestoreTable :: Text -> Text -> Text -> Text -> RestoreTable
restoreTable_capacitySpecificationOverride :: Lens' RestoreTable (Maybe CapacitySpecification)
restoreTable_encryptionSpecificationOverride :: Lens' RestoreTable (Maybe EncryptionSpecification)
restoreTable_pointInTimeRecoveryOverride :: Lens' RestoreTable (Maybe PointInTimeRecovery)
restoreTable_restoreTimestamp :: Lens' RestoreTable (Maybe UTCTime)
restoreTable_tagsOverride :: Lens' RestoreTable (Maybe (NonEmpty Tag))
restoreTable_sourceKeyspaceName :: Lens' RestoreTable Text
restoreTable_sourceTableName :: Lens' RestoreTable Text
restoreTable_targetKeyspaceName :: Lens' RestoreTable Text
restoreTable_targetTableName :: Lens' RestoreTable Text
data RestoreTableResponse = RestoreTableResponse' {
- httpStatus :: Int
- restoredTableARN :: Text
}
newRestoreTableResponse :: Int -> Text -> RestoreTableResponse
restoreTableResponse_httpStatus :: Lens' RestoreTableResponse Int
restoreTableResponse_restoredTableARN :: Lens' RestoreTableResponse Text

Creating a Request

data RestoreTable Source #

See: newRestoreTable smart constructor.

Constructors

RestoreTable'

Fields

capacitySpecificationOverride :: Maybe CapacitySpecification
Specifies the read/write throughput capacity mode for the target table. The options are:
• throughputMode:PAY_PER_REQUEST
• throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.
The default is throughput_mode:PAY_PER_REQUEST.
For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.
encryptionSpecificationOverride :: Maybe EncryptionSpecification
Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):
• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.
• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.
The default is type:AWS_OWNED_KMS_KEY.
For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.
pointInTimeRecoveryOverride :: Maybe PointInTimeRecovery
Specifies the pointInTimeRecovery settings for the target table. The options are:
• ENABLED
• DISABLED
If it's not specified, the default is DISABLED.
For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.
restoreTimestamp :: Maybe POSIX
The restore timestamp in ISO 8601 format.
tagsOverride :: Maybe (NonEmpty Tag)
A list of key-value pair tags to be attached to the restored table.
For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.
sourceKeyspaceName :: Text
The keyspace name of the source table.
sourceTableName :: Text
The name of the source table.
targetKeyspaceName :: Text
The name of the target keyspace.
targetTableName :: Text
The name of the target table.

Instances

Instances details

ToJSON RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods toJSON :: RestoreTable -> Value # toEncoding :: RestoreTable -> Encoding # toJSONList :: [RestoreTable] -> Value # toEncodingList :: [RestoreTable] -> Encoding #
ToHeaders RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods toHeaders :: RestoreTable -> [Header] #
ToPath RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods toPath :: RestoreTable -> ByteString #
ToQuery RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods toQuery :: RestoreTable -> QueryString #
AWSRequest RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Associated Types type AWSResponse RestoreTable # Methods request :: (Service -> Service) -> RestoreTable -> Request RestoreTable # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RestoreTable -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RestoreTable))) #
Generic RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Associated Types type Rep RestoreTable :: Type -> Type # Methods from :: RestoreTable -> Rep RestoreTable x # to :: Rep RestoreTable x -> RestoreTable #
Read RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods readsPrec :: Int -> ReadS RestoreTable # readList :: ReadS [RestoreTable] # readPrec :: ReadPrec RestoreTable # readListPrec :: ReadPrec [RestoreTable] #
Show RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods showsPrec :: Int -> RestoreTable -> ShowS # show :: RestoreTable -> String # showList :: [RestoreTable] -> ShowS #
NFData RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods rnf :: RestoreTable -> () #
Eq RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods (==) :: RestoreTable -> RestoreTable -> Bool # (/=) :: RestoreTable -> RestoreTable -> Bool #
Hashable RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable Methods hashWithSalt :: Int -> RestoreTable -> Int # hash :: RestoreTable -> Int #
type AWSResponse RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable type AWSResponse RestoreTable = RestoreTableResponse
type Rep RestoreTable Source #
Instance details Defined in Amazonka.KeySpaces.RestoreTable type Rep RestoreTable = D1 ('MetaData "RestoreTable" "Amazonka.KeySpaces.RestoreTable" "amazonka-keyspaces-2.0-IgmNF4xdaFLH03VHAkrBWw" 'False) (C1 ('MetaCons "RestoreTable'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capacitySpecificationOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CapacitySpecification)) :: S1 ('MetaSel ('Just "encryptionSpecificationOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EncryptionSpecification))) :: (S1 ('MetaSel ('Just "pointInTimeRecoveryOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PointInTimeRecovery)) :: S1 ('MetaSel ('Just "restoreTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "tagsOverride") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Tag))) :: S1 ('MetaSel ('Just "sourceKeyspaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "sourceTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "targetKeyspaceName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "targetTableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRestoreTable Source #

Arguments

:: Text	`$sel:sourceKeyspaceName:RestoreTable'`
-> Text	`$sel:sourceTableName:RestoreTable'`
-> Text	`$sel:targetKeyspaceName:RestoreTable'`
-> Text	`$sel:targetTableName:RestoreTable'`
-> RestoreTable

Create a value of RestoreTable 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:capacitySpecificationOverride:RestoreTable', restoreTable_capacitySpecificationOverride - Specifies the read/write throughput capacity mode for the target table. The options are:

• throughputMode:PAY_PER_REQUEST

• throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

$sel:encryptionSpecificationOverride:RestoreTable', restoreTable_encryptionSpecificationOverride - Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

$sel:pointInTimeRecoveryOverride:RestoreTable', restoreTable_pointInTimeRecoveryOverride - Specifies the pointInTimeRecovery settings for the target table. The options are:

• ENABLED

• DISABLED

If it's not specified, the default is DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

$sel:restoreTimestamp:RestoreTable', restoreTable_restoreTimestamp - The restore timestamp in ISO 8601 format.

$sel:tagsOverride:RestoreTable', restoreTable_tagsOverride - A list of key-value pair tags to be attached to the restored table.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

$sel:sourceKeyspaceName:RestoreTable', restoreTable_sourceKeyspaceName - The keyspace name of the source table.

$sel:sourceTableName:RestoreTable', restoreTable_sourceTableName - The name of the source table.

$sel:targetKeyspaceName:RestoreTable', restoreTable_targetKeyspaceName - The name of the target keyspace.

$sel:targetTableName:RestoreTable', restoreTable_targetTableName - The name of the target table.

Request Lenses

restoreTable_capacitySpecificationOverride :: Lens' RestoreTable (Maybe CapacitySpecification) Source #

Specifies the read/write throughput capacity mode for the target table. The options are:

• throughputMode:PAY_PER_REQUEST

• throughputMode:PROVISIONED - Provisioned capacity mode requires readCapacityUnits and writeCapacityUnits as input.

The default is throughput_mode:PAY_PER_REQUEST.

For more information, see Read/write capacity modes in the Amazon Keyspaces Developer Guide.

restoreTable_encryptionSpecificationOverride :: Lens' RestoreTable (Maybe EncryptionSpecification) Source #

Specifies the encryption settings for the target table. You can choose one of the following KMS key (KMS key):

• type:AWS_OWNED_KMS_KEY - This key is owned by Amazon Keyspaces.

• type:CUSTOMER_MANAGED_KMS_KEY - This key is stored in your account and is created, owned, and managed by you. This option requires the kms_key_identifier of the KMS key in Amazon Resource Name (ARN) format as input.

The default is type:AWS_OWNED_KMS_KEY.

For more information, see Encryption at rest in the Amazon Keyspaces Developer Guide.

restoreTable_pointInTimeRecoveryOverride :: Lens' RestoreTable (Maybe PointInTimeRecovery) Source #

Specifies the pointInTimeRecovery settings for the target table. The options are:

• ENABLED

• DISABLED

If it's not specified, the default is DISABLED.

For more information, see Point-in-time recovery in the Amazon Keyspaces Developer Guide.

restoreTable_restoreTimestamp :: Lens' RestoreTable (Maybe UTCTime) Source #

The restore timestamp in ISO 8601 format.

restoreTable_tagsOverride :: Lens' RestoreTable (Maybe (NonEmpty Tag)) Source #

A list of key-value pair tags to be attached to the restored table.

For more information, see Adding tags and labels to Amazon Keyspaces resources in the Amazon Keyspaces Developer Guide.

restoreTable_sourceKeyspaceName :: Lens' RestoreTable Text Source #

The keyspace name of the source table.

restoreTable_sourceTableName :: Lens' RestoreTable Text Source #

The name of the source table.

restoreTable_targetKeyspaceName :: Lens' RestoreTable Text Source #

The name of the target keyspace.

restoreTable_targetTableName :: Lens' RestoreTable Text Source #

The name of the target table.

Destructuring the Response

data RestoreTableResponse Source #

See: newRestoreTableResponse smart constructor.

Constructors

RestoreTableResponse'
Fields httpStatus :: Int The response's http status code. restoredTableARN :: Text The Amazon Resource Name (ARN) of the restored table.

Instances

Instances details

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

newRestoreTableResponse Source #

Arguments

:: Int	`$sel:httpStatus:RestoreTableResponse'`
-> Text	`$sel:restoredTableARN:RestoreTableResponse'`
-> RestoreTableResponse

Create a value of RestoreTableResponse 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:httpStatus:RestoreTableResponse', restoreTableResponse_httpStatus - The response's http status code.

$sel:restoredTableARN:RestoreTableResponse', restoreTableResponse_restoredTableARN - The Amazon Resource Name (ARN) of the restored table.

Response Lenses

restoreTableResponse_httpStatus :: Lens' RestoreTableResponse Int Source #

The response's http status code.

restoreTableResponse_restoredTableARN :: Lens' RestoreTableResponse Text Source #

The Amazon Resource Name (ARN) of the restored table.