Network.AWS.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 may or may not 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

createBackup

Arguments

:: Text

cbTableName

-> Text

cbBackupName

-> CreateBackup

Creates a value of CreateBackup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cbTableName - The name of the table.
• cbBackupName - Specified name for the backup.

data CreateBackup

See: createBackup smart constructor.

Instances

Eq CreateBackup

Methods

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

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

Data CreateBackup

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBackup -> c CreateBackup

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBackup

toConstr :: CreateBackup -> Constr

dataTypeOf :: CreateBackup -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBackup)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBackup)

gmapT :: (forall b. Data b => b -> b) -> CreateBackup -> CreateBackup

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBackup -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBackup -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateBackup -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBackup -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBackup -> m CreateBackup

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBackup -> m CreateBackup

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBackup -> m CreateBackup

Read CreateBackup

Methods

readsPrec :: Int -> ReadS CreateBackup

readList :: ReadS [CreateBackup]

readPrec :: ReadPrec CreateBackup

readListPrec :: ReadPrec [CreateBackup]

Show CreateBackup

Methods

showsPrec :: Int -> CreateBackup -> ShowS

show :: CreateBackup -> String

showList :: [CreateBackup] -> ShowS

Generic CreateBackup

Associated Types

type Rep CreateBackup :: * -> *

Methods

from :: CreateBackup -> Rep CreateBackup x

to :: Rep CreateBackup x -> CreateBackup

Hashable CreateBackup

Methods

hashWithSalt :: Int -> CreateBackup -> Int

hash :: CreateBackup -> Int

ToJSON CreateBackup

Methods

toJSON :: CreateBackup -> Value

toEncoding :: CreateBackup -> Encoding

toJSONList :: [CreateBackup] -> Value

toEncodingList :: [CreateBackup] -> Encoding

NFData CreateBackup

Methods

rnf :: CreateBackup -> ()

AWSRequest CreateBackup

Associated Types

type Rs CreateBackup :: *

Methods

request :: CreateBackup -> Request CreateBackup

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * CreateBackup -> ClientResponse -> m (Response CreateBackup)

ToHeaders CreateBackup

Methods

toHeaders :: CreateBackup -> [Header]

ToPath CreateBackup

Methods

toPath :: CreateBackup -> ByteString

ToQuery CreateBackup

Methods

toQuery :: CreateBackup -> QueryString

type Rep CreateBackup

type Rep CreateBackup = D1 * (MetaData "CreateBackup" "Network.AWS.DynamoDB.CreateBackup" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" False) (C1 * (MetaCons "CreateBackup'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbTableName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_cbBackupName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs CreateBackup

type Rs CreateBackup = CreateBackupResponse

Request Lenses

cbTableName :: Lens' CreateBackup Text

The name of the table.

cbBackupName :: Lens' CreateBackup Text

Specified name for the backup.

Destructuring the Response

createBackupResponse

Arguments

:: Int

cbrsResponseStatus

-> CreateBackupResponse

Creates a value of CreateBackupResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cbrsBackupDetails - Contains the details of the backup created for the table.
• cbrsResponseStatus - -- | The response status code.

data CreateBackupResponse

See: createBackupResponse smart constructor.

Instances

Eq CreateBackupResponse

Methods

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

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

Data CreateBackupResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CreateBackupResponse -> c CreateBackupResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CreateBackupResponse

toConstr :: CreateBackupResponse -> Constr

dataTypeOf :: CreateBackupResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CreateBackupResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CreateBackupResponse)

gmapT :: (forall b. Data b => b -> b) -> CreateBackupResponse -> CreateBackupResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CreateBackupResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CreateBackupResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> CreateBackupResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CreateBackupResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CreateBackupResponse -> m CreateBackupResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBackupResponse -> m CreateBackupResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CreateBackupResponse -> m CreateBackupResponse

Read CreateBackupResponse

Methods

readsPrec :: Int -> ReadS CreateBackupResponse

readList :: ReadS [CreateBackupResponse]

readPrec :: ReadPrec CreateBackupResponse

readListPrec :: ReadPrec [CreateBackupResponse]

Show CreateBackupResponse

Methods

showsPrec :: Int -> CreateBackupResponse -> ShowS

show :: CreateBackupResponse -> String

showList :: [CreateBackupResponse] -> ShowS

Generic CreateBackupResponse

Associated Types

type Rep CreateBackupResponse :: * -> *

Methods

from :: CreateBackupResponse -> Rep CreateBackupResponse x

to :: Rep CreateBackupResponse x -> CreateBackupResponse

NFData CreateBackupResponse

Methods

rnf :: CreateBackupResponse -> ()

type Rep CreateBackupResponse

type Rep CreateBackupResponse = D1 * (MetaData "CreateBackupResponse" "Network.AWS.DynamoDB.CreateBackup" "amazonka-dynamodb-1.6.0-Be8FXVQVyEHEMZza56FG0o" False) (C1 * (MetaCons "CreateBackupResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_cbrsBackupDetails") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe BackupDetails))) (S1 * (MetaSel (Just Symbol "_cbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

cbrsBackupDetails :: Lens' CreateBackupResponse (Maybe BackupDetails)

Contains the details of the backup created for the table.

cbrsResponseStatus :: Lens' CreateBackupResponse Int

• - | The response status code.