Try AWS Native preview for resources not in the classic version.
aws.directoryservice.getDirectory
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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 System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.DirectoryService.GetDirectory.Invoke(new()
{
DirectoryId = aws_directory_service_directory.Main.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/directoryservice"
"github.com/pulumi/pulumi/sdk/v3/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
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.directoryservice.DirectoryserviceFunctions;
import com.pulumi.aws.directoryservice.inputs.GetDirectoryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = DirectoryserviceFunctions.getDirectory(GetDirectoryArgs.builder()
.directoryId(aws_directory_service_directory.main().id())
.build());
}
}
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.directoryservice.getDirectory({
directoryId: aws_directory_service_directory.main.id,
});
variables:
example:
fn::invoke:
Function: aws:directoryservice:getDirectory
Arguments:
directoryId: ${aws_directory_service_directory.main.id}
Using getDirectory
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getDirectory(args: GetDirectoryArgs, opts?: InvokeOptions): Promise<GetDirectoryResult>
function getDirectoryOutput(args: GetDirectoryOutputArgs, opts?: InvokeOptions): Output<GetDirectoryResult>
def get_directory(directory_id: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
opts: Optional[InvokeOptions] = None) -> GetDirectoryResult
def get_directory_output(directory_id: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetDirectoryResult]
func LookupDirectory(ctx *Context, args *LookupDirectoryArgs, opts ...InvokeOption) (*LookupDirectoryResult, error)
func LookupDirectoryOutput(ctx *Context, args *LookupDirectoryOutputArgs, opts ...InvokeOption) LookupDirectoryResultOutput
> Note: This function is named LookupDirectory
in the Go SDK.
public static class GetDirectory
{
public static Task<GetDirectoryResult> InvokeAsync(GetDirectoryArgs args, InvokeOptions? opts = null)
public static Output<GetDirectoryResult> Invoke(GetDirectoryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDirectoryResult> getDirectory(GetDirectoryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:directoryservice/getDirectory:getDirectory
arguments:
# arguments dictionary
The following arguments are supported:
- Directory
Id string ID of the directory.
- Dictionary<string, string>
A map of tags assigned to the directory/connector.
- Directory
Id string ID of the directory.
- map[string]string
A map of tags assigned to the directory/connector.
- directory
Id String ID of the directory.
- Map<String,String>
A map of tags assigned to the directory/connector.
- directory
Id string ID of the directory.
- {[key: string]: string}
A map of tags assigned to the directory/connector.
- directory_
id str ID of the directory.
- Mapping[str, str]
A map of tags assigned to the directory/connector.
- directory
Id String ID of the directory.
- Map<String>
A map of tags assigned to the directory/connector.
getDirectory Result
The following output properties are available:
- Access
Url string Access URL for the directory/connector, such as http://alias.awsapps.com.
- Alias string
Alias for the directory/connector, such as
d-991708b282.awsapps.com
.- Connect
Settings List<GetDirectory Connect Setting> - Description string
Textual description for the directory/connector.
- Directory
Id string - Dns
Ip List<string>Addresses List of IP addresses of the DNS servers for the directory/connector.
- Edition string
(for
MicrosoftAD
) Microsoft AD edition (Standard
orEnterprise
).- Enable
Sso bool Directory/connector single-sign on status.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
Fully qualified name for the directory/connector.
- Radius
Settings List<GetDirectory Radius Setting> - Security
Group stringId ID of the security group created by the directory/connector.
- Short
Name string Short name of the directory/connector, such as
CORP
.- Size string
(for
SimpleAD
andADConnector
) Size of the directory/connector (Small
orLarge
).- Dictionary<string, string>
A map of tags assigned to the directory/connector.
- Type string
Directory type (
SimpleAD
,ADConnector
orMicrosoftAD
).- Vpc
Settings List<GetDirectory Vpc Setting>
- Access
Url string Access URL for the directory/connector, such as http://alias.awsapps.com.
- Alias string
Alias for the directory/connector, such as
d-991708b282.awsapps.com
.- Connect
Settings []GetDirectory Connect Setting - Description string
Textual description for the directory/connector.
- Directory
Id string - Dns
Ip []stringAddresses List of IP addresses of the DNS servers for the directory/connector.
- Edition string
(for
MicrosoftAD
) Microsoft AD edition (Standard
orEnterprise
).- Enable
Sso bool Directory/connector single-sign on status.
- Id string
The provider-assigned unique ID for this managed resource.
- Name string
Fully qualified name for the directory/connector.
- Radius
Settings []GetDirectory Radius Setting - Security
Group stringId ID of the security group created by the directory/connector.
- Short
Name string Short name of the directory/connector, such as
CORP
.- Size string
(for
SimpleAD
andADConnector
) Size of the directory/connector (Small
orLarge
).- map[string]string
A map of tags assigned to the directory/connector.
- Type string
Directory type (
SimpleAD
,ADConnector
orMicrosoftAD
).- Vpc
Settings []GetDirectory Vpc Setting
- access
Url String Access URL for the directory/connector, such as http://alias.awsapps.com.
- alias String
Alias for the directory/connector, such as
d-991708b282.awsapps.com
.- connect
Settings List<GetDirectory Connect Setting> - description String
Textual description for the directory/connector.
- directory
Id String - dns
Ip List<String>Addresses List of IP addresses of the DNS servers for the directory/connector.
- edition String
(for
MicrosoftAD
) Microsoft AD edition (Standard
orEnterprise
).- enable
Sso Boolean Directory/connector single-sign on status.
- id String
The provider-assigned unique ID for this managed resource.
- name String
Fully qualified name for the directory/connector.
- radius
Settings List<GetDirectory Radius Setting> - security
Group StringId ID of the security group created by the directory/connector.
- short
Name String Short name of the directory/connector, such as
CORP
.- size String
(for
SimpleAD
andADConnector
) Size of the directory/connector (Small
orLarge
).- Map<String,String>
A map of tags assigned to the directory/connector.
- type String
Directory type (
SimpleAD
,ADConnector
orMicrosoftAD
).- vpc
Settings List<GetDirectory Vpc Setting>
- access
Url string Access URL for the directory/connector, such as http://alias.awsapps.com.
- alias string
Alias for the directory/connector, such as
d-991708b282.awsapps.com
.- connect
Settings GetDirectory Connect Setting[] - description string
Textual description for the directory/connector.
- directory
Id string - dns
Ip string[]Addresses List of IP addresses of the DNS servers for the directory/connector.
- edition string
(for
MicrosoftAD
) Microsoft AD edition (Standard
orEnterprise
).- enable
Sso boolean Directory/connector single-sign on status.
- id string
The provider-assigned unique ID for this managed resource.
- name string
Fully qualified name for the directory/connector.
- radius
Settings GetDirectory Radius Setting[] - security
Group stringId ID of the security group created by the directory/connector.
- short
Name string Short name of the directory/connector, such as
CORP
.- size string
(for
SimpleAD
andADConnector
) Size of the directory/connector (Small
orLarge
).- {[key: string]: string}
A map of tags assigned to the directory/connector.
- type string
Directory type (
SimpleAD
,ADConnector
orMicrosoftAD
).- vpc
Settings GetDirectory Vpc Setting[]
- access_
url str Access URL for the directory/connector, such as http://alias.awsapps.com.
- alias str
Alias for the directory/connector, such as
d-991708b282.awsapps.com
.- connect_
settings Sequence[GetDirectory Connect Setting] - description str
Textual description for the directory/connector.
- directory_
id str - dns_
ip_ Sequence[str]addresses List of IP addresses of the DNS servers for the directory/connector.
- edition str
(for
MicrosoftAD
) Microsoft AD edition (Standard
orEnterprise
).- enable_
sso bool Directory/connector single-sign on status.
- id str
The provider-assigned unique ID for this managed resource.
- name str
Fully qualified name for the directory/connector.
- radius_
settings Sequence[GetDirectory Radius Setting] - security_
group_ strid ID of the security group created by the directory/connector.
- short_
name str Short name of the directory/connector, such as
CORP
.- size str
(for
SimpleAD
andADConnector
) Size of the directory/connector (Small
orLarge
).- Mapping[str, str]
A map of tags assigned to the directory/connector.
- type str
Directory type (
SimpleAD
,ADConnector
orMicrosoftAD
).- vpc_
settings Sequence[GetDirectory Vpc Setting]
- access
Url String Access URL for the directory/connector, such as http://alias.awsapps.com.
- alias String
Alias for the directory/connector, such as
d-991708b282.awsapps.com
.- connect
Settings List<Property Map> - description String
Textual description for the directory/connector.
- directory
Id String - dns
Ip List<String>Addresses List of IP addresses of the DNS servers for the directory/connector.
- edition String
(for
MicrosoftAD
) Microsoft AD edition (Standard
orEnterprise
).- enable
Sso Boolean Directory/connector single-sign on status.
- id String
The provider-assigned unique ID for this managed resource.
- name String
Fully qualified name for the directory/connector.
- radius
Settings List<Property Map> - security
Group StringId ID of the security group created by the directory/connector.
- short
Name String Short name of the directory/connector, such as
CORP
.- size String
(for
SimpleAD
andADConnector
) Size of the directory/connector (Small
orLarge
).- Map<String>
A map of tags assigned to the directory/connector.
- type String
Directory type (
SimpleAD
,ADConnector
orMicrosoftAD
).- vpc
Settings List<Property Map>
Supporting Types
GetDirectoryConnectSetting
- Availability
Zones List<string> - Connect
Ips List<string> IP addresses of the AD Connector servers.
- Customer
Dns List<string>Ips DNS IP addresses of the domain to connect to.
- Customer
Username string Username corresponding to the password provided.
- Subnet
Ids List<string> Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- Vpc
Id string ID of the VPC that the connector is in.
- Availability
Zones []string - Connect
Ips []string IP addresses of the AD Connector servers.
- Customer
Dns []stringIps DNS IP addresses of the domain to connect to.
- Customer
Username string Username corresponding to the password provided.
- Subnet
Ids []string Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- Vpc
Id string ID of the VPC that the connector is in.
- availability
Zones List<String> - connect
Ips List<String> IP addresses of the AD Connector servers.
- customer
Dns List<String>Ips DNS IP addresses of the domain to connect to.
- customer
Username String Username corresponding to the password provided.
- subnet
Ids List<String> Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc
Id String ID of the VPC that the connector is in.
- availability
Zones string[] - connect
Ips string[] IP addresses of the AD Connector servers.
- customer
Dns string[]Ips DNS IP addresses of the domain to connect to.
- customer
Username string Username corresponding to the password provided.
- subnet
Ids string[] Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc
Id string ID of the VPC that the connector is in.
- availability_
zones Sequence[str] - connect_
ips Sequence[str] IP addresses of the AD Connector servers.
- customer_
dns_ Sequence[str]ips DNS IP addresses of the domain to connect to.
- customer_
username str Username corresponding to the password provided.
- subnet_
ids Sequence[str] Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc_
id str ID of the VPC that the connector is in.
- availability
Zones List<String> - connect
Ips List<String> IP addresses of the AD Connector servers.
- customer
Dns List<String>Ips DNS IP addresses of the domain to connect to.
- customer
Username String Username corresponding to the password provided.
- subnet
Ids List<String> Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc
Id String ID of the VPC that the connector is in.
GetDirectoryRadiusSetting
- Authentication
Protocol string The protocol specified for your RADIUS endpoints.
- Display
Label string Display label.
- Radius
Port int Port that your RADIUS server is using for communications.
- Radius
Retries int Maximum number of times that communication with the RADIUS server is attempted.
- Radius
Servers List<string> 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.
- Radius
Timeout int Amount of time, in seconds, to wait for the RADIUS server to respond.
- Use
Same boolUsername Not currently used.
- Authentication
Protocol string The protocol specified for your RADIUS endpoints.
- Display
Label string Display label.
- Radius
Port int Port that your RADIUS server is using for communications.
- Radius
Retries int Maximum number of times that communication with the RADIUS server is attempted.
- Radius
Servers []string 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.
- Radius
Timeout int Amount of time, in seconds, to wait for the RADIUS server to respond.
- Use
Same boolUsername Not currently used.
- authentication
Protocol String The protocol specified for your RADIUS endpoints.
- display
Label String Display label.
- radius
Port Integer Port that your RADIUS server is using for communications.
- radius
Retries Integer Maximum number of times that communication with the RADIUS server is attempted.
- radius
Servers List<String> 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.
- radius
Timeout Integer Amount of time, in seconds, to wait for the RADIUS server to respond.
- use
Same BooleanUsername Not currently used.
- authentication
Protocol string The protocol specified for your RADIUS endpoints.
- display
Label string Display label.
- radius
Port number Port that your RADIUS server is using for communications.
- radius
Retries number Maximum number of times that communication with the RADIUS server is attempted.
- radius
Servers string[] 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.
- radius
Timeout number Amount of time, in seconds, to wait for the RADIUS server to respond.
- use
Same booleanUsername Not currently used.
- authentication_
protocol str The protocol specified for your RADIUS endpoints.
- display_
label str Display label.
- radius_
port int Port that your RADIUS server is using for communications.
- radius_
retries int Maximum number of times that communication with the RADIUS server is attempted.
- radius_
servers Sequence[str] 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.
- radius_
timeout int Amount of time, in seconds, to wait for the RADIUS server to respond.
- use_
same_ boolusername Not currently used.
- authentication
Protocol String The protocol specified for your RADIUS endpoints.
- display
Label String Display label.
- radius
Port Number Port that your RADIUS server is using for communications.
- radius
Retries Number Maximum number of times that communication with the RADIUS server is attempted.
- radius
Servers List<String> 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.
- radius
Timeout Number Amount of time, in seconds, to wait for the RADIUS server to respond.
- use
Same BooleanUsername Not currently used.
GetDirectoryVpcSetting
- Availability
Zones List<string> - Subnet
Ids List<string> Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- Vpc
Id string ID of the VPC that the connector is in.
- Availability
Zones []string - Subnet
Ids []string Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- Vpc
Id string ID of the VPC that the connector is in.
- availability
Zones List<String> - subnet
Ids List<String> Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc
Id String ID of the VPC that the connector is in.
- availability
Zones string[] - subnet
Ids string[] Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc
Id string ID of the VPC that the connector is in.
- availability_
zones Sequence[str] - subnet_
ids Sequence[str] Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc_
id str ID of the VPC that the connector is in.
- availability
Zones List<String> - subnet
Ids List<String> Identifiers of the subnets for the connector servers (2 subnets in 2 different AZs).
- vpc
Id String ID of the VPC that the connector is in.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.
Try AWS Native preview for resources not in the classic version.