{-# 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.AppStream.Types.DirectoryConfig
-- 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.AppStream.Types.DirectoryConfig where

import Amazonka.AppStream.Types.CertificateBasedAuthProperties
import Amazonka.AppStream.Types.ServiceAccountCredentials
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 the configuration information required to join fleets and
-- image builders to Microsoft Active Directory domains.
--
-- /See:/ 'newDirectoryConfig' smart constructor.
data DirectoryConfig = DirectoryConfig'
  { -- | The certificate-based authentication properties used to authenticate
    -- SAML 2.0 Identity Provider (IdP) user identities to Active Directory
    -- domain-joined streaming instances. Fallback is turned on by default when
    -- certificate-based authentication is __Enabled__ . Fallback allows users
    -- to log in using their AD domain password if certificate-based
    -- authentication is unsuccessful, or to unlock a desktop lock screen.
    -- __Enabled_no_directory_login_fallback__ enables certificate-based
    -- authentication, but does not allow users to log in using their AD domain
    -- password. Users will be disconnected to re-authenticate using
    -- certificates.
    DirectoryConfig -> Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties :: Prelude.Maybe CertificateBasedAuthProperties,
    -- | The time the directory configuration was created.
    DirectoryConfig -> Maybe POSIX
createdTime :: Prelude.Maybe Data.POSIX,
    -- | The distinguished names of the organizational units for computer
    -- accounts.
    DirectoryConfig -> Maybe [Text]
organizationalUnitDistinguishedNames :: Prelude.Maybe [Prelude.Text],
    -- | The credentials for the service account used by the fleet or image
    -- builder to connect to the directory.
    DirectoryConfig -> Maybe ServiceAccountCredentials
serviceAccountCredentials :: Prelude.Maybe ServiceAccountCredentials,
    -- | The fully qualified name of the directory (for example,
    -- corp.example.com).
    DirectoryConfig -> Text
directoryName :: Prelude.Text
  }
  deriving (DirectoryConfig -> DirectoryConfig -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DirectoryConfig -> DirectoryConfig -> Bool
$c/= :: DirectoryConfig -> DirectoryConfig -> Bool
== :: DirectoryConfig -> DirectoryConfig -> Bool
$c== :: DirectoryConfig -> DirectoryConfig -> Bool
Prelude.Eq, Int -> DirectoryConfig -> ShowS
[DirectoryConfig] -> ShowS
DirectoryConfig -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DirectoryConfig] -> ShowS
$cshowList :: [DirectoryConfig] -> ShowS
show :: DirectoryConfig -> String
$cshow :: DirectoryConfig -> String
showsPrec :: Int -> DirectoryConfig -> ShowS
$cshowsPrec :: Int -> DirectoryConfig -> ShowS
Prelude.Show, forall x. Rep DirectoryConfig x -> DirectoryConfig
forall x. DirectoryConfig -> Rep DirectoryConfig x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DirectoryConfig x -> DirectoryConfig
$cfrom :: forall x. DirectoryConfig -> Rep DirectoryConfig x
Prelude.Generic)

-- |
-- Create a value of 'DirectoryConfig' 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:
--
-- 'certificateBasedAuthProperties', 'directoryConfig_certificateBasedAuthProperties' - The certificate-based authentication properties used to authenticate
-- SAML 2.0 Identity Provider (IdP) user identities to Active Directory
-- domain-joined streaming instances. Fallback is turned on by default when
-- certificate-based authentication is __Enabled__ . Fallback allows users
-- to log in using their AD domain password if certificate-based
-- authentication is unsuccessful, or to unlock a desktop lock screen.
-- __Enabled_no_directory_login_fallback__ enables certificate-based
-- authentication, but does not allow users to log in using their AD domain
-- password. Users will be disconnected to re-authenticate using
-- certificates.
--
-- 'createdTime', 'directoryConfig_createdTime' - The time the directory configuration was created.
--
-- 'organizationalUnitDistinguishedNames', 'directoryConfig_organizationalUnitDistinguishedNames' - The distinguished names of the organizational units for computer
-- accounts.
--
-- 'serviceAccountCredentials', 'directoryConfig_serviceAccountCredentials' - The credentials for the service account used by the fleet or image
-- builder to connect to the directory.
--
-- 'directoryName', 'directoryConfig_directoryName' - The fully qualified name of the directory (for example,
-- corp.example.com).
newDirectoryConfig ::
  -- | 'directoryName'
  Prelude.Text ->
  DirectoryConfig
newDirectoryConfig :: Text -> DirectoryConfig
newDirectoryConfig Text
pDirectoryName_ =
  DirectoryConfig'
    { $sel:certificateBasedAuthProperties:DirectoryConfig' :: Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties =
        forall a. Maybe a
Prelude.Nothing,
      $sel:createdTime:DirectoryConfig' :: Maybe POSIX
createdTime = forall a. Maybe a
Prelude.Nothing,
      $sel:organizationalUnitDistinguishedNames:DirectoryConfig' :: Maybe [Text]
organizationalUnitDistinguishedNames =
        forall a. Maybe a
Prelude.Nothing,
      $sel:serviceAccountCredentials:DirectoryConfig' :: Maybe ServiceAccountCredentials
serviceAccountCredentials = forall a. Maybe a
Prelude.Nothing,
      $sel:directoryName:DirectoryConfig' :: Text
directoryName = Text
pDirectoryName_
    }

-- | The certificate-based authentication properties used to authenticate
-- SAML 2.0 Identity Provider (IdP) user identities to Active Directory
-- domain-joined streaming instances. Fallback is turned on by default when
-- certificate-based authentication is __Enabled__ . Fallback allows users
-- to log in using their AD domain password if certificate-based
-- authentication is unsuccessful, or to unlock a desktop lock screen.
-- __Enabled_no_directory_login_fallback__ enables certificate-based
-- authentication, but does not allow users to log in using their AD domain
-- password. Users will be disconnected to re-authenticate using
-- certificates.
directoryConfig_certificateBasedAuthProperties :: Lens.Lens' DirectoryConfig (Prelude.Maybe CertificateBasedAuthProperties)
directoryConfig_certificateBasedAuthProperties :: Lens' DirectoryConfig (Maybe CertificateBasedAuthProperties)
directoryConfig_certificateBasedAuthProperties = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DirectoryConfig' {Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties :: Maybe CertificateBasedAuthProperties
$sel:certificateBasedAuthProperties:DirectoryConfig' :: DirectoryConfig -> Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties} -> Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties) (\s :: DirectoryConfig
s@DirectoryConfig' {} Maybe CertificateBasedAuthProperties
a -> DirectoryConfig
s {$sel:certificateBasedAuthProperties:DirectoryConfig' :: Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties = Maybe CertificateBasedAuthProperties
a} :: DirectoryConfig)

-- | The time the directory configuration was created.
directoryConfig_createdTime :: Lens.Lens' DirectoryConfig (Prelude.Maybe Prelude.UTCTime)
directoryConfig_createdTime :: Lens' DirectoryConfig (Maybe UTCTime)
directoryConfig_createdTime = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DirectoryConfig' {Maybe POSIX
createdTime :: Maybe POSIX
$sel:createdTime:DirectoryConfig' :: DirectoryConfig -> Maybe POSIX
createdTime} -> Maybe POSIX
createdTime) (\s :: DirectoryConfig
s@DirectoryConfig' {} Maybe POSIX
a -> DirectoryConfig
s {$sel:createdTime:DirectoryConfig' :: Maybe POSIX
createdTime = Maybe POSIX
a} :: DirectoryConfig) 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 distinguished names of the organizational units for computer
-- accounts.
directoryConfig_organizationalUnitDistinguishedNames :: Lens.Lens' DirectoryConfig (Prelude.Maybe [Prelude.Text])
directoryConfig_organizationalUnitDistinguishedNames :: Lens' DirectoryConfig (Maybe [Text])
directoryConfig_organizationalUnitDistinguishedNames = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DirectoryConfig' {Maybe [Text]
organizationalUnitDistinguishedNames :: Maybe [Text]
$sel:organizationalUnitDistinguishedNames:DirectoryConfig' :: DirectoryConfig -> Maybe [Text]
organizationalUnitDistinguishedNames} -> Maybe [Text]
organizationalUnitDistinguishedNames) (\s :: DirectoryConfig
s@DirectoryConfig' {} Maybe [Text]
a -> DirectoryConfig
s {$sel:organizationalUnitDistinguishedNames:DirectoryConfig' :: Maybe [Text]
organizationalUnitDistinguishedNames = Maybe [Text]
a} :: DirectoryConfig) 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 credentials for the service account used by the fleet or image
-- builder to connect to the directory.
directoryConfig_serviceAccountCredentials :: Lens.Lens' DirectoryConfig (Prelude.Maybe ServiceAccountCredentials)
directoryConfig_serviceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials)
directoryConfig_serviceAccountCredentials = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DirectoryConfig' {Maybe ServiceAccountCredentials
serviceAccountCredentials :: Maybe ServiceAccountCredentials
$sel:serviceAccountCredentials:DirectoryConfig' :: DirectoryConfig -> Maybe ServiceAccountCredentials
serviceAccountCredentials} -> Maybe ServiceAccountCredentials
serviceAccountCredentials) (\s :: DirectoryConfig
s@DirectoryConfig' {} Maybe ServiceAccountCredentials
a -> DirectoryConfig
s {$sel:serviceAccountCredentials:DirectoryConfig' :: Maybe ServiceAccountCredentials
serviceAccountCredentials = Maybe ServiceAccountCredentials
a} :: DirectoryConfig)

-- | The fully qualified name of the directory (for example,
-- corp.example.com).
directoryConfig_directoryName :: Lens.Lens' DirectoryConfig Prelude.Text
directoryConfig_directoryName :: Lens' DirectoryConfig Text
directoryConfig_directoryName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DirectoryConfig' {Text
directoryName :: Text
$sel:directoryName:DirectoryConfig' :: DirectoryConfig -> Text
directoryName} -> Text
directoryName) (\s :: DirectoryConfig
s@DirectoryConfig' {} Text
a -> DirectoryConfig
s {$sel:directoryName:DirectoryConfig' :: Text
directoryName = Text
a} :: DirectoryConfig)

instance Data.FromJSON DirectoryConfig where
  parseJSON :: Value -> Parser DirectoryConfig
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"DirectoryConfig"
      ( \Object
x ->
          Maybe CertificateBasedAuthProperties
-> Maybe POSIX
-> Maybe [Text]
-> Maybe ServiceAccountCredentials
-> Text
-> DirectoryConfig
DirectoryConfig'
            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
"CertificateBasedAuthProperties")
            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
"CreatedTime")
            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
"OrganizationalUnitDistinguishedNames"
                            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
"ServiceAccountCredentials")
            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
"DirectoryName")
      )

instance Prelude.Hashable DirectoryConfig where
  hashWithSalt :: Int -> DirectoryConfig -> Int
hashWithSalt Int
_salt DirectoryConfig' {Maybe [Text]
Maybe POSIX
Maybe CertificateBasedAuthProperties
Maybe ServiceAccountCredentials
Text
directoryName :: Text
serviceAccountCredentials :: Maybe ServiceAccountCredentials
organizationalUnitDistinguishedNames :: Maybe [Text]
createdTime :: Maybe POSIX
certificateBasedAuthProperties :: Maybe CertificateBasedAuthProperties
$sel:directoryName:DirectoryConfig' :: DirectoryConfig -> Text
$sel:serviceAccountCredentials:DirectoryConfig' :: DirectoryConfig -> Maybe ServiceAccountCredentials
$sel:organizationalUnitDistinguishedNames:DirectoryConfig' :: DirectoryConfig -> Maybe [Text]
$sel:createdTime:DirectoryConfig' :: DirectoryConfig -> Maybe POSIX
$sel:certificateBasedAuthProperties:DirectoryConfig' :: DirectoryConfig -> Maybe CertificateBasedAuthProperties
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe POSIX
createdTime
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe [Text]
organizationalUnitDistinguishedNames
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe ServiceAccountCredentials
serviceAccountCredentials
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
directoryName

instance Prelude.NFData DirectoryConfig where
  rnf :: DirectoryConfig -> ()
rnf DirectoryConfig' {Maybe [Text]
Maybe POSIX
Maybe CertificateBasedAuthProperties
Maybe ServiceAccountCredentials
Text
directoryName :: Text
serviceAccountCredentials :: Maybe ServiceAccountCredentials
organizationalUnitDistinguishedNames :: Maybe [Text]
createdTime :: Maybe POSIX
certificateBasedAuthProperties :: Maybe CertificateBasedAuthProperties
$sel:directoryName:DirectoryConfig' :: DirectoryConfig -> Text
$sel:serviceAccountCredentials:DirectoryConfig' :: DirectoryConfig -> Maybe ServiceAccountCredentials
$sel:organizationalUnitDistinguishedNames:DirectoryConfig' :: DirectoryConfig -> Maybe [Text]
$sel:createdTime:DirectoryConfig' :: DirectoryConfig -> Maybe POSIX
$sel:certificateBasedAuthProperties:DirectoryConfig' :: DirectoryConfig -> Maybe CertificateBasedAuthProperties
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe CertificateBasedAuthProperties
certificateBasedAuthProperties
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe POSIX
createdTime
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [Text]
organizationalUnitDistinguishedNames
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe ServiceAccountCredentials
serviceAccountCredentials
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
directoryName