{-# 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.Backup.Types.Framework
-- 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.Backup.Types.Framework where

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

-- | Contains detailed information about a framework. Frameworks contain
-- controls, which evaluate and report on your backup events and resources.
-- Frameworks generate daily compliance results.
--
-- /See:/ 'newFramework' smart constructor.
data Framework = Framework'
  { -- | The date and time that a framework is created, in ISO 8601
    -- representation. The value of @CreationTime@ is accurate to milliseconds.
    -- For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July
    -- 2020 at 3:00 PM 8 hours behind UTC.
    Framework -> Maybe POSIX
creationTime :: Prelude.Maybe Data.POSIX,
    -- | The deployment status of a framework. The statuses are:
    --
    -- @CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED@
    Framework -> Maybe Text
deploymentStatus :: Prelude.Maybe Prelude.Text,
    -- | An Amazon Resource Name (ARN) that uniquely identifies a resource. The
    -- format of the ARN depends on the resource type.
    Framework -> Maybe Text
frameworkArn :: Prelude.Maybe Prelude.Text,
    -- | An optional description of the framework with a maximum 1,024
    -- characters.
    Framework -> Maybe Text
frameworkDescription :: Prelude.Maybe Prelude.Text,
    -- | The unique name of a framework. This name is between 1 and 256
    -- characters, starting with a letter, and consisting of letters (a-z,
    -- A-Z), numbers (0-9), and underscores (_).
    Framework -> Maybe Text
frameworkName :: Prelude.Maybe Prelude.Text,
    -- | The number of controls contained by the framework.
    Framework -> Maybe Int
numberOfControls :: Prelude.Maybe Prelude.Int
  }
  deriving (Framework -> Framework -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: Framework -> Framework -> Bool
$c/= :: Framework -> Framework -> Bool
== :: Framework -> Framework -> Bool
$c== :: Framework -> Framework -> Bool
Prelude.Eq, ReadPrec [Framework]
ReadPrec Framework
Int -> ReadS Framework
ReadS [Framework]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Framework]
$creadListPrec :: ReadPrec [Framework]
readPrec :: ReadPrec Framework
$creadPrec :: ReadPrec Framework
readList :: ReadS [Framework]
$creadList :: ReadS [Framework]
readsPrec :: Int -> ReadS Framework
$creadsPrec :: Int -> ReadS Framework
Prelude.Read, Int -> Framework -> ShowS
[Framework] -> ShowS
Framework -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Framework] -> ShowS
$cshowList :: [Framework] -> ShowS
show :: Framework -> String
$cshow :: Framework -> String
showsPrec :: Int -> Framework -> ShowS
$cshowsPrec :: Int -> Framework -> ShowS
Prelude.Show, forall x. Rep Framework x -> Framework
forall x. Framework -> Rep Framework x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Framework x -> Framework
$cfrom :: forall x. Framework -> Rep Framework x
Prelude.Generic)

-- |
-- Create a value of 'Framework' 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:
--
-- 'creationTime', 'framework_creationTime' - The date and time that a framework is created, in ISO 8601
-- representation. The value of @CreationTime@ is accurate to milliseconds.
-- For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July
-- 2020 at 3:00 PM 8 hours behind UTC.
--
-- 'deploymentStatus', 'framework_deploymentStatus' - The deployment status of a framework. The statuses are:
--
-- @CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED@
--
-- 'frameworkArn', 'framework_frameworkArn' - An Amazon Resource Name (ARN) that uniquely identifies a resource. The
-- format of the ARN depends on the resource type.
--
-- 'frameworkDescription', 'framework_frameworkDescription' - An optional description of the framework with a maximum 1,024
-- characters.
--
-- 'frameworkName', 'framework_frameworkName' - The unique name of a framework. This name is between 1 and 256
-- characters, starting with a letter, and consisting of letters (a-z,
-- A-Z), numbers (0-9), and underscores (_).
--
-- 'numberOfControls', 'framework_numberOfControls' - The number of controls contained by the framework.
newFramework ::
  Framework
newFramework :: Framework
newFramework =
  Framework'
    { $sel:creationTime:Framework' :: Maybe POSIX
creationTime = forall a. Maybe a
Prelude.Nothing,
      $sel:deploymentStatus:Framework' :: Maybe Text
deploymentStatus = forall a. Maybe a
Prelude.Nothing,
      $sel:frameworkArn:Framework' :: Maybe Text
frameworkArn = forall a. Maybe a
Prelude.Nothing,
      $sel:frameworkDescription:Framework' :: Maybe Text
frameworkDescription = forall a. Maybe a
Prelude.Nothing,
      $sel:frameworkName:Framework' :: Maybe Text
frameworkName = forall a. Maybe a
Prelude.Nothing,
      $sel:numberOfControls:Framework' :: Maybe Int
numberOfControls = forall a. Maybe a
Prelude.Nothing
    }

-- | The date and time that a framework is created, in ISO 8601
-- representation. The value of @CreationTime@ is accurate to milliseconds.
-- For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July
-- 2020 at 3:00 PM 8 hours behind UTC.
framework_creationTime :: Lens.Lens' Framework (Prelude.Maybe Prelude.UTCTime)
framework_creationTime :: Lens' Framework (Maybe UTCTime)
framework_creationTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Framework' {Maybe POSIX
creationTime :: Maybe POSIX
$sel:creationTime:Framework' :: Framework -> Maybe POSIX
creationTime} -> Maybe POSIX
creationTime) (\s :: Framework
s@Framework' {} Maybe POSIX
a -> Framework
s {$sel:creationTime:Framework' :: Maybe POSIX
creationTime = Maybe POSIX
a} :: Framework) 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

-- | The deployment status of a framework. The statuses are:
--
-- @CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED@
framework_deploymentStatus :: Lens.Lens' Framework (Prelude.Maybe Prelude.Text)
framework_deploymentStatus :: Lens' Framework (Maybe Text)
framework_deploymentStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Framework' {Maybe Text
deploymentStatus :: Maybe Text
$sel:deploymentStatus:Framework' :: Framework -> Maybe Text
deploymentStatus} -> Maybe Text
deploymentStatus) (\s :: Framework
s@Framework' {} Maybe Text
a -> Framework
s {$sel:deploymentStatus:Framework' :: Maybe Text
deploymentStatus = Maybe Text
a} :: Framework)

-- | An Amazon Resource Name (ARN) that uniquely identifies a resource. The
-- format of the ARN depends on the resource type.
framework_frameworkArn :: Lens.Lens' Framework (Prelude.Maybe Prelude.Text)
framework_frameworkArn :: Lens' Framework (Maybe Text)
framework_frameworkArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Framework' {Maybe Text
frameworkArn :: Maybe Text
$sel:frameworkArn:Framework' :: Framework -> Maybe Text
frameworkArn} -> Maybe Text
frameworkArn) (\s :: Framework
s@Framework' {} Maybe Text
a -> Framework
s {$sel:frameworkArn:Framework' :: Maybe Text
frameworkArn = Maybe Text
a} :: Framework)

-- | An optional description of the framework with a maximum 1,024
-- characters.
framework_frameworkDescription :: Lens.Lens' Framework (Prelude.Maybe Prelude.Text)
framework_frameworkDescription :: Lens' Framework (Maybe Text)
framework_frameworkDescription = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Framework' {Maybe Text
frameworkDescription :: Maybe Text
$sel:frameworkDescription:Framework' :: Framework -> Maybe Text
frameworkDescription} -> Maybe Text
frameworkDescription) (\s :: Framework
s@Framework' {} Maybe Text
a -> Framework
s {$sel:frameworkDescription:Framework' :: Maybe Text
frameworkDescription = Maybe Text
a} :: Framework)

-- | The unique name of a framework. This name is between 1 and 256
-- characters, starting with a letter, and consisting of letters (a-z,
-- A-Z), numbers (0-9), and underscores (_).
framework_frameworkName :: Lens.Lens' Framework (Prelude.Maybe Prelude.Text)
framework_frameworkName :: Lens' Framework (Maybe Text)
framework_frameworkName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Framework' {Maybe Text
frameworkName :: Maybe Text
$sel:frameworkName:Framework' :: Framework -> Maybe Text
frameworkName} -> Maybe Text
frameworkName) (\s :: Framework
s@Framework' {} Maybe Text
a -> Framework
s {$sel:frameworkName:Framework' :: Maybe Text
frameworkName = Maybe Text
a} :: Framework)

-- | The number of controls contained by the framework.
framework_numberOfControls :: Lens.Lens' Framework (Prelude.Maybe Prelude.Int)
framework_numberOfControls :: Lens' Framework (Maybe Int)
framework_numberOfControls = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\Framework' {Maybe Int
numberOfControls :: Maybe Int
$sel:numberOfControls:Framework' :: Framework -> Maybe Int
numberOfControls} -> Maybe Int
numberOfControls) (\s :: Framework
s@Framework' {} Maybe Int
a -> Framework
s {$sel:numberOfControls:Framework' :: Maybe Int
numberOfControls = Maybe Int
a} :: Framework)

instance Data.FromJSON Framework where
  parseJSON :: Value -> Parser Framework
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"Framework"
      ( \Object
x ->
          Maybe POSIX
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Int
-> Framework
Framework'
            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
"CreationTime")
            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
"DeploymentStatus")
            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
"FrameworkArn")
            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
"FrameworkDescription")
            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
"FrameworkName")
            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
"NumberOfControls")
      )

instance Prelude.Hashable Framework where
  hashWithSalt :: Int -> Framework -> Int
hashWithSalt Int
_salt Framework' {Maybe Int
Maybe Text
Maybe POSIX
numberOfControls :: Maybe Int
frameworkName :: Maybe Text
frameworkDescription :: Maybe Text
frameworkArn :: Maybe Text
deploymentStatus :: Maybe Text
creationTime :: Maybe POSIX
$sel:numberOfControls:Framework' :: Framework -> Maybe Int
$sel:frameworkName:Framework' :: Framework -> Maybe Text
$sel:frameworkDescription:Framework' :: Framework -> Maybe Text
$sel:frameworkArn:Framework' :: Framework -> Maybe Text
$sel:deploymentStatus:Framework' :: Framework -> Maybe Text
$sel:creationTime:Framework' :: Framework -> Maybe POSIX
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
creationTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
deploymentStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
frameworkArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
frameworkDescription
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
frameworkName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Int
numberOfControls

instance Prelude.NFData Framework where
  rnf :: Framework -> ()
rnf Framework' {Maybe Int
Maybe Text
Maybe POSIX
numberOfControls :: Maybe Int
frameworkName :: Maybe Text
frameworkDescription :: Maybe Text
frameworkArn :: Maybe Text
deploymentStatus :: Maybe Text
creationTime :: Maybe POSIX
$sel:numberOfControls:Framework' :: Framework -> Maybe Int
$sel:frameworkName:Framework' :: Framework -> Maybe Text
$sel:frameworkDescription:Framework' :: Framework -> Maybe Text
$sel:frameworkArn:Framework' :: Framework -> Maybe Text
$sel:deploymentStatus:Framework' :: Framework -> Maybe Text
$sel:creationTime:Framework' :: Framework -> Maybe POSIX
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
creationTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
deploymentStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
frameworkArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
frameworkDescription
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
frameworkName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Int
numberOfControls