settings

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

Overview

Name	settings
Type	Resource
Id	aws.ds.settings

Fields

The following fields are returned by SELECT queries:

describe_settings

Name	Datatype	Description
directory_id	string	The identifier of the directory. (pattern: <code>^d-[0-9a-f]{10}$</code>)
next_token	string	If not null, token that indicates that more results are available. Pass this value for the NextToken parameter in a subsequent call to DescribeSettings to retrieve the next set of items.
setting_entries	array	The list of SettingEntry objects that were retrieved. It is possible that this list contains less than the number of items specified in the Limit member of the request. This occurs if there are less than the requested number of items left to retrieve, or if the limitations of the operation have been exceeded.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_settings	select	region		Retrieves information about the configurable settings for the specified directory.
update_settings	update	region, DirectoryId, Settings		Updates the configurable settings for the specified directory.

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_settings

Retrieves information about the configurable settings for the specified directory.

SELECT
directory_id,
next_token,
setting_entries
FROM aws.ds.settings
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_settings

Updates the configurable settings for the specified directory.

UPDATE aws.ds.settings
SET 
DirectoryId = '{{ DirectoryId }}',
Settings = '{{ Settings }}'
WHERE 
region = '{{ region }}' --required
AND DirectoryId = '{{ DirectoryId }}' --required
AND Settings = '{{ Settings }}' --required
RETURNING
directory_id;