Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppStream.CreateDirectoryConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

Synopsis

Creating a Request

data CreateDirectoryConfig Source #

See: newCreateDirectoryConfig smart constructor.

Constructors

CreateDirectoryConfig'

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.
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).
organizationalUnitDistinguishedNames :: [Text]
The distinguished names of the organizational units for computer accounts.

Instances

Instances details

ToJSON CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods toJSON :: CreateDirectoryConfig -> Value # toEncoding :: CreateDirectoryConfig -> Encoding # toJSONList :: [CreateDirectoryConfig] -> Value # toEncodingList :: [CreateDirectoryConfig] -> Encoding #
ToHeaders CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods toHeaders :: CreateDirectoryConfig -> [Header] #
ToPath CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods toPath :: CreateDirectoryConfig -> ByteString #
ToQuery CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods toQuery :: CreateDirectoryConfig -> QueryString #
AWSRequest CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Associated Types type AWSResponse CreateDirectoryConfig # Methods request :: (Service -> Service) -> CreateDirectoryConfig -> Request CreateDirectoryConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDirectoryConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDirectoryConfig))) #
Generic CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Associated Types type Rep CreateDirectoryConfig :: Type -> Type # Methods from :: CreateDirectoryConfig -> Rep CreateDirectoryConfig x # to :: Rep CreateDirectoryConfig x -> CreateDirectoryConfig #
Show CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods showsPrec :: Int -> CreateDirectoryConfig -> ShowS # show :: CreateDirectoryConfig -> String # showList :: [CreateDirectoryConfig] -> ShowS #
NFData CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods rnf :: CreateDirectoryConfig -> () #
Eq CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods (==) :: CreateDirectoryConfig -> CreateDirectoryConfig -> Bool # (/=) :: CreateDirectoryConfig -> CreateDirectoryConfig -> Bool #
Hashable CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods hashWithSalt :: Int -> CreateDirectoryConfig -> Int # hash :: CreateDirectoryConfig -> Int #
type AWSResponse CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig type AWSResponse CreateDirectoryConfig = CreateDirectoryConfigResponse
type Rep CreateDirectoryConfig Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig type Rep CreateDirectoryConfig = D1 ('MetaData "CreateDirectoryConfig" "Amazonka.AppStream.CreateDirectoryConfig" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateDirectoryConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "certificateBasedAuthProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CertificateBasedAuthProperties)) :: S1 ('MetaSel ('Just "serviceAccountCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceAccountCredentials))) :: (S1 ('MetaSel ('Just "directoryName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "organizationalUnitDistinguishedNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newCreateDirectoryConfig Source #

Arguments

:: Text	`CreateDirectoryConfig`
-> CreateDirectoryConfig

Create a value of CreateDirectoryConfig 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:

CreateDirectoryConfig, createDirectoryConfig_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.

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

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

CreateDirectoryConfig, createDirectoryConfig_organizationalUnitDistinguishedNames - The distinguished names of the organizational units for computer accounts.

Request Lenses

createDirectoryConfig_certificateBasedAuthProperties :: Lens' CreateDirectoryConfig (Maybe CertificateBasedAuthProperties) Source #

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.

createDirectoryConfig_serviceAccountCredentials :: Lens' CreateDirectoryConfig (Maybe ServiceAccountCredentials) Source #

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

createDirectoryConfig_directoryName :: Lens' CreateDirectoryConfig Text Source #

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

createDirectoryConfig_organizationalUnitDistinguishedNames :: Lens' CreateDirectoryConfig [Text] Source #

The distinguished names of the organizational units for computer accounts.

Destructuring the Response

data CreateDirectoryConfigResponse Source #

See: newCreateDirectoryConfigResponse smart constructor.

Constructors

CreateDirectoryConfigResponse'
Fields directoryConfig :: Maybe DirectoryConfig Information about the directory configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDirectoryConfigResponse Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Associated Types type Rep CreateDirectoryConfigResponse :: Type -> Type # Methods from :: CreateDirectoryConfigResponse -> Rep CreateDirectoryConfigResponse x # to :: Rep CreateDirectoryConfigResponse x -> CreateDirectoryConfigResponse #
Show CreateDirectoryConfigResponse Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods showsPrec :: Int -> CreateDirectoryConfigResponse -> ShowS # show :: CreateDirectoryConfigResponse -> String # showList :: [CreateDirectoryConfigResponse] -> ShowS #
NFData CreateDirectoryConfigResponse Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods rnf :: CreateDirectoryConfigResponse -> () #
Eq CreateDirectoryConfigResponse Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig Methods (==) :: CreateDirectoryConfigResponse -> CreateDirectoryConfigResponse -> Bool # (/=) :: CreateDirectoryConfigResponse -> CreateDirectoryConfigResponse -> Bool #
type Rep CreateDirectoryConfigResponse Source #
Instance details Defined in Amazonka.AppStream.CreateDirectoryConfig type Rep CreateDirectoryConfigResponse = D1 ('MetaData "CreateDirectoryConfigResponse" "Amazonka.AppStream.CreateDirectoryConfig" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateDirectoryConfigResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "directoryConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DirectoryConfig)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateDirectoryConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDirectoryConfigResponse'`
-> CreateDirectoryConfigResponse

Create a value of CreateDirectoryConfigResponse 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:directoryConfig:CreateDirectoryConfigResponse', createDirectoryConfigResponse_directoryConfig - Information about the directory configuration.

$sel:httpStatus:CreateDirectoryConfigResponse', createDirectoryConfigResponse_httpStatus - The response's http status code.

Response Lenses

createDirectoryConfigResponse_directoryConfig :: Lens' CreateDirectoryConfigResponse (Maybe DirectoryConfig) Source #

Information about the directory configuration.

createDirectoryConfigResponse_httpStatus :: Lens' CreateDirectoryConfigResponse Int Source #

The response's http status code.