{-# 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.PinpointEmail.Types.DkimAttributes
-- Copyright   : (c) 2013-2021 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay <brendan.g.hay+amazonka@gmail.com>
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.PinpointEmail.Types.DkimAttributes where

import qualified Amazonka.Core as Core
import qualified Amazonka.Lens as Lens
import Amazonka.PinpointEmail.Types.DkimStatus
import qualified Amazonka.Prelude as Prelude

-- | An object that contains information about the DKIM configuration for an
-- email identity.
--
-- /See:/ 'newDkimAttributes' smart constructor.
data DkimAttributes = DkimAttributes'
  { -- | Describes whether or not Amazon Pinpoint has successfully located the
    -- DKIM records in the DNS records for the domain. The status can be one of
    -- the following:
    --
    -- -   @PENDING@ – Amazon Pinpoint hasn\'t yet located the DKIM records in
    --     the DNS configuration for the domain, but will continue to attempt
    --     to locate them.
    --
    -- -   @SUCCESS@ – Amazon Pinpoint located the DKIM records in the DNS
    --     configuration for the domain and determined that they\'re correct.
    --     Amazon Pinpoint can now send DKIM-signed email from the identity.
    --
    -- -   @FAILED@ – Amazon Pinpoint was unable to locate the DKIM records in
    --     the DNS settings for the domain, and won\'t continue to search for
    --     them.
    --
    -- -   @TEMPORARY_FAILURE@ – A temporary issue occurred, which prevented
    --     Amazon Pinpoint from determining the DKIM status for the domain.
    --
    -- -   @NOT_STARTED@ – Amazon Pinpoint hasn\'t yet started searching for
    --     the DKIM records in the DKIM records for the domain.
    DkimAttributes -> Maybe DkimStatus
status :: Prelude.Maybe DkimStatus,
    -- | A set of unique strings that you use to create a set of CNAME records
    -- that you add to the DNS configuration for your domain. When Amazon
    -- Pinpoint detects these records in the DNS configuration for your domain,
    -- the DKIM authentication process is complete. Amazon Pinpoint usually
    -- detects these records within about 72 hours of adding them to the DNS
    -- configuration for your domain.
    DkimAttributes -> Maybe [Text]
tokens :: Prelude.Maybe [Prelude.Text],
    -- | If the value is @true@, then the messages that Amazon Pinpoint sends
    -- from the identity are DKIM-signed. If the value is @false@, then the
    -- messages that Amazon Pinpoint sends from the identity aren\'t
    -- DKIM-signed.
    DkimAttributes -> Maybe Bool
signingEnabled :: Prelude.Maybe Prelude.Bool
  }
  deriving (DkimAttributes -> DkimAttributes -> Bool
(DkimAttributes -> DkimAttributes -> Bool)
-> (DkimAttributes -> DkimAttributes -> Bool) -> Eq DkimAttributes
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DkimAttributes -> DkimAttributes -> Bool
$c/= :: DkimAttributes -> DkimAttributes -> Bool
== :: DkimAttributes -> DkimAttributes -> Bool
$c== :: DkimAttributes -> DkimAttributes -> Bool
Prelude.Eq, ReadPrec [DkimAttributes]
ReadPrec DkimAttributes
Int -> ReadS DkimAttributes
ReadS [DkimAttributes]
(Int -> ReadS DkimAttributes)
-> ReadS [DkimAttributes]
-> ReadPrec DkimAttributes
-> ReadPrec [DkimAttributes]
-> Read DkimAttributes
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DkimAttributes]
$creadListPrec :: ReadPrec [DkimAttributes]
readPrec :: ReadPrec DkimAttributes
$creadPrec :: ReadPrec DkimAttributes
readList :: ReadS [DkimAttributes]
$creadList :: ReadS [DkimAttributes]
readsPrec :: Int -> ReadS DkimAttributes
$creadsPrec :: Int -> ReadS DkimAttributes
Prelude.Read, Int -> DkimAttributes -> ShowS
[DkimAttributes] -> ShowS
DkimAttributes -> String
(Int -> DkimAttributes -> ShowS)
-> (DkimAttributes -> String)
-> ([DkimAttributes] -> ShowS)
-> Show DkimAttributes
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DkimAttributes] -> ShowS
$cshowList :: [DkimAttributes] -> ShowS
show :: DkimAttributes -> String
$cshow :: DkimAttributes -> String
showsPrec :: Int -> DkimAttributes -> ShowS
$cshowsPrec :: Int -> DkimAttributes -> ShowS
Prelude.Show, (forall x. DkimAttributes -> Rep DkimAttributes x)
-> (forall x. Rep DkimAttributes x -> DkimAttributes)
-> Generic DkimAttributes
forall x. Rep DkimAttributes x -> DkimAttributes
forall x. DkimAttributes -> Rep DkimAttributes x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DkimAttributes x -> DkimAttributes
$cfrom :: forall x. DkimAttributes -> Rep DkimAttributes x
Prelude.Generic)

-- |
-- Create a value of 'DkimAttributes' 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:
--
-- 'status', 'dkimAttributes_status' - Describes whether or not Amazon Pinpoint has successfully located the
-- DKIM records in the DNS records for the domain. The status can be one of
-- the following:
--
-- -   @PENDING@ – Amazon Pinpoint hasn\'t yet located the DKIM records in
--     the DNS configuration for the domain, but will continue to attempt
--     to locate them.
--
-- -   @SUCCESS@ – Amazon Pinpoint located the DKIM records in the DNS
--     configuration for the domain and determined that they\'re correct.
--     Amazon Pinpoint can now send DKIM-signed email from the identity.
--
-- -   @FAILED@ – Amazon Pinpoint was unable to locate the DKIM records in
--     the DNS settings for the domain, and won\'t continue to search for
--     them.
--
-- -   @TEMPORARY_FAILURE@ – A temporary issue occurred, which prevented
--     Amazon Pinpoint from determining the DKIM status for the domain.
--
-- -   @NOT_STARTED@ – Amazon Pinpoint hasn\'t yet started searching for
--     the DKIM records in the DKIM records for the domain.
--
-- 'tokens', 'dkimAttributes_tokens' - A set of unique strings that you use to create a set of CNAME records
-- that you add to the DNS configuration for your domain. When Amazon
-- Pinpoint detects these records in the DNS configuration for your domain,
-- the DKIM authentication process is complete. Amazon Pinpoint usually
-- detects these records within about 72 hours of adding them to the DNS
-- configuration for your domain.
--
-- 'signingEnabled', 'dkimAttributes_signingEnabled' - If the value is @true@, then the messages that Amazon Pinpoint sends
-- from the identity are DKIM-signed. If the value is @false@, then the
-- messages that Amazon Pinpoint sends from the identity aren\'t
-- DKIM-signed.
newDkimAttributes ::
  DkimAttributes
newDkimAttributes :: DkimAttributes
newDkimAttributes =
  DkimAttributes' :: Maybe DkimStatus -> Maybe [Text] -> Maybe Bool -> DkimAttributes
DkimAttributes'
    { $sel:status:DkimAttributes' :: Maybe DkimStatus
status = Maybe DkimStatus
forall a. Maybe a
Prelude.Nothing,
      $sel:tokens:DkimAttributes' :: Maybe [Text]
tokens = Maybe [Text]
forall a. Maybe a
Prelude.Nothing,
      $sel:signingEnabled:DkimAttributes' :: Maybe Bool
signingEnabled = Maybe Bool
forall a. Maybe a
Prelude.Nothing
    }

-- | Describes whether or not Amazon Pinpoint has successfully located the
-- DKIM records in the DNS records for the domain. The status can be one of
-- the following:
--
-- -   @PENDING@ – Amazon Pinpoint hasn\'t yet located the DKIM records in
--     the DNS configuration for the domain, but will continue to attempt
--     to locate them.
--
-- -   @SUCCESS@ – Amazon Pinpoint located the DKIM records in the DNS
--     configuration for the domain and determined that they\'re correct.
--     Amazon Pinpoint can now send DKIM-signed email from the identity.
--
-- -   @FAILED@ – Amazon Pinpoint was unable to locate the DKIM records in
--     the DNS settings for the domain, and won\'t continue to search for
--     them.
--
-- -   @TEMPORARY_FAILURE@ – A temporary issue occurred, which prevented
--     Amazon Pinpoint from determining the DKIM status for the domain.
--
-- -   @NOT_STARTED@ – Amazon Pinpoint hasn\'t yet started searching for
--     the DKIM records in the DKIM records for the domain.
dkimAttributes_status :: Lens.Lens' DkimAttributes (Prelude.Maybe DkimStatus)
dkimAttributes_status :: (Maybe DkimStatus -> f (Maybe DkimStatus))
-> DkimAttributes -> f DkimAttributes
dkimAttributes_status = (DkimAttributes -> Maybe DkimStatus)
-> (DkimAttributes -> Maybe DkimStatus -> DkimAttributes)
-> Lens
     DkimAttributes DkimAttributes (Maybe DkimStatus) (Maybe DkimStatus)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DkimAttributes' {Maybe DkimStatus
status :: Maybe DkimStatus
$sel:status:DkimAttributes' :: DkimAttributes -> Maybe DkimStatus
status} -> Maybe DkimStatus
status) (\s :: DkimAttributes
s@DkimAttributes' {} Maybe DkimStatus
a -> DkimAttributes
s {$sel:status:DkimAttributes' :: Maybe DkimStatus
status = Maybe DkimStatus
a} :: DkimAttributes)

-- | A set of unique strings that you use to create a set of CNAME records
-- that you add to the DNS configuration for your domain. When Amazon
-- Pinpoint detects these records in the DNS configuration for your domain,
-- the DKIM authentication process is complete. Amazon Pinpoint usually
-- detects these records within about 72 hours of adding them to the DNS
-- configuration for your domain.
dkimAttributes_tokens :: Lens.Lens' DkimAttributes (Prelude.Maybe [Prelude.Text])
dkimAttributes_tokens :: (Maybe [Text] -> f (Maybe [Text]))
-> DkimAttributes -> f DkimAttributes
dkimAttributes_tokens = (DkimAttributes -> Maybe [Text])
-> (DkimAttributes -> Maybe [Text] -> DkimAttributes)
-> Lens DkimAttributes DkimAttributes (Maybe [Text]) (Maybe [Text])
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DkimAttributes' {Maybe [Text]
tokens :: Maybe [Text]
$sel:tokens:DkimAttributes' :: DkimAttributes -> Maybe [Text]
tokens} -> Maybe [Text]
tokens) (\s :: DkimAttributes
s@DkimAttributes' {} Maybe [Text]
a -> DkimAttributes
s {$sel:tokens:DkimAttributes' :: Maybe [Text]
tokens = Maybe [Text]
a} :: DkimAttributes) ((Maybe [Text] -> f (Maybe [Text]))
 -> DkimAttributes -> f DkimAttributes)
-> ((Maybe [Text] -> f (Maybe [Text]))
    -> Maybe [Text] -> f (Maybe [Text]))
-> (Maybe [Text] -> f (Maybe [Text]))
-> DkimAttributes
-> f DkimAttributes
forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. AnIso [Text] [Text] [Text] [Text]
-> Iso (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
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 AnIso [Text] [Text] [Text] [Text]
forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | If the value is @true@, then the messages that Amazon Pinpoint sends
-- from the identity are DKIM-signed. If the value is @false@, then the
-- messages that Amazon Pinpoint sends from the identity aren\'t
-- DKIM-signed.
dkimAttributes_signingEnabled :: Lens.Lens' DkimAttributes (Prelude.Maybe Prelude.Bool)
dkimAttributes_signingEnabled :: (Maybe Bool -> f (Maybe Bool))
-> DkimAttributes -> f DkimAttributes
dkimAttributes_signingEnabled = (DkimAttributes -> Maybe Bool)
-> (DkimAttributes -> Maybe Bool -> DkimAttributes)
-> Lens DkimAttributes DkimAttributes (Maybe Bool) (Maybe Bool)
forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DkimAttributes' {Maybe Bool
signingEnabled :: Maybe Bool
$sel:signingEnabled:DkimAttributes' :: DkimAttributes -> Maybe Bool
signingEnabled} -> Maybe Bool
signingEnabled) (\s :: DkimAttributes
s@DkimAttributes' {} Maybe Bool
a -> DkimAttributes
s {$sel:signingEnabled:DkimAttributes' :: Maybe Bool
signingEnabled = Maybe Bool
a} :: DkimAttributes)

instance Core.FromJSON DkimAttributes where
  parseJSON :: Value -> Parser DkimAttributes
parseJSON =
    String
-> (Object -> Parser DkimAttributes)
-> Value
-> Parser DkimAttributes
forall a. String -> (Object -> Parser a) -> Value -> Parser a
Core.withObject
      String
"DkimAttributes"
      ( \Object
x ->
          Maybe DkimStatus -> Maybe [Text] -> Maybe Bool -> DkimAttributes
DkimAttributes'
            (Maybe DkimStatus -> Maybe [Text] -> Maybe Bool -> DkimAttributes)
-> Parser (Maybe DkimStatus)
-> Parser (Maybe [Text] -> Maybe Bool -> DkimAttributes)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x Object -> Text -> Parser (Maybe DkimStatus)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Status")
            Parser (Maybe [Text] -> Maybe Bool -> DkimAttributes)
-> Parser (Maybe [Text]) -> Parser (Maybe Bool -> DkimAttributes)
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe (Maybe [Text]))
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"Tokens" Parser (Maybe (Maybe [Text]))
-> Maybe [Text] -> Parser (Maybe [Text])
forall a. Parser (Maybe a) -> a -> Parser a
Core..!= Maybe [Text]
forall a. Monoid a => a
Prelude.mempty)
            Parser (Maybe Bool -> DkimAttributes)
-> Parser (Maybe Bool) -> Parser DkimAttributes
forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x Object -> Text -> Parser (Maybe Bool)
forall a. FromJSON a => Object -> Text -> Parser (Maybe a)
Core..:? Text
"SigningEnabled")
      )

instance Prelude.Hashable DkimAttributes

instance Prelude.NFData DkimAttributes