{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.DynamoDB.Types.BackupDetails
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.DynamoDB.Types.BackupDetails where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.DynamoDB.Types.AttributeValue
import Amazonka.DynamoDB.Types.BackupStatus
import Amazonka.DynamoDB.Types.BackupType
import Amazonka.DynamoDB.Types.WriteRequest
import qualified Amazonka.Prelude as Prelude

-- | Contains the details of the backup created for the table.
--
-- /See:/ 'newBackupDetails' smart constructor.
data BackupDetails = BackupDetails'
  { -- | 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 -> Maybe POSIX
backupExpiryDateTime :: Prelude.Maybe Data.POSIX,
    -- | Size of the backup in bytes. DynamoDB updates this value approximately
    -- every six hours. Recent changes might not be reflected in this value.
    BackupDetails -> Maybe Natural
backupSizeBytes :: Prelude.Maybe Prelude.Natural,
    -- | ARN associated with the backup.
    BackupDetails -> Text
backupArn :: Prelude.Text,
    -- | Name of the requested backup.
    BackupDetails -> Text
backupName :: Prelude.Text,
    -- | Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
    BackupDetails -> BackupStatus
backupStatus :: BackupStatus,
    -- | 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 -> BackupType
backupType :: BackupType,
    -- | Time at which the backup was created. This is the request time of the
    -- backup.
    BackupDetails -> POSIX
backupCreationDateTime :: Data.POSIX
  }
  deriving (BackupDetails -> BackupDetails -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: BackupDetails -> BackupDetails -> Bool
$c/= :: BackupDetails -> BackupDetails -> Bool
== :: BackupDetails -> BackupDetails -> Bool
$c== :: BackupDetails -> BackupDetails -> Bool
Prelude.Eq, ReadPrec [BackupDetails]
ReadPrec BackupDetails
Int -> ReadS BackupDetails
ReadS [BackupDetails]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [BackupDetails]
$creadListPrec :: ReadPrec [BackupDetails]
readPrec :: ReadPrec BackupDetails
$creadPrec :: ReadPrec BackupDetails
readList :: ReadS [BackupDetails]
$creadList :: ReadS [BackupDetails]
readsPrec :: Int -> ReadS BackupDetails
$creadsPrec :: Int -> ReadS BackupDetails
Prelude.Read, Int -> BackupDetails -> ShowS
[BackupDetails] -> ShowS
BackupDetails -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [BackupDetails] -> ShowS
$cshowList :: [BackupDetails] -> ShowS
show :: BackupDetails -> String
$cshow :: BackupDetails -> String
showsPrec :: Int -> BackupDetails -> ShowS
$cshowsPrec :: Int -> BackupDetails -> ShowS
Prelude.Show, forall x. Rep BackupDetails x -> BackupDetails
forall x. BackupDetails -> Rep BackupDetails x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep BackupDetails x -> BackupDetails
$cfrom :: forall x. BackupDetails -> Rep BackupDetails x
Prelude.Generic)

-- |
-- Create a value of 'BackupDetails' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'backupExpiryDateTime', '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.
--
-- 'backupSizeBytes', '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.
--
-- 'backupArn', 'backupDetails_backupArn' - ARN associated with the backup.
--
-- 'backupName', 'backupDetails_backupName' - Name of the requested backup.
--
-- 'backupStatus', 'backupDetails_backupStatus' - Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
--
-- 'backupType', '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.
--
-- 'backupCreationDateTime', 'backupDetails_backupCreationDateTime' - Time at which the backup was created. This is the request time of the
-- backup.
newBackupDetails ::
  -- | 'backupArn'
  Prelude.Text ->
  -- | 'backupName'
  Prelude.Text ->
  -- | 'backupStatus'
  BackupStatus ->
  -- | 'backupType'
  BackupType ->
  -- | 'backupCreationDateTime'
  Prelude.UTCTime ->
  BackupDetails
newBackupDetails :: Text
-> Text -> BackupStatus -> BackupType -> UTCTime -> BackupDetails
newBackupDetails
  Text
pBackupArn_
  Text
pBackupName_
  BackupStatus
pBackupStatus_
  BackupType
pBackupType_
  UTCTime
pBackupCreationDateTime_ =
    BackupDetails'
      { $sel:backupExpiryDateTime:BackupDetails' :: Maybe POSIX
backupExpiryDateTime =
          forall a. Maybe a
Prelude.Nothing,
        $sel:backupSizeBytes:BackupDetails' :: Maybe Natural
backupSizeBytes = forall a. Maybe a
Prelude.Nothing,
        $sel:backupArn:BackupDetails' :: Text
backupArn = Text
pBackupArn_,
        $sel:backupName:BackupDetails' :: Text
backupName = Text
pBackupName_,
        $sel:backupStatus:BackupDetails' :: BackupStatus
backupStatus = BackupStatus
pBackupStatus_,
        $sel:backupType:BackupDetails' :: BackupType
backupType = BackupType
pBackupType_,
        $sel:backupCreationDateTime:BackupDetails' :: POSIX
backupCreationDateTime =
          forall (a :: Format). Iso' (Time a) UTCTime
Data._Time forall t b. AReview t b -> b -> t
Lens.# UTCTime
pBackupCreationDateTime_
      }

-- | 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_backupExpiryDateTime :: Lens.Lens' BackupDetails (Prelude.Maybe Prelude.UTCTime)
backupDetails_backupExpiryDateTime :: Lens' BackupDetails (Maybe UTCTime)
backupDetails_backupExpiryDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {Maybe POSIX
backupExpiryDateTime :: Maybe POSIX
$sel:backupExpiryDateTime:BackupDetails' :: BackupDetails -> Maybe POSIX
backupExpiryDateTime} -> Maybe POSIX
backupExpiryDateTime) (\s :: BackupDetails
s@BackupDetails' {} Maybe POSIX
a -> BackupDetails
s {$sel:backupExpiryDateTime:BackupDetails' :: Maybe POSIX
backupExpiryDateTime = Maybe POSIX
a} :: BackupDetails) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

-- | Size of the backup in bytes. DynamoDB updates this value approximately
-- every six hours. Recent changes might not be reflected in this value.
backupDetails_backupSizeBytes :: Lens.Lens' BackupDetails (Prelude.Maybe Prelude.Natural)
backupDetails_backupSizeBytes :: Lens' BackupDetails (Maybe Natural)
backupDetails_backupSizeBytes = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {Maybe Natural
backupSizeBytes :: Maybe Natural
$sel:backupSizeBytes:BackupDetails' :: BackupDetails -> Maybe Natural
backupSizeBytes} -> Maybe Natural
backupSizeBytes) (\s :: BackupDetails
s@BackupDetails' {} Maybe Natural
a -> BackupDetails
s {$sel:backupSizeBytes:BackupDetails' :: Maybe Natural
backupSizeBytes = Maybe Natural
a} :: BackupDetails)

-- | ARN associated with the backup.
backupDetails_backupArn :: Lens.Lens' BackupDetails Prelude.Text
backupDetails_backupArn :: Lens' BackupDetails Text
backupDetails_backupArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {Text
backupArn :: Text
$sel:backupArn:BackupDetails' :: BackupDetails -> Text
backupArn} -> Text
backupArn) (\s :: BackupDetails
s@BackupDetails' {} Text
a -> BackupDetails
s {$sel:backupArn:BackupDetails' :: Text
backupArn = Text
a} :: BackupDetails)

-- | Name of the requested backup.
backupDetails_backupName :: Lens.Lens' BackupDetails Prelude.Text
backupDetails_backupName :: Lens' BackupDetails Text
backupDetails_backupName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {Text
backupName :: Text
$sel:backupName:BackupDetails' :: BackupDetails -> Text
backupName} -> Text
backupName) (\s :: BackupDetails
s@BackupDetails' {} Text
a -> BackupDetails
s {$sel:backupName:BackupDetails' :: Text
backupName = Text
a} :: BackupDetails)

-- | Backup can be in one of the following states: CREATING, ACTIVE, DELETED.
backupDetails_backupStatus :: Lens.Lens' BackupDetails BackupStatus
backupDetails_backupStatus :: Lens' BackupDetails BackupStatus
backupDetails_backupStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {BackupStatus
backupStatus :: BackupStatus
$sel:backupStatus:BackupDetails' :: BackupDetails -> BackupStatus
backupStatus} -> BackupStatus
backupStatus) (\s :: BackupDetails
s@BackupDetails' {} BackupStatus
a -> BackupDetails
s {$sel:backupStatus:BackupDetails' :: BackupStatus
backupStatus = BackupStatus
a} :: BackupDetails)

-- | 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_backupType :: Lens.Lens' BackupDetails BackupType
backupDetails_backupType :: Lens' BackupDetails BackupType
backupDetails_backupType = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {BackupType
backupType :: BackupType
$sel:backupType:BackupDetails' :: BackupDetails -> BackupType
backupType} -> BackupType
backupType) (\s :: BackupDetails
s@BackupDetails' {} BackupType
a -> BackupDetails
s {$sel:backupType:BackupDetails' :: BackupType
backupType = BackupType
a} :: BackupDetails)

-- | Time at which the backup was created. This is the request time of the
-- backup.
backupDetails_backupCreationDateTime :: Lens.Lens' BackupDetails Prelude.UTCTime
backupDetails_backupCreationDateTime :: Lens' BackupDetails UTCTime
backupDetails_backupCreationDateTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\BackupDetails' {POSIX
backupCreationDateTime :: POSIX
$sel:backupCreationDateTime:BackupDetails' :: BackupDetails -> POSIX
backupCreationDateTime} -> POSIX
backupCreationDateTime) (\s :: BackupDetails
s@BackupDetails' {} POSIX
a -> BackupDetails
s {$sel:backupCreationDateTime:BackupDetails' :: POSIX
backupCreationDateTime = POSIX
a} :: BackupDetails) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (a :: Format). Iso' (Time a) UTCTime
Data._Time

instance Data.FromJSON BackupDetails where
  parseJSON :: Value -> Parser BackupDetails
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"BackupDetails"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Natural
-> Text
-> Text
-> BackupStatus
-> BackupType
-> POSIX
-> BackupDetails
BackupDetails'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BackupExpiryDateTime")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"BackupSizeBytes")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"BackupArn")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"BackupName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"BackupStatus")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"BackupType")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser a
Data..: Key
"BackupCreationDateTime")
      )

instance Prelude.Hashable BackupDetails where
  hashWithSalt :: Int -> BackupDetails -> Int
hashWithSalt Int
_salt BackupDetails' {Maybe Natural
Maybe POSIX
Text
POSIX
BackupType
BackupStatus
backupCreationDateTime :: POSIX
backupType :: BackupType
backupStatus :: BackupStatus
backupName :: Text
backupArn :: Text
backupSizeBytes :: Maybe Natural
backupExpiryDateTime :: Maybe POSIX
$sel:backupCreationDateTime:BackupDetails' :: BackupDetails -> POSIX
$sel:backupType:BackupDetails' :: BackupDetails -> BackupType
$sel:backupStatus:BackupDetails' :: BackupDetails -> BackupStatus
$sel:backupName:BackupDetails' :: BackupDetails -> Text
$sel:backupArn:BackupDetails' :: BackupDetails -> Text
$sel:backupSizeBytes:BackupDetails' :: BackupDetails -> Maybe Natural
$sel:backupExpiryDateTime:BackupDetails' :: BackupDetails -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
backupExpiryDateTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
backupSizeBytes
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
backupArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
backupName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` BackupStatus
backupStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` BackupType
backupType
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` POSIX
backupCreationDateTime

instance Prelude.NFData BackupDetails where
  rnf :: BackupDetails -> ()
rnf BackupDetails' {Maybe Natural
Maybe POSIX
Text
POSIX
BackupType
BackupStatus
backupCreationDateTime :: POSIX
backupType :: BackupType
backupStatus :: BackupStatus
backupName :: Text
backupArn :: Text
backupSizeBytes :: Maybe Natural
backupExpiryDateTime :: Maybe POSIX
$sel:backupCreationDateTime:BackupDetails' :: BackupDetails -> POSIX
$sel:backupType:BackupDetails' :: BackupDetails -> BackupType
$sel:backupStatus:BackupDetails' :: BackupDetails -> BackupStatus
$sel:backupName:BackupDetails' :: BackupDetails -> Text
$sel:backupArn:BackupDetails' :: BackupDetails -> Text
$sel:backupSizeBytes:BackupDetails' :: BackupDetails -> Maybe Natural
$sel:backupExpiryDateTime:BackupDetails' :: BackupDetails -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
backupExpiryDateTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
backupSizeBytes
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
backupArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
backupName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf BackupStatus
backupStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf BackupType
backupType
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf POSIX
backupCreationDateTime