Amazonka.DynamoDB.CreateBackup

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

Creating a Request

data CreateBackup

See: newCreateBackup smart constructor.

Constructors

CreateBackup'

Fields

• tableName :: Text

  The name of the table.

• backupName :: Text

  Specified name for the backup.

Instances

ToJSON CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

toJSON :: CreateBackup -> Value

toEncoding :: CreateBackup -> Encoding

toJSONList :: [CreateBackup] -> Value

toEncodingList :: [CreateBackup] -> Encoding

ToHeaders CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

toHeaders :: CreateBackup -> [Header]

ToPath CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

toPath :: CreateBackup -> ByteString

ToQuery CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

toQuery :: CreateBackup -> QueryString

AWSRequest CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Associated Types

type AWSResponse CreateBackup

Methods

request :: (Service -> Service) -> CreateBackup -> Request CreateBackup

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBackup -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBackup)))

Generic CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Associated Types

type Rep CreateBackup :: Type -> Type

Methods

from :: CreateBackup -> Rep CreateBackup x

to :: Rep CreateBackup x -> CreateBackup

Read CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

readsPrec :: Int -> ReadS CreateBackup

readList :: ReadS [CreateBackup]

readPrec :: ReadPrec CreateBackup

readListPrec :: ReadPrec [CreateBackup]

Show CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

showsPrec :: Int -> CreateBackup -> ShowS

show :: CreateBackup -> String

showList :: [CreateBackup] -> ShowS

NFData CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

rnf :: CreateBackup -> ()

Eq CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

(==) :: CreateBackup -> CreateBackup -> Bool

(/=) :: CreateBackup -> CreateBackup -> Bool

Hashable CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

Methods

hashWithSalt :: Int -> CreateBackup -> Int

hash :: CreateBackup -> Int

type AWSResponse CreateBackup

Defined in Amazonka.DynamoDB.CreateBackup

type AWSResponse CreateBackup = CreateBackupResponse

type Rep CreateBackup

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

Arguments

:: Text

CreateBackup

-> Text

CreateBackup

-> CreateBackup

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_tableName :: Lens' CreateBackup Text

The name of the table.

createBackup_backupName :: Lens' CreateBackup Text

Specified name for the backup.

Destructuring the Response

data CreateBackupResponse

See: newCreateBackupResponse smart constructor.

Constructors

CreateBackupResponse'

Fields

• backupDetails :: Maybe BackupDetails

  Contains the details of the backup created for the table.

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateBackupResponse

Defined in Amazonka.DynamoDB.CreateBackup

Associated Types

type Rep CreateBackupResponse :: Type -> Type

Methods

from :: CreateBackupResponse -> Rep CreateBackupResponse x

to :: Rep CreateBackupResponse x -> CreateBackupResponse

Read CreateBackupResponse

Defined in Amazonka.DynamoDB.CreateBackup

Methods

readsPrec :: Int -> ReadS CreateBackupResponse

readList :: ReadS [CreateBackupResponse]

readPrec :: ReadPrec CreateBackupResponse

readListPrec :: ReadPrec [CreateBackupResponse]

Show CreateBackupResponse

Defined in Amazonka.DynamoDB.CreateBackup

Methods

showsPrec :: Int -> CreateBackupResponse -> ShowS

show :: CreateBackupResponse -> String

showList :: [CreateBackupResponse] -> ShowS

NFData CreateBackupResponse

Defined in Amazonka.DynamoDB.CreateBackup

Methods

rnf :: CreateBackupResponse -> ()

Eq CreateBackupResponse

Defined in Amazonka.DynamoDB.CreateBackup

Methods

(==) :: CreateBackupResponse -> CreateBackupResponse -> Bool

(/=) :: CreateBackupResponse -> CreateBackupResponse -> Bool

type Rep CreateBackupResponse

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

Arguments

:: Int

$sel:httpStatus:CreateBackupResponse'

-> CreateBackupResponse

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)

Contains the details of the backup created for the table.

createBackupResponse_httpStatus :: Lens' CreateBackupResponse Int

The response's http status code.