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. For more information, see CreateDirectoryConfig in the Amazon AppStream 2.0 API Reference.

Syntax

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

JSON


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

YAML


Type: "AWS::AppStream::DirectoryConfig"
Properties:
  OrganizationalUnitDistinguishedNames: 
    - String
  ServiceAccountCredentials: ServiceAccountCredentials
  DirectoryName: String

Properties

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: List of String values

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

AWS::AppStream::DirectoryConfig

Syntax

JSON

YAML

Properties

See Also