directory_configs

Creates, updates, deletes, gets or lists a directory_configs resource.

Overview

Name	directory_configs
Type	Resource
Id	aws.appstream.directory_configs

Fields

The following fields are returned by SELECT queries:

describe_directory_configs

Name	Datatype	Description
certificate_based_auth_properties	object	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.
created_time	string (date-time)	The time the directory configuration was created.
directory_name	string	The fully qualified name of the directory (for example, corp.example.com).
organizational_unit_distinguished_names	array	The distinguished names of the organizational units for computer accounts.
service_account_credentials	object	The credentials for the service account used by the fleet or image builder to connect to the directory.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_directory_configs	select	region		Retrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
create_directory_config	insert	region, DirectoryName, OrganizationalUnitDistinguishedNames		Creates a Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
update_directory_config	update	region, DirectoryName		Updates the specified Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
delete_directory_config	delete	region		Deletes the specified Directory Config object from WorkSpaces Applications. This object includes the information required to join streaming instances to an Active Directory domain.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_directory_configs

Retrieves a list that describes one or more specified Directory Config objects for WorkSpaces Applications, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.

SELECT
certificate_based_auth_properties,
created_time,
directory_name,
organizational_unit_distinguished_names,
service_account_credentials
FROM aws.appstream.directory_configs
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_directory_config

Creates a Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

INSERT INTO aws.appstream.directory_configs (
DirectoryName,
OrganizationalUnitDistinguishedNames,
ServiceAccountCredentials,
CertificateBasedAuthProperties,
region
)
SELECT 
'{{ DirectoryName }}' /* required */,
'{{ OrganizationalUnitDistinguishedNames }}' /* required */,
'{{ ServiceAccountCredentials }}',
'{{ CertificateBasedAuthProperties }}',
'{{ region }}'
RETURNING
directory_config
;

Manifest

# Description fields are for documentation purposes
- name: directory_configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the directory_configs resource.
  - name: DirectoryName
    value: "{{ DirectoryName }}"
    description: |
      The fully qualified name of the directory (for example, corp.example.com).
  - name: OrganizationalUnitDistinguishedNames
    value:
      - "{{ OrganizationalUnitDistinguishedNames }}"
    description: |
      The distinguished names of the organizational units for computer accounts.
  - name: ServiceAccountCredentials
    description: |
      The credentials for the service account used by the fleet or image builder to connect to the directory.
    value:
      AccountName: "{{ AccountName }}"
      AccountPassword: "{{ AccountPassword }}"
  - name: CertificateBasedAuthProperties
    description: |
      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.
    value:
      Status: "{{ Status }}"
      CertificateAuthorityArn: "{{ CertificateAuthorityArn }}"

UPDATE examples

update_directory_config

Updates the specified Directory Config object in WorkSpaces Applications. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

UPDATE aws.appstream.directory_configs
SET 
DirectoryName = '{{ DirectoryName }}',
OrganizationalUnitDistinguishedNames = '{{ OrganizationalUnitDistinguishedNames }}',
ServiceAccountCredentials = '{{ ServiceAccountCredentials }}',
CertificateBasedAuthProperties = '{{ CertificateBasedAuthProperties }}'
WHERE 
region = '{{ region }}' --required
AND DirectoryName = '{{ DirectoryName }}' --required
RETURNING
directory_config;

DELETE examples

delete_directory_config

Deletes the specified Directory Config object from WorkSpaces Applications. This object includes the information required to join streaming instances to an Active Directory domain.

DELETE FROM aws.appstream.directory_configs
WHERE region = '{{ region }}' --required
;