Amazonka.AppStream.Types.DirectoryConfig

Documentation

data DirectoryConfig

Describes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

See: newDirectoryConfig smart constructor.

Constructors

DirectoryConfig'

Fields

• certificateBasedAuthProperties :: Maybe 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 :: Maybe POSIX

  The time the directory configuration was created.

• organizationalUnitDistinguishedNames :: Maybe [Text]

  The distinguished names of the organizational units for computer accounts.

• serviceAccountCredentials :: Maybe ServiceAccountCredentials

  The credentials for the service account used by the fleet or image builder to connect to the directory.

• directoryName :: Text

  The fully qualified name of the directory (for example, corp.example.com).

Instances

FromJSON DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

Methods

parseJSON :: Value -> Parser DirectoryConfig

parseJSONList :: Value -> Parser [DirectoryConfig]

Generic DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

Associated Types

type Rep DirectoryConfig :: Type -> Type

Methods

from :: DirectoryConfig -> Rep DirectoryConfig x

to :: Rep DirectoryConfig x -> DirectoryConfig

Show DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

Methods

showsPrec :: Int -> DirectoryConfig -> ShowS

show :: DirectoryConfig -> String

showList :: [DirectoryConfig] -> ShowS

NFData DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

Methods

rnf :: DirectoryConfig -> ()

Eq DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

Methods

(==) :: DirectoryConfig -> DirectoryConfig -> Bool

(/=) :: DirectoryConfig -> DirectoryConfig -> Bool

Hashable DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

Methods

hashWithSalt :: Int -> DirectoryConfig -> Int

hash :: DirectoryConfig -> Int

type Rep DirectoryConfig

Defined in Amazonka.AppStream.Types.DirectoryConfig

type Rep DirectoryConfig = D1 ('MetaData "DirectoryConfig" "Amazonka.AppStream.Types.DirectoryConfig" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "DirectoryConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateBasedAuthProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateBasedAuthProperties)) :*: S1 ('MetaSel ('Just "createdTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :*: (S1 ('MetaSel ('Just "organizationalUnitDistinguishedNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "serviceAccountCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceAccountCredentials)) :*: S1 ('MetaSel ('Just "directoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDirectoryConfig

Arguments

:: Text

$sel:directoryName:DirectoryConfig'

-> DirectoryConfig

Create a value of DirectoryConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateBasedAuthProperties:DirectoryConfig', 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.

$sel:createdTime:DirectoryConfig', directoryConfig_createdTime - The time the directory configuration was created.

$sel:organizationalUnitDistinguishedNames:DirectoryConfig', directoryConfig_organizationalUnitDistinguishedNames - The distinguished names of the organizational units for computer accounts.

$sel:serviceAccountCredentials:DirectoryConfig', directoryConfig_serviceAccountCredentials - The credentials for the service account used by the fleet or image builder to connect to the directory.

$sel:directoryName:DirectoryConfig', directoryConfig_directoryName - The fully qualified name of the directory (for example, corp.example.com).

directoryConfig_certificateBasedAuthProperties :: Lens' DirectoryConfig (Maybe 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.

directoryConfig_createdTime :: Lens' DirectoryConfig (Maybe UTCTime)

The time the directory configuration was created.

directoryConfig_organizationalUnitDistinguishedNames :: Lens' DirectoryConfig (Maybe [Text])

The distinguished names of the organizational units for computer accounts.

directoryConfig_serviceAccountCredentials :: Lens' DirectoryConfig (Maybe ServiceAccountCredentials)

The credentials for the service account used by the fleet or image builder to connect to the directory.

directoryConfig_directoryName :: Lens' DirectoryConfig Text

The fully qualified name of the directory (for example, corp.example.com).