AWS::AppStream::DirectoryConfig - Amazon CloudFormation
SyntaxPropertiesSee also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::AppStream::DirectoryConfig

The AWS::AppStream::DirectoryConfig resource specifies the configuration information required to join Amazon AppStream 2.0 fleets and image builders to Microsoft Active Directory domains.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::AppStream::DirectoryConfig",
  "Properties" : {
      "CertificateBasedAuthProperties" : CertificateBasedAuthProperties,
      "DirectoryName" : String,
      "OrganizationalUnitDistinguishedNames" : [ String, ... ],
      "ServiceAccountCredentials" : ServiceAccountCredentials
    }
}

Properties

CertificateBasedAuthProperties

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

Required: No

Type: CertificateBasedAuthProperties

Update requires: No interruption

DirectoryName

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

Required: Yes

Type: String

Update requires: Replacement

OrganizationalUnitDistinguishedNames

The distinguished names of the organizational units for computer accounts.

Required: Yes

Type: Array of String

Update requires: No interruption

ServiceAccountCredentials

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.

Required: Yes

Type: ServiceAccountCredentials

Update requires: No interruption

See also