Skip to content

Data Source: awsDirectoryServiceDirectory

Get attributes of AWS Directory Service directory (SimpleAD, Managed AD, AD Connector). It's especially useful to refer AWS Managed AD or on-premise AD in AD Connector configuration.

Example Usage

/*Provider bindings are generated by running cdktf get.
See https://cdk.tf/provider-generation for more details.*/
import * as aws from "./.gen/providers/aws";
new aws.dataAwsDirectoryServiceDirectory.DataAwsDirectoryServiceDirectory(
  this,
  "example",
  {
    directoryId: "${aws_directory_service_directory.main.id}",
  }
);

Argument Reference

  • directoryId - (Required) ID of the directory.

Attributes Reference

  • type - Directory type (simpleAd, adConnector or microsoftAd).
  • edition - (for microsoftAd) Microsoft AD edition (standard or enterprise).
  • name - Fully qualified name for the directory/connector.
  • password - Password for the directory administrator or connector user.
  • size - (for simpleAd and adConnector) Size of the directory/connector (small or large).
  • alias - Alias for the directory/connector, such as d991708B282AwsappsCom.
  • description - Textual description for the directory/connector.
  • shortName - Short name of the directory/connector, such as corp.
  • enableSso - Directory/connector single-sign on status.
  • accessUrl - Access URL for the directory/connector, such as http://alias.awsapps.com.
  • dnsIpAddresses - List of IP addresses of the DNS servers for the directory/connector.
  • securityGroupId - ID of the security group created by the directory/connector.
  • tags – A map of tags assigned to the directory/connector.

vpcSettings (for simpleAd and microsoftAd) is also exported with the following attributes:

  • subnetIds - Identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).
  • vpcId - ID of the VPC that the directory is in.

connectSettings (for adConnector) is also exported with the following attributes:

  • connectIps - IP addresses of the AD Connector servers.
  • customerUsername - Username corresponding to the password provided.
  • customerDnsIps - DNS IP addresses of the domain to connect to.
  • subnetIds - Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
  • vpcId - ID of the VPC that the connector is in.

radiusSettings is also exported with the following attributes:

  • authenticationProtocol - The protocol specified for your RADIUS endpoints.
  • displayLabel - Display label.
  • radiusPort - Port that your RADIUS server is using for communications.
  • radiusRetries - Maximum number of times that communication with the RADIUS server is attempted.
  • radiusServers - Set of strings that contains the fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.
  • radiusTimeout - Amount of time, in seconds, to wait for the RADIUS server to respond.
  • useSameUsername - Not currently used.