directory_data_access

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

Overview

Name	directory_data_access
Type	Resource
Id	aws.ds.directory_data_access

Fields

The following fields are returned by SELECT queries:

describe_directory_data_access

Name	Datatype	Description
data_access_status	string	The current status of data access through the Directory Service Data API. (Disabled, Disabling, Enabled, Enabling, Failed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_directory_data_access	select	region		Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.
disable_directory_data_access	exec	region, DirectoryId		Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
enable_directory_data_access	exec	region, DirectoryId		Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

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_data_access

Obtains status of directory data access enablement through the Directory Service Data API for the specified directory.

SELECT
data_access_status
FROM aws.ds.directory_data_access
WHERE region = '{{ region }}' -- required
;

Lifecycle Methods

disable_directory_data_access

Deactivates access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

EXEC aws.ds.directory_data_access.disable_directory_data_access 
@region='{{ region }}' --required 
@@json=
'{
"DirectoryId": "{{ DirectoryId }}"
}'
;

enable_directory_data_access

Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.

EXEC aws.ds.directory_data_access.enable_directory_data_access 
@region='{{ region }}' --required 
@@json=
'{
"DirectoryId": "{{ DirectoryId }}"
}'
;