directory_configs

Creates, updates, deletes or gets a directory_config resource or lists directory_configs in a region

Overview

Name	directory_configs
Type	Resource
Description	Resource Type definition for AWS::AppStream::DirectoryConfig
Id	aws.appstream.directory_configs

Fields

Name	Datatype	Description
organizational_unit_distinguished_names	array
service_account_credentials	object
directory_name	string
certificate_based_auth_properties	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DirectoryName, OrganizationalUnitDistinguishedNames, ServiceAccountCredentials, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all directory_configs in a region.

SELECT
region,
organizational_unit_distinguished_names,
service_account_credentials,
directory_name,
certificate_based_auth_properties
FROM aws.appstream.directory_configs
WHERE region = 'us-east-1';

Gets all properties from an individual directory_config.

SELECT
region,
organizational_unit_distinguished_names,
service_account_credentials,
directory_name,
certificate_based_auth_properties
FROM aws.appstream.directory_configs
WHERE region = 'us-east-1' AND data__Identifier = '<DirectoryName>';

INSERT example

Use the following StackQL query and manifest file to create a new directory_config resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.appstream.directory_configs (
 OrganizationalUnitDistinguishedNames,
 ServiceAccountCredentials,
 DirectoryName,
 region
)
SELECT 
'{{ OrganizationalUnitDistinguishedNames }}',
 '{{ ServiceAccountCredentials }}',
 '{{ DirectoryName }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: directory_config
    props:
      - name: OrganizationalUnitDistinguishedNames
        value:
          - '{{ OrganizationalUnitDistinguishedNames[0] }}'
      - name: ServiceAccountCredentials
        value:
          AccountName: '{{ AccountName }}'
          AccountPassword: '{{ AccountPassword }}'
      - name: DirectoryName
        value: '{{ DirectoryName }}'
      - name: CertificateBasedAuthProperties
        value:
          Status: '{{ Status }}'
          CertificateAuthorityArn: '{{ CertificateAuthorityArn }}'

DELETE example

/*+ delete */
DELETE FROM aws.appstream.directory_configs
WHERE data__Identifier = '<DirectoryName>'
AND region = 'us-east-1';

Permissions

To operate on the directory_configs resource, the following permissions are required:

Create

appstream:CreateDirectoryConfig,
appstream:DeleteDirectoryConfig,
appstream:DescribeDirectoryConfigs,
appstream:UpdateDirectoryConfig,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

Update

appstream:CreateDirectoryConfig,
appstream:DeleteDirectoryConfig,
appstream:DescribeDirectoryConfigs,
appstream:UpdateDirectoryConfig,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

Read

appstream:CreateDirectoryConfig,
appstream:DeleteDirectoryConfig,
appstream:DescribeDirectoryConfigs,
appstream:UpdateDirectoryConfig,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

Delete

appstream:CreateDirectoryConfig,
appstream:DeleteDirectoryConfig,
appstream:DescribeDirectoryConfigs,
appstream:UpdateDirectoryConfig,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus

List

appstream:CreateDirectoryConfig,
appstream:DeleteDirectoryConfig,
appstream:DescribeDirectoryConfigs,
appstream:UpdateDirectoryConfig,
iam:CreateServiceLinkedRole,
iam:DeleteServiceLinkedRole,
iam:GetServiceLinkedRoleDeletionStatus