client_authentication_settings

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

Overview

Name	client_authentication_settings
Type	Resource
Id	aws.ds.client_authentication_settings

Fields

The following fields are returned by SELECT queries:

describe_client_authentication_settings

Name	Datatype	Description
last_updated_date_time	string (date-time)	The date and time when the status of the client authentication type was last updated.
status	string	Whether the client authentication type is enabled or disabled for the specified directory. (Enabled, Disabled)
type	string	The type of client authentication for the specified directory. If no type is specified, a list of all client authentication types that are supported for the directory is retrieved. (SmartCard, SmartCardOrPassword)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_client_authentication_settings	select	region		Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.

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_client_authentication_settings

Retrieves information about the type of client authentication for the specified directory, if the type is specified. If no type is specified, information about all client authentication types that are supported for the specified directory is retrieved. Currently, only SmartCard is supported.

SELECT
last_updated_date_time,
status,
type
FROM aws.ds.client_authentication_settings
WHERE region = '{{ region }}' -- required
;