{-# 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.AuditManager.Types.EvidenceFinderEnablement
-- 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.AuditManager.Types.EvidenceFinderEnablement where

import Amazonka.AuditManager.Types.EvidenceFinderBackfillStatus
import Amazonka.AuditManager.Types.EvidenceFinderEnablementStatus
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | The settings object that specifies whether evidence finder is enabled.
-- This object also describes the related event data store, and the
-- backfill status for populating the event data store with evidence data.
--
-- /See:/ 'newEvidenceFinderEnablement' smart constructor.
data EvidenceFinderEnablement = EvidenceFinderEnablement'
  { -- | The current status of the evidence data backfill process.
    --
    -- The backfill starts after you enable evidence finder. During this task,
    -- Audit Manager populates an event data store with your past two years’
    -- worth of evidence data so that your evidence can be queried.
    --
    -- -   @NOT_STARTED@ means that the backfill hasn’t started yet.
    --
    -- -   @IN_PROGRESS@ means that the backfill is in progress. This can take
    --     up to 7 days to complete, depending on the amount of evidence data.
    --
    -- -   @COMPLETED@ means that the backfill is complete. All of your past
    --     evidence is now queryable.
    EvidenceFinderEnablement -> Maybe EvidenceFinderBackfillStatus
backfillStatus :: Prelude.Maybe EvidenceFinderBackfillStatus,
    -- | The current status of the evidence finder feature and the related event
    -- data store.
    --
    -- -   @ENABLE_IN_PROGRESS@ means that you requested to enable evidence
    --     finder. An event data store is currently being created to support
    --     evidence finder queries.
    --
    -- -   @ENABLED@ means that an event data store was successfully created
    --     and evidence finder is enabled. We recommend that you wait 7 days
    --     until the event data store is backfilled with your past two years’
    --     worth of evidence data. You can use evidence finder in the meantime,
    --     but not all data might be available until the backfill is complete.
    --
    -- -   @DISABLE_IN_PROGRESS@ means that you requested to disable evidence
    --     finder, and your request is pending the deletion of the event data
    --     store.
    --
    -- -   @DISABLED@ means that you have permanently disabled evidence finder
    --     and the event data store has been deleted. You can\'t re-enable
    --     evidence finder after this point.
    EvidenceFinderEnablement -> Maybe EvidenceFinderEnablementStatus
enablementStatus :: Prelude.Maybe EvidenceFinderEnablementStatus,
    -- | Represents any errors that occurred when enabling or disabling evidence
    -- finder.
    EvidenceFinderEnablement -> Maybe Text
error :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) of the CloudTrail Lake event data store
    -- that’s used by evidence finder. The event data store is the lake of
    -- evidence data that evidence finder runs queries against.
    EvidenceFinderEnablement -> Maybe Text
eventDataStoreArn :: Prelude.Maybe Prelude.Text
  }
  deriving (EvidenceFinderEnablement -> EvidenceFinderEnablement -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: EvidenceFinderEnablement -> EvidenceFinderEnablement -> Bool
$c/= :: EvidenceFinderEnablement -> EvidenceFinderEnablement -> Bool
== :: EvidenceFinderEnablement -> EvidenceFinderEnablement -> Bool
$c== :: EvidenceFinderEnablement -> EvidenceFinderEnablement -> Bool
Prelude.Eq, ReadPrec [EvidenceFinderEnablement]
ReadPrec EvidenceFinderEnablement
Int -> ReadS EvidenceFinderEnablement
ReadS [EvidenceFinderEnablement]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [EvidenceFinderEnablement]
$creadListPrec :: ReadPrec [EvidenceFinderEnablement]
readPrec :: ReadPrec EvidenceFinderEnablement
$creadPrec :: ReadPrec EvidenceFinderEnablement
readList :: ReadS [EvidenceFinderEnablement]
$creadList :: ReadS [EvidenceFinderEnablement]
readsPrec :: Int -> ReadS EvidenceFinderEnablement
$creadsPrec :: Int -> ReadS EvidenceFinderEnablement
Prelude.Read, Int -> EvidenceFinderEnablement -> ShowS
[EvidenceFinderEnablement] -> ShowS
EvidenceFinderEnablement -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [EvidenceFinderEnablement] -> ShowS
$cshowList :: [EvidenceFinderEnablement] -> ShowS
show :: EvidenceFinderEnablement -> String
$cshow :: EvidenceFinderEnablement -> String
showsPrec :: Int -> EvidenceFinderEnablement -> ShowS
$cshowsPrec :: Int -> EvidenceFinderEnablement -> ShowS
Prelude.Show, forall x.
Rep EvidenceFinderEnablement x -> EvidenceFinderEnablement
forall x.
EvidenceFinderEnablement -> Rep EvidenceFinderEnablement x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep EvidenceFinderEnablement x -> EvidenceFinderEnablement
$cfrom :: forall x.
EvidenceFinderEnablement -> Rep EvidenceFinderEnablement x
Prelude.Generic)

-- |
-- Create a value of 'EvidenceFinderEnablement' 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:
--
-- 'backfillStatus', 'evidenceFinderEnablement_backfillStatus' - The current status of the evidence data backfill process.
--
-- The backfill starts after you enable evidence finder. During this task,
-- Audit Manager populates an event data store with your past two years’
-- worth of evidence data so that your evidence can be queried.
--
-- -   @NOT_STARTED@ means that the backfill hasn’t started yet.
--
-- -   @IN_PROGRESS@ means that the backfill is in progress. This can take
--     up to 7 days to complete, depending on the amount of evidence data.
--
-- -   @COMPLETED@ means that the backfill is complete. All of your past
--     evidence is now queryable.
--
-- 'enablementStatus', 'evidenceFinderEnablement_enablementStatus' - The current status of the evidence finder feature and the related event
-- data store.
--
-- -   @ENABLE_IN_PROGRESS@ means that you requested to enable evidence
--     finder. An event data store is currently being created to support
--     evidence finder queries.
--
-- -   @ENABLED@ means that an event data store was successfully created
--     and evidence finder is enabled. We recommend that you wait 7 days
--     until the event data store is backfilled with your past two years’
--     worth of evidence data. You can use evidence finder in the meantime,
--     but not all data might be available until the backfill is complete.
--
-- -   @DISABLE_IN_PROGRESS@ means that you requested to disable evidence
--     finder, and your request is pending the deletion of the event data
--     store.
--
-- -   @DISABLED@ means that you have permanently disabled evidence finder
--     and the event data store has been deleted. You can\'t re-enable
--     evidence finder after this point.
--
-- 'error', 'evidenceFinderEnablement_error' - Represents any errors that occurred when enabling or disabling evidence
-- finder.
--
-- 'eventDataStoreArn', 'evidenceFinderEnablement_eventDataStoreArn' - The Amazon Resource Name (ARN) of the CloudTrail Lake event data store
-- that’s used by evidence finder. The event data store is the lake of
-- evidence data that evidence finder runs queries against.
newEvidenceFinderEnablement ::
  EvidenceFinderEnablement
newEvidenceFinderEnablement :: EvidenceFinderEnablement
newEvidenceFinderEnablement =
  EvidenceFinderEnablement'
    { $sel:backfillStatus:EvidenceFinderEnablement' :: Maybe EvidenceFinderBackfillStatus
backfillStatus =
        forall a. Maybe a
Prelude.Nothing,
      $sel:enablementStatus:EvidenceFinderEnablement' :: Maybe EvidenceFinderEnablementStatus
enablementStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:error:EvidenceFinderEnablement' :: Maybe Text
error = forall a. Maybe a
Prelude.Nothing,
      $sel:eventDataStoreArn:EvidenceFinderEnablement' :: Maybe Text
eventDataStoreArn = forall a. Maybe a
Prelude.Nothing
    }

-- | The current status of the evidence data backfill process.
--
-- The backfill starts after you enable evidence finder. During this task,
-- Audit Manager populates an event data store with your past two years’
-- worth of evidence data so that your evidence can be queried.
--
-- -   @NOT_STARTED@ means that the backfill hasn’t started yet.
--
-- -   @IN_PROGRESS@ means that the backfill is in progress. This can take
--     up to 7 days to complete, depending on the amount of evidence data.
--
-- -   @COMPLETED@ means that the backfill is complete. All of your past
--     evidence is now queryable.
evidenceFinderEnablement_backfillStatus :: Lens.Lens' EvidenceFinderEnablement (Prelude.Maybe EvidenceFinderBackfillStatus)
evidenceFinderEnablement_backfillStatus :: Lens' EvidenceFinderEnablement (Maybe EvidenceFinderBackfillStatus)
evidenceFinderEnablement_backfillStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvidenceFinderEnablement' {Maybe EvidenceFinderBackfillStatus
backfillStatus :: Maybe EvidenceFinderBackfillStatus
$sel:backfillStatus:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe EvidenceFinderBackfillStatus
backfillStatus} -> Maybe EvidenceFinderBackfillStatus
backfillStatus) (\s :: EvidenceFinderEnablement
s@EvidenceFinderEnablement' {} Maybe EvidenceFinderBackfillStatus
a -> EvidenceFinderEnablement
s {$sel:backfillStatus:EvidenceFinderEnablement' :: Maybe EvidenceFinderBackfillStatus
backfillStatus = Maybe EvidenceFinderBackfillStatus
a} :: EvidenceFinderEnablement)

-- | The current status of the evidence finder feature and the related event
-- data store.
--
-- -   @ENABLE_IN_PROGRESS@ means that you requested to enable evidence
--     finder. An event data store is currently being created to support
--     evidence finder queries.
--
-- -   @ENABLED@ means that an event data store was successfully created
--     and evidence finder is enabled. We recommend that you wait 7 days
--     until the event data store is backfilled with your past two years’
--     worth of evidence data. You can use evidence finder in the meantime,
--     but not all data might be available until the backfill is complete.
--
-- -   @DISABLE_IN_PROGRESS@ means that you requested to disable evidence
--     finder, and your request is pending the deletion of the event data
--     store.
--
-- -   @DISABLED@ means that you have permanently disabled evidence finder
--     and the event data store has been deleted. You can\'t re-enable
--     evidence finder after this point.
evidenceFinderEnablement_enablementStatus :: Lens.Lens' EvidenceFinderEnablement (Prelude.Maybe EvidenceFinderEnablementStatus)
evidenceFinderEnablement_enablementStatus :: Lens'
  EvidenceFinderEnablement (Maybe EvidenceFinderEnablementStatus)
evidenceFinderEnablement_enablementStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvidenceFinderEnablement' {Maybe EvidenceFinderEnablementStatus
enablementStatus :: Maybe EvidenceFinderEnablementStatus
$sel:enablementStatus:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe EvidenceFinderEnablementStatus
enablementStatus} -> Maybe EvidenceFinderEnablementStatus
enablementStatus) (\s :: EvidenceFinderEnablement
s@EvidenceFinderEnablement' {} Maybe EvidenceFinderEnablementStatus
a -> EvidenceFinderEnablement
s {$sel:enablementStatus:EvidenceFinderEnablement' :: Maybe EvidenceFinderEnablementStatus
enablementStatus = Maybe EvidenceFinderEnablementStatus
a} :: EvidenceFinderEnablement)

-- | Represents any errors that occurred when enabling or disabling evidence
-- finder.
evidenceFinderEnablement_error :: Lens.Lens' EvidenceFinderEnablement (Prelude.Maybe Prelude.Text)
evidenceFinderEnablement_error :: Lens' EvidenceFinderEnablement (Maybe Text)
evidenceFinderEnablement_error = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvidenceFinderEnablement' {Maybe Text
error :: Maybe Text
$sel:error:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe Text
error} -> Maybe Text
error) (\s :: EvidenceFinderEnablement
s@EvidenceFinderEnablement' {} Maybe Text
a -> EvidenceFinderEnablement
s {$sel:error:EvidenceFinderEnablement' :: Maybe Text
error = Maybe Text
a} :: EvidenceFinderEnablement)

-- | The Amazon Resource Name (ARN) of the CloudTrail Lake event data store
-- that’s used by evidence finder. The event data store is the lake of
-- evidence data that evidence finder runs queries against.
evidenceFinderEnablement_eventDataStoreArn :: Lens.Lens' EvidenceFinderEnablement (Prelude.Maybe Prelude.Text)
evidenceFinderEnablement_eventDataStoreArn :: Lens' EvidenceFinderEnablement (Maybe Text)
evidenceFinderEnablement_eventDataStoreArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\EvidenceFinderEnablement' {Maybe Text
eventDataStoreArn :: Maybe Text
$sel:eventDataStoreArn:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe Text
eventDataStoreArn} -> Maybe Text
eventDataStoreArn) (\s :: EvidenceFinderEnablement
s@EvidenceFinderEnablement' {} Maybe Text
a -> EvidenceFinderEnablement
s {$sel:eventDataStoreArn:EvidenceFinderEnablement' :: Maybe Text
eventDataStoreArn = Maybe Text
a} :: EvidenceFinderEnablement)

instance Data.FromJSON EvidenceFinderEnablement where
  parseJSON :: Value -> Parser EvidenceFinderEnablement
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"EvidenceFinderEnablement"
      ( \Object
x ->
          Maybe EvidenceFinderBackfillStatus
-> Maybe EvidenceFinderEnablementStatus
-> Maybe Text
-> Maybe Text
-> EvidenceFinderEnablement
EvidenceFinderEnablement'
            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
"backfillStatus")
            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
"enablementStatus")
            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
"error")
            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
"eventDataStoreArn")
      )

instance Prelude.Hashable EvidenceFinderEnablement where
  hashWithSalt :: Int -> EvidenceFinderEnablement -> Int
hashWithSalt Int
_salt EvidenceFinderEnablement' {Maybe Text
Maybe EvidenceFinderBackfillStatus
Maybe EvidenceFinderEnablementStatus
eventDataStoreArn :: Maybe Text
error :: Maybe Text
enablementStatus :: Maybe EvidenceFinderEnablementStatus
backfillStatus :: Maybe EvidenceFinderBackfillStatus
$sel:eventDataStoreArn:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe Text
$sel:error:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe Text
$sel:enablementStatus:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe EvidenceFinderEnablementStatus
$sel:backfillStatus:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe EvidenceFinderBackfillStatus
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EvidenceFinderBackfillStatus
backfillStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe EvidenceFinderEnablementStatus
enablementStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
error
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
eventDataStoreArn

instance Prelude.NFData EvidenceFinderEnablement where
  rnf :: EvidenceFinderEnablement -> ()
rnf EvidenceFinderEnablement' {Maybe Text
Maybe EvidenceFinderBackfillStatus
Maybe EvidenceFinderEnablementStatus
eventDataStoreArn :: Maybe Text
error :: Maybe Text
enablementStatus :: Maybe EvidenceFinderEnablementStatus
backfillStatus :: Maybe EvidenceFinderBackfillStatus
$sel:eventDataStoreArn:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe Text
$sel:error:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe Text
$sel:enablementStatus:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe EvidenceFinderEnablementStatus
$sel:backfillStatus:EvidenceFinderEnablement' :: EvidenceFinderEnablement -> Maybe EvidenceFinderBackfillStatus
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe EvidenceFinderBackfillStatus
backfillStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe EvidenceFinderEnablementStatus
enablementStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
error
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
eventDataStoreArn