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.UpdateDirectoryConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified 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 UpdateDirectoryConfig Source #

See: newUpdateDirectoryConfig smart constructor.

Constructors

UpdateDirectoryConfig'

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.
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 name of the Directory Config object.

Instances

Instances details

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

newUpdateDirectoryConfig Source #

Arguments

:: Text	`UpdateDirectoryConfig`
-> UpdateDirectoryConfig

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

UpdateDirectoryConfig, updateDirectoryConfig_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.

UpdateDirectoryConfig, updateDirectoryConfig_organizationalUnitDistinguishedNames - The distinguished names of the organizational units for computer accounts.

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

UpdateDirectoryConfig, updateDirectoryConfig_directoryName - The name of the Directory Config object.

Request Lenses

updateDirectoryConfig_certificateBasedAuthProperties :: Lens' UpdateDirectoryConfig (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.

updateDirectoryConfig_organizationalUnitDistinguishedNames :: Lens' UpdateDirectoryConfig (Maybe [Text]) Source #

The distinguished names of the organizational units for computer accounts.

updateDirectoryConfig_serviceAccountCredentials :: Lens' UpdateDirectoryConfig (Maybe ServiceAccountCredentials) Source #

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

updateDirectoryConfig_directoryName :: Lens' UpdateDirectoryConfig Text Source #

The name of the Directory Config object.

Destructuring the Response

data UpdateDirectoryConfigResponse Source #

See: newUpdateDirectoryConfigResponse smart constructor.

Constructors

UpdateDirectoryConfigResponse'
Fields directoryConfig :: Maybe DirectoryConfig Information about the Directory Config object. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newUpdateDirectoryConfigResponse Source #

Arguments

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

Create a value of UpdateDirectoryConfigResponse 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:UpdateDirectoryConfigResponse', updateDirectoryConfigResponse_directoryConfig - Information about the Directory Config object.

$sel:httpStatus:UpdateDirectoryConfigResponse', updateDirectoryConfigResponse_httpStatus - The response's http status code.

Response Lenses

updateDirectoryConfigResponse_directoryConfig :: Lens' UpdateDirectoryConfigResponse (Maybe DirectoryConfig) Source #

Information about the Directory Config object.

updateDirectoryConfigResponse_httpStatus :: Lens' UpdateDirectoryConfigResponse Int Source #

The response's http status code.