{-# 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.Amplify.Types.DomainAssociation
-- 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.Amplify.Types.DomainAssociation where

import Amazonka.Amplify.Types.DomainStatus
import Amazonka.Amplify.Types.SubDomain
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

-- | Describes a domain association that associates a custom domain with an
-- Amplify app.
--
-- /See:/ 'newDomainAssociation' smart constructor.
data DomainAssociation = DomainAssociation'
  { -- | Sets branch patterns for automatic subdomain creation.
    DomainAssociation -> Maybe [Text]
autoSubDomainCreationPatterns :: Prelude.Maybe [Prelude.Text],
    -- | The required AWS Identity and Access Management (IAM) service role for
    -- the Amazon Resource Name (ARN) for automatically creating subdomains.
    DomainAssociation -> Maybe Text
autoSubDomainIAMRole :: Prelude.Maybe Prelude.Text,
    -- | The DNS record for certificate verification.
    DomainAssociation -> Maybe Text
certificateVerificationDNSRecord :: Prelude.Maybe Prelude.Text,
    -- | The Amazon Resource Name (ARN) for the domain association.
    DomainAssociation -> Text
domainAssociationArn :: Prelude.Text,
    -- | The name of the domain.
    DomainAssociation -> Text
domainName :: Prelude.Text,
    -- | Enables the automated creation of subdomains for branches.
    DomainAssociation -> Bool
enableAutoSubDomain :: Prelude.Bool,
    -- | The current status of the domain association.
    DomainAssociation -> DomainStatus
domainStatus :: DomainStatus,
    -- | The reason for the current status of the domain association.
    DomainAssociation -> Text
statusReason :: Prelude.Text,
    -- | The subdomains for the domain association.
    DomainAssociation -> [SubDomain]
subDomains :: [SubDomain]
  }
  deriving (DomainAssociation -> DomainAssociation -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DomainAssociation -> DomainAssociation -> Bool
$c/= :: DomainAssociation -> DomainAssociation -> Bool
== :: DomainAssociation -> DomainAssociation -> Bool
$c== :: DomainAssociation -> DomainAssociation -> Bool
Prelude.Eq, ReadPrec [DomainAssociation]
ReadPrec DomainAssociation
Int -> ReadS DomainAssociation
ReadS [DomainAssociation]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DomainAssociation]
$creadListPrec :: ReadPrec [DomainAssociation]
readPrec :: ReadPrec DomainAssociation
$creadPrec :: ReadPrec DomainAssociation
readList :: ReadS [DomainAssociation]
$creadList :: ReadS [DomainAssociation]
readsPrec :: Int -> ReadS DomainAssociation
$creadsPrec :: Int -> ReadS DomainAssociation
Prelude.Read, Int -> DomainAssociation -> ShowS
[DomainAssociation] -> ShowS
DomainAssociation -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DomainAssociation] -> ShowS
$cshowList :: [DomainAssociation] -> ShowS
show :: DomainAssociation -> String
$cshow :: DomainAssociation -> String
showsPrec :: Int -> DomainAssociation -> ShowS
$cshowsPrec :: Int -> DomainAssociation -> ShowS
Prelude.Show, forall x. Rep DomainAssociation x -> DomainAssociation
forall x. DomainAssociation -> Rep DomainAssociation x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DomainAssociation x -> DomainAssociation
$cfrom :: forall x. DomainAssociation -> Rep DomainAssociation x
Prelude.Generic)

-- |
-- Create a value of 'DomainAssociation' 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:
--
-- 'autoSubDomainCreationPatterns', 'domainAssociation_autoSubDomainCreationPatterns' - Sets branch patterns for automatic subdomain creation.
--
-- 'autoSubDomainIAMRole', 'domainAssociation_autoSubDomainIAMRole' - The required AWS Identity and Access Management (IAM) service role for
-- the Amazon Resource Name (ARN) for automatically creating subdomains.
--
-- 'certificateVerificationDNSRecord', 'domainAssociation_certificateVerificationDNSRecord' - The DNS record for certificate verification.
--
-- 'domainAssociationArn', 'domainAssociation_domainAssociationArn' - The Amazon Resource Name (ARN) for the domain association.
--
-- 'domainName', 'domainAssociation_domainName' - The name of the domain.
--
-- 'enableAutoSubDomain', 'domainAssociation_enableAutoSubDomain' - Enables the automated creation of subdomains for branches.
--
-- 'domainStatus', 'domainAssociation_domainStatus' - The current status of the domain association.
--
-- 'statusReason', 'domainAssociation_statusReason' - The reason for the current status of the domain association.
--
-- 'subDomains', 'domainAssociation_subDomains' - The subdomains for the domain association.
newDomainAssociation ::
  -- | 'domainAssociationArn'
  Prelude.Text ->
  -- | 'domainName'
  Prelude.Text ->
  -- | 'enableAutoSubDomain'
  Prelude.Bool ->
  -- | 'domainStatus'
  DomainStatus ->
  -- | 'statusReason'
  Prelude.Text ->
  DomainAssociation
newDomainAssociation :: Text -> Text -> Bool -> DomainStatus -> Text -> DomainAssociation
newDomainAssociation
  Text
pDomainAssociationArn_
  Text
pDomainName_
  Bool
pEnableAutoSubDomain_
  DomainStatus
pDomainStatus_
  Text
pStatusReason_ =
    DomainAssociation'
      { $sel:autoSubDomainCreationPatterns:DomainAssociation' :: Maybe [Text]
autoSubDomainCreationPatterns =
          forall a. Maybe a
Prelude.Nothing,
        $sel:autoSubDomainIAMRole:DomainAssociation' :: Maybe Text
autoSubDomainIAMRole = forall a. Maybe a
Prelude.Nothing,
        $sel:certificateVerificationDNSRecord:DomainAssociation' :: Maybe Text
certificateVerificationDNSRecord = forall a. Maybe a
Prelude.Nothing,
        $sel:domainAssociationArn:DomainAssociation' :: Text
domainAssociationArn = Text
pDomainAssociationArn_,
        $sel:domainName:DomainAssociation' :: Text
domainName = Text
pDomainName_,
        $sel:enableAutoSubDomain:DomainAssociation' :: Bool
enableAutoSubDomain = Bool
pEnableAutoSubDomain_,
        $sel:domainStatus:DomainAssociation' :: DomainStatus
domainStatus = DomainStatus
pDomainStatus_,
        $sel:statusReason:DomainAssociation' :: Text
statusReason = Text
pStatusReason_,
        $sel:subDomains:DomainAssociation' :: [SubDomain]
subDomains = forall a. Monoid a => a
Prelude.mempty
      }

-- | Sets branch patterns for automatic subdomain creation.
domainAssociation_autoSubDomainCreationPatterns :: Lens.Lens' DomainAssociation (Prelude.Maybe [Prelude.Text])
domainAssociation_autoSubDomainCreationPatterns :: Lens' DomainAssociation (Maybe [Text])
domainAssociation_autoSubDomainCreationPatterns = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Maybe [Text]
autoSubDomainCreationPatterns :: Maybe [Text]
$sel:autoSubDomainCreationPatterns:DomainAssociation' :: DomainAssociation -> Maybe [Text]
autoSubDomainCreationPatterns} -> Maybe [Text]
autoSubDomainCreationPatterns) (\s :: DomainAssociation
s@DomainAssociation' {} Maybe [Text]
a -> DomainAssociation
s {$sel:autoSubDomainCreationPatterns:DomainAssociation' :: Maybe [Text]
autoSubDomainCreationPatterns = Maybe [Text]
a} :: DomainAssociation) 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 s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The required AWS Identity and Access Management (IAM) service role for
-- the Amazon Resource Name (ARN) for automatically creating subdomains.
domainAssociation_autoSubDomainIAMRole :: Lens.Lens' DomainAssociation (Prelude.Maybe Prelude.Text)
domainAssociation_autoSubDomainIAMRole :: Lens' DomainAssociation (Maybe Text)
domainAssociation_autoSubDomainIAMRole = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Maybe Text
autoSubDomainIAMRole :: Maybe Text
$sel:autoSubDomainIAMRole:DomainAssociation' :: DomainAssociation -> Maybe Text
autoSubDomainIAMRole} -> Maybe Text
autoSubDomainIAMRole) (\s :: DomainAssociation
s@DomainAssociation' {} Maybe Text
a -> DomainAssociation
s {$sel:autoSubDomainIAMRole:DomainAssociation' :: Maybe Text
autoSubDomainIAMRole = Maybe Text
a} :: DomainAssociation)

-- | The DNS record for certificate verification.
domainAssociation_certificateVerificationDNSRecord :: Lens.Lens' DomainAssociation (Prelude.Maybe Prelude.Text)
domainAssociation_certificateVerificationDNSRecord :: Lens' DomainAssociation (Maybe Text)
domainAssociation_certificateVerificationDNSRecord = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Maybe Text
certificateVerificationDNSRecord :: Maybe Text
$sel:certificateVerificationDNSRecord:DomainAssociation' :: DomainAssociation -> Maybe Text
certificateVerificationDNSRecord} -> Maybe Text
certificateVerificationDNSRecord) (\s :: DomainAssociation
s@DomainAssociation' {} Maybe Text
a -> DomainAssociation
s {$sel:certificateVerificationDNSRecord:DomainAssociation' :: Maybe Text
certificateVerificationDNSRecord = Maybe Text
a} :: DomainAssociation)

-- | The Amazon Resource Name (ARN) for the domain association.
domainAssociation_domainAssociationArn :: Lens.Lens' DomainAssociation Prelude.Text
domainAssociation_domainAssociationArn :: Lens' DomainAssociation Text
domainAssociation_domainAssociationArn = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Text
domainAssociationArn :: Text
$sel:domainAssociationArn:DomainAssociation' :: DomainAssociation -> Text
domainAssociationArn} -> Text
domainAssociationArn) (\s :: DomainAssociation
s@DomainAssociation' {} Text
a -> DomainAssociation
s {$sel:domainAssociationArn:DomainAssociation' :: Text
domainAssociationArn = Text
a} :: DomainAssociation)

-- | The name of the domain.
domainAssociation_domainName :: Lens.Lens' DomainAssociation Prelude.Text
domainAssociation_domainName :: Lens' DomainAssociation Text
domainAssociation_domainName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Text
domainName :: Text
$sel:domainName:DomainAssociation' :: DomainAssociation -> Text
domainName} -> Text
domainName) (\s :: DomainAssociation
s@DomainAssociation' {} Text
a -> DomainAssociation
s {$sel:domainName:DomainAssociation' :: Text
domainName = Text
a} :: DomainAssociation)

-- | Enables the automated creation of subdomains for branches.
domainAssociation_enableAutoSubDomain :: Lens.Lens' DomainAssociation Prelude.Bool
domainAssociation_enableAutoSubDomain :: Lens' DomainAssociation Bool
domainAssociation_enableAutoSubDomain = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Bool
enableAutoSubDomain :: Bool
$sel:enableAutoSubDomain:DomainAssociation' :: DomainAssociation -> Bool
enableAutoSubDomain} -> Bool
enableAutoSubDomain) (\s :: DomainAssociation
s@DomainAssociation' {} Bool
a -> DomainAssociation
s {$sel:enableAutoSubDomain:DomainAssociation' :: Bool
enableAutoSubDomain = Bool
a} :: DomainAssociation)

-- | The current status of the domain association.
domainAssociation_domainStatus :: Lens.Lens' DomainAssociation DomainStatus
domainAssociation_domainStatus :: Lens' DomainAssociation DomainStatus
domainAssociation_domainStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {DomainStatus
domainStatus :: DomainStatus
$sel:domainStatus:DomainAssociation' :: DomainAssociation -> DomainStatus
domainStatus} -> DomainStatus
domainStatus) (\s :: DomainAssociation
s@DomainAssociation' {} DomainStatus
a -> DomainAssociation
s {$sel:domainStatus:DomainAssociation' :: DomainStatus
domainStatus = DomainStatus
a} :: DomainAssociation)

-- | The reason for the current status of the domain association.
domainAssociation_statusReason :: Lens.Lens' DomainAssociation Prelude.Text
domainAssociation_statusReason :: Lens' DomainAssociation Text
domainAssociation_statusReason = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {Text
statusReason :: Text
$sel:statusReason:DomainAssociation' :: DomainAssociation -> Text
statusReason} -> Text
statusReason) (\s :: DomainAssociation
s@DomainAssociation' {} Text
a -> DomainAssociation
s {$sel:statusReason:DomainAssociation' :: Text
statusReason = Text
a} :: DomainAssociation)

-- | The subdomains for the domain association.
domainAssociation_subDomains :: Lens.Lens' DomainAssociation [SubDomain]
domainAssociation_subDomains :: Lens' DomainAssociation [SubDomain]
domainAssociation_subDomains = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DomainAssociation' {[SubDomain]
subDomains :: [SubDomain]
$sel:subDomains:DomainAssociation' :: DomainAssociation -> [SubDomain]
subDomains} -> [SubDomain]
subDomains) (\s :: DomainAssociation
s@DomainAssociation' {} [SubDomain]
a -> DomainAssociation
s {$sel:subDomains:DomainAssociation' :: [SubDomain]
subDomains = [SubDomain]
a} :: DomainAssociation) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

instance Data.FromJSON DomainAssociation where
  parseJSON :: Value -> Parser DomainAssociation
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DomainAssociation"
      ( \Object
x ->
          Maybe [Text]
-> Maybe Text
-> Maybe Text
-> Text
-> Text
-> Bool
-> DomainStatus
-> Text
-> [SubDomain]
-> DomainAssociation
DomainAssociation'
            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
"autoSubDomainCreationPatterns"
                            forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty
                        )
            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
"autoSubDomainIAMRole")
            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
"certificateVerificationDNSRecord")
            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
"domainAssociationArn")
            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
"domainName")
            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
"enableAutoSubDomain")
            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
"domainStatus")
            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
"statusReason")
            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
"subDomains" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
      )

instance Prelude.Hashable DomainAssociation where
  hashWithSalt :: Int -> DomainAssociation -> Int
hashWithSalt Int
_salt DomainAssociation' {Bool
[SubDomain]
Maybe [Text]
Maybe Text
Text
DomainStatus
subDomains :: [SubDomain]
statusReason :: Text
domainStatus :: DomainStatus
enableAutoSubDomain :: Bool
domainName :: Text
domainAssociationArn :: Text
certificateVerificationDNSRecord :: Maybe Text
autoSubDomainIAMRole :: Maybe Text
autoSubDomainCreationPatterns :: Maybe [Text]
$sel:subDomains:DomainAssociation' :: DomainAssociation -> [SubDomain]
$sel:statusReason:DomainAssociation' :: DomainAssociation -> Text
$sel:domainStatus:DomainAssociation' :: DomainAssociation -> DomainStatus
$sel:enableAutoSubDomain:DomainAssociation' :: DomainAssociation -> Bool
$sel:domainName:DomainAssociation' :: DomainAssociation -> Text
$sel:domainAssociationArn:DomainAssociation' :: DomainAssociation -> Text
$sel:certificateVerificationDNSRecord:DomainAssociation' :: DomainAssociation -> Maybe Text
$sel:autoSubDomainIAMRole:DomainAssociation' :: DomainAssociation -> Maybe Text
$sel:autoSubDomainCreationPatterns:DomainAssociation' :: DomainAssociation -> Maybe [Text]
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
autoSubDomainCreationPatterns
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
autoSubDomainIAMRole
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
certificateVerificationDNSRecord
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
domainAssociationArn
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
domainName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Bool
enableAutoSubDomain
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` DomainStatus
domainStatus
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
statusReason
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` [SubDomain]
subDomains

instance Prelude.NFData DomainAssociation where
  rnf :: DomainAssociation -> ()
rnf DomainAssociation' {Bool
[SubDomain]
Maybe [Text]
Maybe Text
Text
DomainStatus
subDomains :: [SubDomain]
statusReason :: Text
domainStatus :: DomainStatus
enableAutoSubDomain :: Bool
domainName :: Text
domainAssociationArn :: Text
certificateVerificationDNSRecord :: Maybe Text
autoSubDomainIAMRole :: Maybe Text
autoSubDomainCreationPatterns :: Maybe [Text]
$sel:subDomains:DomainAssociation' :: DomainAssociation -> [SubDomain]
$sel:statusReason:DomainAssociation' :: DomainAssociation -> Text
$sel:domainStatus:DomainAssociation' :: DomainAssociation -> DomainStatus
$sel:enableAutoSubDomain:DomainAssociation' :: DomainAssociation -> Bool
$sel:domainName:DomainAssociation' :: DomainAssociation -> Text
$sel:domainAssociationArn:DomainAssociation' :: DomainAssociation -> Text
$sel:certificateVerificationDNSRecord:DomainAssociation' :: DomainAssociation -> Maybe Text
$sel:autoSubDomainIAMRole:DomainAssociation' :: DomainAssociation -> Maybe Text
$sel:autoSubDomainCreationPatterns:DomainAssociation' :: DomainAssociation -> Maybe [Text]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
autoSubDomainCreationPatterns
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
autoSubDomainIAMRole
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
certificateVerificationDNSRecord
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
domainAssociationArn
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
domainName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Bool
enableAutoSubDomain
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf DomainStatus
domainStatus
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
statusReason
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf [SubDomain]
subDomains