GetDirectory

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

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = Output.Create(Aws.DirectoryService.GetDirectory.InvokeAsync(new Aws.DirectoryService.GetDirectoryArgs
        {
            DirectoryId = aws_directory_service_directory.Main.Id,
        }));
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/directoryservice"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := directoryservice.LookupDirectory(ctx, &directoryservice.LookupDirectoryArgs{
            DirectoryId: aws_directory_service_directory.Main.Id,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.directoryservice.get_directory(directory_id=aws_directory_service_directory["main"]["id"])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws_directory_service_directory_main.id.apply(id => aws.directoryservice.getDirectory({
    directoryId: id,
}, { async: true }));

Using GetDirectory

function getDirectory(args: GetDirectoryArgs, opts?: InvokeOptions): Promise<GetDirectoryResult>

function  get_directory(directory_id=None, tags=None, opts=None)

func LookupDirectory(ctx *Context, args *LookupDirectoryArgs, opts ...InvokeOption) (*LookupDirectoryResult, error)

Note: This function is named LookupDirectory in the Go SDK.

public static class GetDirectory {
    public static Task<GetDirectoryResult> InvokeAsync(GetDirectoryArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

DirectoryId string: The ID of the directory.
Tags Dictionary<string, string>: A map of tags assigned to the directory/connector.

DirectoryId string: The ID of the directory.
Tags map[string]string: A map of tags assigned to the directory/connector.

directoryId string: The ID of the directory.
tags {[key: string]: string}: A map of tags assigned to the directory/connector.

directory_id str: The ID of the directory.
tags Dict[str, str]: A map of tags assigned to the directory/connector.

GetDirectory Result

The following output properties are available:

AccessUrl string: The access URL for the directory/connector, such as http://alias.awsapps.com.
Alias string: The alias for the directory/connector, such as d-991708b282.awsapps.com.
ConnectSettings List<GetDirectoryConnectSetting>
Description string: A textual description for the directory/connector.
DirectoryId string
DnsIpAddresses List<string>: A list of IP addresses of the DNS servers for the directory/connector.
Edition string: (for MicrosoftAD) The Microsoft AD edition (Standard or Enterprise).
EnableSso bool: The directory/connector single-sign on status.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The fully qualified name for the directory/connector.
SecurityGroupId string: The ID of the security group created by the directory/connector.
ShortName string: The short name of the directory/connector, such as CORP.
Size string: (for SimpleAD and ADConnector) The size of the directory/connector (Small or Large).
Type string: The directory type (SimpleAD, ADConnector or MicrosoftAD).
VpcSettings List<GetDirectoryVpcSetting>
Tags Dictionary<string, string>: A map of tags assigned to the directory/connector.

AccessUrl string: The access URL for the directory/connector, such as http://alias.awsapps.com.
Alias string: The alias for the directory/connector, such as d-991708b282.awsapps.com.
ConnectSettings []GetDirectoryConnectSetting
Description string: A textual description for the directory/connector.
DirectoryId string
DnsIpAddresses []string: A list of IP addresses of the DNS servers for the directory/connector.
Edition string: (for MicrosoftAD) The Microsoft AD edition (Standard or Enterprise).
EnableSso bool: The directory/connector single-sign on status.
Id string: The provider-assigned unique ID for this managed resource.
Name string: The fully qualified name for the directory/connector.
SecurityGroupId string: The ID of the security group created by the directory/connector.
ShortName string: The short name of the directory/connector, such as CORP.
Size string: (for SimpleAD and ADConnector) The size of the directory/connector (Small or Large).
Type string: The directory type (SimpleAD, ADConnector or MicrosoftAD).
VpcSettings []GetDirectoryVpcSetting
Tags map[string]string: A map of tags assigned to the directory/connector.

accessUrl string: The access URL for the directory/connector, such as http://alias.awsapps.com.
alias string: The alias for the directory/connector, such as d-991708b282.awsapps.com.
connectSettings GetDirectoryConnectSetting[]
description string: A textual description for the directory/connector.
directoryId string
dnsIpAddresses string[]: A list of IP addresses of the DNS servers for the directory/connector.
edition string: (for MicrosoftAD) The Microsoft AD edition (Standard or Enterprise).
enableSso boolean: The directory/connector single-sign on status.
id string: The provider-assigned unique ID for this managed resource.
name string: The fully qualified name for the directory/connector.
securityGroupId string: The ID of the security group created by the directory/connector.
shortName string: The short name of the directory/connector, such as CORP.
size string: (for SimpleAD and ADConnector) The size of the directory/connector (Small or Large).
type string: The directory type (SimpleAD, ADConnector or MicrosoftAD).
vpcSettings GetDirectoryVpcSetting[]
tags {[key: string]: string}: A map of tags assigned to the directory/connector.

access_url str: The access URL for the directory/connector, such as http://alias.awsapps.com.
alias str: The alias for the directory/connector, such as d-991708b282.awsapps.com.
connect_settings List[GetDirectoryConnectSetting]
description str: A textual description for the directory/connector.
directory_id str
dns_ip_addresses List[str]: A list of IP addresses of the DNS servers for the directory/connector.
edition str: (for MicrosoftAD) The Microsoft AD edition (Standard or Enterprise).
enable_sso bool: The directory/connector single-sign on status.
id str: The provider-assigned unique ID for this managed resource.
name str: The fully qualified name for the directory/connector.
security_group_id str: The ID of the security group created by the directory/connector.
short_name str: The short name of the directory/connector, such as CORP.
size str: (for SimpleAD and ADConnector) The size of the directory/connector (Small or Large).
type str: The directory type (SimpleAD, ADConnector or MicrosoftAD).
vpc_settings List[GetDirectoryVpcSetting]
tags Dict[str, str]: A map of tags assigned to the directory/connector.

Supporting Types

GetDirectoryConnectSetting

See the output API doc for this type.

AvailabilityZones List<string>
ConnectIps List<string>: The IP addresses of the AD Connector servers.
CustomerDnsIps List<string>: The DNS IP addresses of the domain to connect to.
CustomerUsername string: The username corresponding to the password provided.
SubnetIds List<string>: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
VpcId string: The ID of the VPC that the connector is in.

AvailabilityZones []string
ConnectIps []string: The IP addresses of the AD Connector servers.
CustomerDnsIps []string: The DNS IP addresses of the domain to connect to.
CustomerUsername string: The username corresponding to the password provided.
SubnetIds []string: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
VpcId string: The ID of the VPC that the connector is in.

availabilityZones string[]
connectIps string[]: The IP addresses of the AD Connector servers.
customerDnsIps string[]: The DNS IP addresses of the domain to connect to.
customerUsername string: The username corresponding to the password provided.
subnetIds string[]: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
vpcId string: The ID of the VPC that the connector is in.

availability_zones List[str]
connectIps List[str]: The IP addresses of the AD Connector servers.
customerDnsIps List[str]: The DNS IP addresses of the domain to connect to.
customerUsername str: The username corresponding to the password provided.
subnet_ids List[str]: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
vpc_id str: The ID of the VPC that the connector is in.

GetDirectoryVpcSetting

See the output API doc for this type.

AvailabilityZones List<string>
SubnetIds List<string>: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
VpcId string: The ID of the VPC that the connector is in.

AvailabilityZones []string
SubnetIds []string: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
VpcId string: The ID of the VPC that the connector is in.

availabilityZones string[]
subnetIds string[]: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
vpcId string: The ID of the VPC that the connector is in.

availability_zones List[str]
subnet_ids List[str]: The identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
vpc_id str: The ID of the VPC that the connector is in.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud