Amazonka.AppStream.UpdateDirectoryConfig

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.

Creating a Request

data UpdateDirectoryConfig

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

ToJSON UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

toJSON :: UpdateDirectoryConfig -> Value

toEncoding :: UpdateDirectoryConfig -> Encoding

toJSONList :: [UpdateDirectoryConfig] -> Value

toEncodingList :: [UpdateDirectoryConfig] -> Encoding

ToHeaders UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

toHeaders :: UpdateDirectoryConfig -> [Header]

ToPath UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

toPath :: UpdateDirectoryConfig -> ByteString

ToQuery UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

toQuery :: UpdateDirectoryConfig -> QueryString

AWSRequest UpdateDirectoryConfig

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

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

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

showsPrec :: Int -> UpdateDirectoryConfig -> ShowS

show :: UpdateDirectoryConfig -> String

showList :: [UpdateDirectoryConfig] -> ShowS

NFData UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

rnf :: UpdateDirectoryConfig -> ()

Eq UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

(==) :: UpdateDirectoryConfig -> UpdateDirectoryConfig -> Bool

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

Hashable UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

hashWithSalt :: Int -> UpdateDirectoryConfig -> Int

hash :: UpdateDirectoryConfig -> Int

type AWSResponse UpdateDirectoryConfig

Defined in Amazonka.AppStream.UpdateDirectoryConfig

type AWSResponse UpdateDirectoryConfig = UpdateDirectoryConfigResponse

type Rep UpdateDirectoryConfig

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

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)

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])

The distinguished names of the organizational units for computer accounts.

updateDirectoryConfig_serviceAccountCredentials :: Lens' UpdateDirectoryConfig (Maybe ServiceAccountCredentials)

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

updateDirectoryConfig_directoryName :: Lens' UpdateDirectoryConfig Text

The name of the Directory Config object.

Destructuring the Response

data UpdateDirectoryConfigResponse

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

Generic UpdateDirectoryConfigResponse

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

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

showsPrec :: Int -> UpdateDirectoryConfigResponse -> ShowS

show :: UpdateDirectoryConfigResponse -> String

showList :: [UpdateDirectoryConfigResponse] -> ShowS

NFData UpdateDirectoryConfigResponse

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

rnf :: UpdateDirectoryConfigResponse -> ()

Eq UpdateDirectoryConfigResponse

Defined in Amazonka.AppStream.UpdateDirectoryConfig

Methods

(==) :: UpdateDirectoryConfigResponse -> UpdateDirectoryConfigResponse -> Bool

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

type Rep UpdateDirectoryConfigResponse

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

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)

Information about the Directory Config object.

updateDirectoryConfigResponse_httpStatus :: Lens' UpdateDirectoryConfigResponse Int

The response's http status code.