1.204.0

interface CfnDirectoryConfigProps

LanguageType name
.NETAmazon.CDK.AWS.AppStream.CfnDirectoryConfigProps
Javasoftware.amazon.awscdk.services.appstream.CfnDirectoryConfigProps
Pythonaws_cdk.aws_appstream.CfnDirectoryConfigProps
TypeScript @aws-cdk/aws-appstream » CfnDirectoryConfigProps

Properties for defining a CfnDirectoryConfig.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as appstream from '@aws-cdk/aws-appstream';
const cfnDirectoryConfigProps: appstream.CfnDirectoryConfigProps = {
  directoryName: 'directoryName',
  organizationalUnitDistinguishedNames: ['organizationalUnitDistinguishedNames'],
  serviceAccountCredentials: {
    accountName: 'accountName',
    accountPassword: 'accountPassword',
  },

  // the properties below are optional
  certificateBasedAuthProperties: {
    certificateAuthorityArn: 'certificateAuthorityArn',
    status: 'status',
  },
};

Properties

NameTypeDescription
directoryNamestringThe fully qualified name of the directory (for example, corp.example.com).
organizationalUnitDistinguishedNamesstring[]The distinguished names of the organizational units for computer accounts.
serviceAccountCredentialsIResolvable | ServiceAccountCredentialsPropertyThe credentials for the service account used by the streaming instance to connect to the directory.
certificateBasedAuthProperties?IResolvable | CertificateBasedAuthPropertiesPropertyThe certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.

directoryName

Type: string

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

organizationalUnitDistinguishedNames

Type: string[]

The distinguished names of the organizational units for computer accounts.

serviceAccountCredentials

Type: IResolvable | ServiceAccountCredentialsProperty

The credentials for the service account used by the streaming instance to connect to the directory.

Do not use this parameter directly. Use ServiceAccountCredentials as an input parameter with noEcho as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .

certificateBasedAuthProperties?

Type: IResolvable | CertificateBasedAuthPropertiesProperty (optional)

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

← PreviousNext →