amazonka-dynamodb-2.0: Amazon DynamoDB SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DynamoDB.CreateBackup

Description

Creates a backup for an existing table.

Each time you create an on-demand backup, the entire table data is backed up. There is no limit to the number of on-demand backups that can be taken.

When you create an on-demand backup, a time marker of the request is cataloged, and the backup is created asynchronously, by applying all changes until the time of the request to the last full table snapshot. Backup requests are processed instantaneously and become available for restore within minutes.

You can call CreateBackup at a maximum rate of 50 times per second.

All backups in DynamoDB work without consuming any provisioned throughput on the table.

If you submit a backup request on 2018-12-14 at 14:25:00, the backup is guaranteed to contain all data committed to the table up to 14:24:00, and data committed after 14:26:00 will not be. The backup might contain data modifications made between 14:24:00 and 14:26:00. On-demand backup does not support causal consistency.

Along with data, the following are also included on the backups:

  • Global secondary indexes (GSIs)
  • Local secondary indexes (LSIs)
  • Streams
  • Provisioned read and write capacity
Synopsis

Creating a Request

data CreateBackup Source #

See: newCreateBackup smart constructor.

Constructors

CreateBackup' 

Fields

Instances

Instances details
ToJSON CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

ToHeaders CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

ToPath CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

ToQuery CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

AWSRequest CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Associated Types

type AWSResponse CreateBackup #

Generic CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Associated Types

type Rep CreateBackup :: Type -> Type #

Read CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Show CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

NFData CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Methods

rnf :: CreateBackup -> () #

Eq CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Hashable CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

type AWSResponse CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

type Rep CreateBackup Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

type Rep CreateBackup = D1 ('MetaData "CreateBackup" "Amazonka.DynamoDB.CreateBackup" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "CreateBackup'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tableName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "backupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newCreateBackup Source #

Create a value of CreateBackup 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:

CreateBackup, createBackup_tableName - The name of the table.

CreateBackup, createBackup_backupName - Specified name for the backup.

Request Lenses

createBackup_backupName :: Lens' CreateBackup Text Source #

Specified name for the backup.

Destructuring the Response

data CreateBackupResponse Source #

See: newCreateBackupResponse smart constructor.

Constructors

CreateBackupResponse' 

Fields

Instances

Instances details
Generic CreateBackupResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Associated Types

type Rep CreateBackupResponse :: Type -> Type #

Read CreateBackupResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Show CreateBackupResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

NFData CreateBackupResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

Methods

rnf :: CreateBackupResponse -> () #

Eq CreateBackupResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

type Rep CreateBackupResponse Source # 
Instance details

Defined in Amazonka.DynamoDB.CreateBackup

type Rep CreateBackupResponse = D1 ('MetaData "CreateBackupResponse" "Amazonka.DynamoDB.CreateBackup" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "CreateBackupResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "backupDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupDetails)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateBackupResponse Source #

Create a value of CreateBackupResponse 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:

CreateBackupResponse, createBackupResponse_backupDetails - Contains the details of the backup created for the table.

$sel:httpStatus:CreateBackupResponse', createBackupResponse_httpStatus - The response's http status code.

Response Lenses

createBackupResponse_backupDetails :: Lens' CreateBackupResponse (Maybe BackupDetails) Source #

Contains the details of the backup created for the table.