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.Types.BackupDetails

Description

 
Synopsis

Documentation

data BackupDetails Source #

Contains the details of the backup created for the table.

See: newBackupDetails smart constructor.

Constructors

BackupDetails' 

Fields

  • backupExpiryDateTime :: Maybe POSIX

    Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

  • backupSizeBytes :: Maybe Natural

    Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

  • backupArn :: Text

    ARN associated with the backup.

  • backupName :: Text

    Name of the requested backup.

  • backupStatus :: BackupStatus

    Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

  • backupType :: BackupType

    BackupType:

    • USER - You create and manage these using the on-demand backup feature.
    • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
    • AWS_BACKUP - On-demand backup created by you from Backup service.
  • backupCreationDateTime :: POSIX

    Time at which the backup was created. This is the request time of the backup.

Instances

Instances details
FromJSON BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

Generic BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

Associated Types

type Rep BackupDetails :: Type -> Type #

Read BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

Show BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

NFData BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

Methods

rnf :: BackupDetails -> () #

Eq BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

Hashable BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

type Rep BackupDetails Source # 
Instance details

Defined in Amazonka.DynamoDB.Types.BackupDetails

type Rep BackupDetails = D1 ('MetaData "BackupDetails" "Amazonka.DynamoDB.Types.BackupDetails" "amazonka-dynamodb-2.0-GNxlseyeFiu302JKQwQrUS" 'False) (C1 ('MetaCons "BackupDetails'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupExpiryDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "backupSizeBytes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "backupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :*: ((S1 ('MetaSel ('Just "backupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "backupStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackupStatus)) :*: (S1 ('MetaSel ('Just "backupType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackupType) :*: S1 ('MetaSel ('Just "backupCreationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newBackupDetails Source #

Create a value of BackupDetails 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:backupExpiryDateTime:BackupDetails', backupDetails_backupExpiryDateTime - Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

$sel:backupSizeBytes:BackupDetails', backupDetails_backupSizeBytes - Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

$sel:backupArn:BackupDetails', backupDetails_backupArn - ARN associated with the backup.

$sel:backupName:BackupDetails', backupDetails_backupName - Name of the requested backup.

$sel:backupStatus:BackupDetails', backupDetails_backupStatus - Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

$sel:backupType:BackupDetails', backupDetails_backupType - BackupType:

  • USER - You create and manage these using the on-demand backup feature.
  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
  • AWS_BACKUP - On-demand backup created by you from Backup service.

$sel:backupCreationDateTime:BackupDetails', backupDetails_backupCreationDateTime - Time at which the backup was created. This is the request time of the backup.

backupDetails_backupExpiryDateTime :: Lens' BackupDetails (Maybe UTCTime) Source #

Time at which the automatic on-demand backup created by DynamoDB will expire. This SYSTEM on-demand backup expires automatically 35 days after its creation.

backupDetails_backupSizeBytes :: Lens' BackupDetails (Maybe Natural) Source #

Size of the backup in bytes. DynamoDB updates this value approximately every six hours. Recent changes might not be reflected in this value.

backupDetails_backupArn :: Lens' BackupDetails Text Source #

ARN associated with the backup.

backupDetails_backupName :: Lens' BackupDetails Text Source #

Name of the requested backup.

backupDetails_backupStatus :: Lens' BackupDetails BackupStatus Source #

Backup can be in one of the following states: CREATING, ACTIVE, DELETED.

backupDetails_backupType :: Lens' BackupDetails BackupType Source #

BackupType:

  • USER - You create and manage these using the on-demand backup feature.
  • SYSTEM - If you delete a table with point-in-time recovery enabled, a SYSTEM backup is automatically created and is retained for 35 days (at no additional cost). System backups allow you to restore the deleted table to the state it was in just before the point of deletion.
  • AWS_BACKUP - On-demand backup created by you from Backup service.

backupDetails_backupCreationDateTime :: Lens' BackupDetails UTCTime Source #

Time at which the backup was created. This is the request time of the backup.