aws-cdk-lib.aws_appstream.CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty

CertificateBasedAuthPropertiesProperty Struct

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_appstream as appstream } from 'aws-cdk-lib';
const certificateBasedAuthPropertiesProperty: appstream.CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty = {
  certificateAuthorityArn: 'certificateAuthorityArn',
  status: 'status',
};

Properties

certificateAuthorityArn?optionalstringcertificate_authority_arn?optionalstrcertificateAuthorityArn?optionalStringCertificateAuthorityArn?optionalstringCertificateAuthorityArn?optional*string#

The ARN of the AWS Certificate Manager Private CA resource.

status?optionalstringstatus?optionalstrstatus?optionalStringStatus?optionalstringStatus?optional*string#

The status of the certificate-based authentication properties.

notes

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.