domain_controllers

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

Overview

Name	domain_controllers
Type	Resource
Id	aws.ds.domain_controllers

Fields

The following fields are returned by SELECT queries:

describe_domain_controllers

Name	Datatype	Description
availability_zone	string	The Availability Zone where the domain controller is located.
directory_id	string	Identifier of the directory where the domain controller resides. (pattern: <code>^d-[0-9a-f]{10}$</code>)
dns_ip_addr	string	The IP address of the domain controller. (pattern: <code>^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$</code>)
dns_ipv_6_addr	string	The IPv6 address of the domain controller. (pattern: <code>^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]).){3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$</code>)
domain_controller_id	string	Identifies a specific domain controller in the directory. (pattern: <code>^dc-[0-9a-f]{10}$</code>)
launch_time	string (date-time)	Specifies when the domain controller was created.
status	string	The status of the domain controller. (Creating, Active, Impaired, Restoring, Deleting, Deleted, Failed, Updating)
status_last_updated_date_time	string (date-time)	The date and time that the status was last updated.
status_reason	string	A description of the domain controller state.
subnet_id	string	Identifier of the subnet in the VPC that contains the domain controller. (pattern: <code>^(subnet-[0-9a-f]{8}|subnet-[0-9a-f]{17})$</code>)
vpc_id	string	The identifier of the VPC that contains the domain controller. (pattern: <code>^(vpc-[0-9a-f]{8}|vpc-[0-9a-f]{17})$</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_domain_controllers	select	region		Provides information about any domain controllers in your directory.
update_number_of_domain_controllers	update	region, DirectoryId, DesiredNumber		Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

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_domain_controllers

Provides information about any domain controllers in your directory.

SELECT
availability_zone,
directory_id,
dns_ip_addr,
dns_ipv_6_addr,
domain_controller_id,
launch_time,
status,
status_last_updated_date_time,
status_reason,
subnet_id,
vpc_id
FROM aws.ds.domain_controllers
WHERE region = '{{ region }}' -- required
;

UPDATE examples

update_number_of_domain_controllers

Adds or removes domain controllers to or from the directory. Based on the difference between current value and new value (provided through this API call), domain controllers will be added or removed. It may take up to 45 minutes for any new domain controllers to become fully active once the requested number of domain controllers is updated. During this time, you cannot make another update request.

UPDATE aws.ds.domain_controllers
SET 
DirectoryId = '{{ DirectoryId }}',
DesiredNumber = {{ DesiredNumber }}
WHERE 
region = '{{ region }}' --required
AND DirectoryId = '{{ DirectoryId }}' --required
AND DesiredNumber = '{{ DesiredNumber }}' --required;