getDirectory

Retrieve information about an AWS WorkSpaces directory.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = Aws.Workspaces.GetDirectory.Invoke(new()
    {
        DirectoryId = "d-9067783251",
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/workspaces"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err = workspaces.LookupDirectory(ctx, &workspaces.LookupDirectoryArgs{
			DirectoryId: "d-9067783251",
		}, 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.workspaces.WorkspacesFunctions;
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 = WorkspacesFunctions.getDirectory(GetDirectoryArgs.builder()
            .directoryId("d-9067783251")
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.workspaces.get_directory(directory_id="d-9067783251")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = aws.workspaces.getDirectory({
    directoryId: "d-9067783251",
});
variables:
  example:
    fn::invoke:
      Function: aws:workspaces:getDirectory
      Arguments:
        directoryId: d-9067783251

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:workspaces/getDirectory:getDirectory
  arguments:
    # arguments dictionary

The following arguments are supported:

DirectoryId string

Directory identifier for registration in WorkSpaces service.

Tags Dictionary<string, string>

A map of tags assigned to the WorkSpaces directory.

DirectoryId string

Directory identifier for registration in WorkSpaces service.

Tags map[string]string

A map of tags assigned to the WorkSpaces directory.

directoryId String

Directory identifier for registration in WorkSpaces service.

tags Map<String,String>

A map of tags assigned to the WorkSpaces directory.

directoryId string

Directory identifier for registration in WorkSpaces service.

tags {[key: string]: string}

A map of tags assigned to the WorkSpaces directory.

directory_id str

Directory identifier for registration in WorkSpaces service.

tags Mapping[str, str]

A map of tags assigned to the WorkSpaces directory.

directoryId String

Directory identifier for registration in WorkSpaces service.

tags Map<String>

A map of tags assigned to the WorkSpaces directory.

getDirectory Result

The following output properties are available:

Alias string

Directory alias.

CustomerUserName string

User name for the service account.

DirectoryId string
DirectoryName string

Name of the directory.

DirectoryType string

Directory type.

DnsIpAddresses List<string>

IP addresses of the DNS servers for the directory.

IamRoleId string

Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

Id string

The provider-assigned unique ID for this managed resource.

IpGroupIds List<string>

Identifiers of the IP access control groups associated with the directory.

RegistrationCode string

Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

SelfServicePermissions List<Pulumi.Aws.Workspaces.Outputs.GetDirectorySelfServicePermission>

The permissions to enable or disable self-service capabilities.

SubnetIds List<string>

Identifiers of the subnets where the directory resides.

WorkspaceAccessProperties List<Pulumi.Aws.Workspaces.Outputs.GetDirectoryWorkspaceAccessProperty>

(Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.

WorkspaceCreationProperties List<Pulumi.Aws.Workspaces.Outputs.GetDirectoryWorkspaceCreationProperty>

The default properties that are used for creating WorkSpaces. Defined below.

WorkspaceSecurityGroupId string

The identifier of the security group that is assigned to new WorkSpaces. Defined below.

Tags Dictionary<string, string>

A map of tags assigned to the WorkSpaces directory.

Alias string

Directory alias.

CustomerUserName string

User name for the service account.

DirectoryId string
DirectoryName string

Name of the directory.

DirectoryType string

Directory type.

DnsIpAddresses []string

IP addresses of the DNS servers for the directory.

IamRoleId string

Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

Id string

The provider-assigned unique ID for this managed resource.

IpGroupIds []string

Identifiers of the IP access control groups associated with the directory.

RegistrationCode string

Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

SelfServicePermissions []GetDirectorySelfServicePermission

The permissions to enable or disable self-service capabilities.

SubnetIds []string

Identifiers of the subnets where the directory resides.

WorkspaceAccessProperties []GetDirectoryWorkspaceAccessProperty

(Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.

WorkspaceCreationProperties []GetDirectoryWorkspaceCreationProperty

The default properties that are used for creating WorkSpaces. Defined below.

WorkspaceSecurityGroupId string

The identifier of the security group that is assigned to new WorkSpaces. Defined below.

Tags map[string]string

A map of tags assigned to the WorkSpaces directory.

alias String

Directory alias.

customerUserName String

User name for the service account.

directoryId String
directoryName String

Name of the directory.

directoryType String

Directory type.

dnsIpAddresses List<String>

IP addresses of the DNS servers for the directory.

iamRoleId String

Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

id String

The provider-assigned unique ID for this managed resource.

ipGroupIds List<String>

Identifiers of the IP access control groups associated with the directory.

registrationCode String

Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

selfServicePermissions List<GetDirectorySelfServicePermission>

The permissions to enable or disable self-service capabilities.

subnetIds List<String>

Identifiers of the subnets where the directory resides.

workspaceAccessProperties List<GetDirectoryWorkspaceAccessProperty>

(Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.

workspaceCreationProperties List<GetDirectoryWorkspaceCreationProperty>

The default properties that are used for creating WorkSpaces. Defined below.

workspaceSecurityGroupId String

The identifier of the security group that is assigned to new WorkSpaces. Defined below.

tags Map<String,String>

A map of tags assigned to the WorkSpaces directory.

alias string

Directory alias.

customerUserName string

User name for the service account.

directoryId string
directoryName string

Name of the directory.

directoryType string

Directory type.

dnsIpAddresses string[]

IP addresses of the DNS servers for the directory.

iamRoleId string

Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

id string

The provider-assigned unique ID for this managed resource.

ipGroupIds string[]

Identifiers of the IP access control groups associated with the directory.

registrationCode string

Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

selfServicePermissions GetDirectorySelfServicePermission[]

The permissions to enable or disable self-service capabilities.

subnetIds string[]

Identifiers of the subnets where the directory resides.

workspaceAccessProperties GetDirectoryWorkspaceAccessProperty[]

(Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.

workspaceCreationProperties GetDirectoryWorkspaceCreationProperty[]

The default properties that are used for creating WorkSpaces. Defined below.

workspaceSecurityGroupId string

The identifier of the security group that is assigned to new WorkSpaces. Defined below.

tags {[key: string]: string}

A map of tags assigned to the WorkSpaces directory.

alias str

Directory alias.

customer_user_name str

User name for the service account.

directory_id str
directory_name str

Name of the directory.

directory_type str

Directory type.

dns_ip_addresses Sequence[str]

IP addresses of the DNS servers for the directory.

iam_role_id str

Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

id str

The provider-assigned unique ID for this managed resource.

ip_group_ids Sequence[str]

Identifiers of the IP access control groups associated with the directory.

registration_code str

Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

self_service_permissions Sequence[GetDirectorySelfServicePermission]

The permissions to enable or disable self-service capabilities.

subnet_ids Sequence[str]

Identifiers of the subnets where the directory resides.

workspace_access_properties Sequence[GetDirectoryWorkspaceAccessProperty]

(Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.

workspace_creation_properties Sequence[GetDirectoryWorkspaceCreationProperty]

The default properties that are used for creating WorkSpaces. Defined below.

workspace_security_group_id str

The identifier of the security group that is assigned to new WorkSpaces. Defined below.

tags Mapping[str, str]

A map of tags assigned to the WorkSpaces directory.

alias String

Directory alias.

customerUserName String

User name for the service account.

directoryId String
directoryName String

Name of the directory.

directoryType String

Directory type.

dnsIpAddresses List<String>

IP addresses of the DNS servers for the directory.

iamRoleId String

Identifier of the IAM role. This is the role that allows Amazon WorkSpaces to make calls to other services, such as Amazon EC2, on your behalf.

id String

The provider-assigned unique ID for this managed resource.

ipGroupIds List<String>

Identifiers of the IP access control groups associated with the directory.

registrationCode String

Registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

selfServicePermissions List<Property Map>

The permissions to enable or disable self-service capabilities.

subnetIds List<String>

Identifiers of the subnets where the directory resides.

workspaceAccessProperties List<Property Map>

(Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.

workspaceCreationProperties List<Property Map>

The default properties that are used for creating WorkSpaces. Defined below.

workspaceSecurityGroupId String

The identifier of the security group that is assigned to new WorkSpaces. Defined below.

tags Map<String>

A map of tags assigned to the WorkSpaces directory.

Supporting Types

GetDirectorySelfServicePermission

ChangeComputeType bool

Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.

IncreaseVolumeSize bool

Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.

RebuildWorkspace bool

Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.

RestartWorkspace bool

Whether WorkSpaces directory users can restart their workspace.

SwitchRunningMode bool

Whether WorkSpaces directory users can switch the running mode of their workspace.

ChangeComputeType bool

Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.

IncreaseVolumeSize bool

Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.

RebuildWorkspace bool

Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.

RestartWorkspace bool

Whether WorkSpaces directory users can restart their workspace.

SwitchRunningMode bool

Whether WorkSpaces directory users can switch the running mode of their workspace.

changeComputeType Boolean

Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.

increaseVolumeSize Boolean

Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.

rebuildWorkspace Boolean

Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.

restartWorkspace Boolean

Whether WorkSpaces directory users can restart their workspace.

switchRunningMode Boolean

Whether WorkSpaces directory users can switch the running mode of their workspace.

changeComputeType boolean

Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.

increaseVolumeSize boolean

Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.

rebuildWorkspace boolean

Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.

restartWorkspace boolean

Whether WorkSpaces directory users can restart their workspace.

switchRunningMode boolean

Whether WorkSpaces directory users can switch the running mode of their workspace.

change_compute_type bool

Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.

increase_volume_size bool

Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.

rebuild_workspace bool

Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.

restart_workspace bool

Whether WorkSpaces directory users can restart their workspace.

switch_running_mode bool

Whether WorkSpaces directory users can switch the running mode of their workspace.

changeComputeType Boolean

Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.

increaseVolumeSize Boolean

Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.

rebuildWorkspace Boolean

Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.

restartWorkspace Boolean

Whether WorkSpaces directory users can restart their workspace.

switchRunningMode Boolean

Whether WorkSpaces directory users can switch the running mode of their workspace.

GetDirectoryWorkspaceAccessProperty

DeviceTypeAndroid string

(Optional) Indicates whether users can use Android devices to access their WorkSpaces.

DeviceTypeChromeos string

(Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.

DeviceTypeIos string

(Optional) Indicates whether users can use iOS devices to access their WorkSpaces.

DeviceTypeLinux string

(Optional) Indicates whether users can use Linux clients to access their WorkSpaces.

DeviceTypeOsx string

(Optional) Indicates whether users can use macOS clients to access their WorkSpaces.

DeviceTypeWeb string

(Optional) Indicates whether users can access their WorkSpaces through a web browser.

DeviceTypeWindows string

(Optional) Indicates whether users can use Windows clients to access their WorkSpaces.

DeviceTypeZeroclient string

(Optional) Indicates whether users can use zero client devices to access their WorkSpaces.

DeviceTypeAndroid string

(Optional) Indicates whether users can use Android devices to access their WorkSpaces.

DeviceTypeChromeos string

(Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.

DeviceTypeIos string

(Optional) Indicates whether users can use iOS devices to access their WorkSpaces.

DeviceTypeLinux string

(Optional) Indicates whether users can use Linux clients to access their WorkSpaces.

DeviceTypeOsx string

(Optional) Indicates whether users can use macOS clients to access their WorkSpaces.

DeviceTypeWeb string

(Optional) Indicates whether users can access their WorkSpaces through a web browser.

DeviceTypeWindows string

(Optional) Indicates whether users can use Windows clients to access their WorkSpaces.

DeviceTypeZeroclient string

(Optional) Indicates whether users can use zero client devices to access their WorkSpaces.

deviceTypeAndroid String

(Optional) Indicates whether users can use Android devices to access their WorkSpaces.

deviceTypeChromeos String

(Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.

deviceTypeIos String

(Optional) Indicates whether users can use iOS devices to access their WorkSpaces.

deviceTypeLinux String

(Optional) Indicates whether users can use Linux clients to access their WorkSpaces.

deviceTypeOsx String

(Optional) Indicates whether users can use macOS clients to access their WorkSpaces.

deviceTypeWeb String

(Optional) Indicates whether users can access their WorkSpaces through a web browser.

deviceTypeWindows String

(Optional) Indicates whether users can use Windows clients to access their WorkSpaces.

deviceTypeZeroclient String

(Optional) Indicates whether users can use zero client devices to access their WorkSpaces.

deviceTypeAndroid string

(Optional) Indicates whether users can use Android devices to access their WorkSpaces.

deviceTypeChromeos string

(Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.

deviceTypeIos string

(Optional) Indicates whether users can use iOS devices to access their WorkSpaces.

deviceTypeLinux string

(Optional) Indicates whether users can use Linux clients to access their WorkSpaces.

deviceTypeOsx string

(Optional) Indicates whether users can use macOS clients to access their WorkSpaces.

deviceTypeWeb string

(Optional) Indicates whether users can access their WorkSpaces through a web browser.

deviceTypeWindows string

(Optional) Indicates whether users can use Windows clients to access their WorkSpaces.

deviceTypeZeroclient string

(Optional) Indicates whether users can use zero client devices to access their WorkSpaces.

device_type_android str

(Optional) Indicates whether users can use Android devices to access their WorkSpaces.

device_type_chromeos str

(Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.

device_type_ios str

(Optional) Indicates whether users can use iOS devices to access their WorkSpaces.

device_type_linux str

(Optional) Indicates whether users can use Linux clients to access their WorkSpaces.

device_type_osx str

(Optional) Indicates whether users can use macOS clients to access their WorkSpaces.

device_type_web str

(Optional) Indicates whether users can access their WorkSpaces through a web browser.

device_type_windows str

(Optional) Indicates whether users can use Windows clients to access their WorkSpaces.

device_type_zeroclient str

(Optional) Indicates whether users can use zero client devices to access their WorkSpaces.

deviceTypeAndroid String

(Optional) Indicates whether users can use Android devices to access their WorkSpaces.

deviceTypeChromeos String

(Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.

deviceTypeIos String

(Optional) Indicates whether users can use iOS devices to access their WorkSpaces.

deviceTypeLinux String

(Optional) Indicates whether users can use Linux clients to access their WorkSpaces.

deviceTypeOsx String

(Optional) Indicates whether users can use macOS clients to access their WorkSpaces.

deviceTypeWeb String

(Optional) Indicates whether users can access their WorkSpaces through a web browser.

deviceTypeWindows String

(Optional) Indicates whether users can use Windows clients to access their WorkSpaces.

deviceTypeZeroclient String

(Optional) Indicates whether users can use zero client devices to access their WorkSpaces.

GetDirectoryWorkspaceCreationProperty

CustomSecurityGroupId string

The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.

DefaultOu string

The default organizational unit (OU) for your WorkSpace directories.

EnableInternetAccess bool

Indicates whether internet access is enabled for your WorkSpaces.

EnableMaintenanceMode bool

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

UserEnabledAsLocalAdministrator bool

Indicates whether users are local administrators of their WorkSpaces.

CustomSecurityGroupId string

The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.

DefaultOu string

The default organizational unit (OU) for your WorkSpace directories.

EnableInternetAccess bool

Indicates whether internet access is enabled for your WorkSpaces.

EnableMaintenanceMode bool

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

UserEnabledAsLocalAdministrator bool

Indicates whether users are local administrators of their WorkSpaces.

customSecurityGroupId String

The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.

defaultOu String

The default organizational unit (OU) for your WorkSpace directories.

enableInternetAccess Boolean

Indicates whether internet access is enabled for your WorkSpaces.

enableMaintenanceMode Boolean

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

userEnabledAsLocalAdministrator Boolean

Indicates whether users are local administrators of their WorkSpaces.

customSecurityGroupId string

The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.

defaultOu string

The default organizational unit (OU) for your WorkSpace directories.

enableInternetAccess boolean

Indicates whether internet access is enabled for your WorkSpaces.

enableMaintenanceMode boolean

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

userEnabledAsLocalAdministrator boolean

Indicates whether users are local administrators of their WorkSpaces.

custom_security_group_id str

The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.

default_ou str

The default organizational unit (OU) for your WorkSpace directories.

enable_internet_access bool

Indicates whether internet access is enabled for your WorkSpaces.

enable_maintenance_mode bool

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

user_enabled_as_local_administrator bool

Indicates whether users are local administrators of their WorkSpaces.

customSecurityGroupId String

The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.

defaultOu String

The default organizational unit (OU) for your WorkSpace directories.

enableInternetAccess Boolean

Indicates whether internet access is enabled for your WorkSpaces.

enableMaintenanceMode Boolean

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

userEnabledAsLocalAdministrator Boolean

Indicates whether users are local administrators of their WorkSpaces.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.