aws.workspaces.getDirectory
Explore with Pulumi AI
Retrieve information about an AWS WorkSpaces directory.
Example Usage
using System.Collections.Generic;
using System.Linq;
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.workspaces.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:
- Directory
Id string Directory identifier for registration in WorkSpaces service.
- Dictionary<string, string>
A map of tags assigned to the WorkSpaces directory.
- Directory
Id string Directory identifier for registration in WorkSpaces service.
- map[string]string
A map of tags assigned to the WorkSpaces directory.
- directory
Id String Directory identifier for registration in WorkSpaces service.
- Map<String,String>
A map of tags assigned to the WorkSpaces directory.
- directory
Id string Directory identifier for registration in WorkSpaces service.
- {[key: string]: string}
A map of tags assigned to the WorkSpaces directory.
- directory_
id str Directory identifier for registration in WorkSpaces service.
- Mapping[str, str]
A map of tags assigned to the WorkSpaces directory.
- directory
Id String Directory identifier for registration in WorkSpaces service.
- Map<String>
A map of tags assigned to the WorkSpaces directory.
getDirectory Result
The following output properties are available:
- Alias string
Directory alias.
- Customer
User stringName User name for the service account.
- Directory
Id string - Directory
Name string Name of the directory.
- Directory
Type string Directory type.
- Dns
Ip List<string>Addresses IP addresses of the DNS servers for the directory.
- Iam
Role stringId 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.
- Ip
Group List<string>Ids Identifiers of the IP access control groups associated with the directory.
- Registration
Code string 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 List<Pulumi.Permissions Aws. Workspaces. Outputs. Get Directory Self Service Permission> The permissions to enable or disable self-service capabilities.
- Subnet
Ids List<string> Identifiers of the subnets where the directory resides.
- Workspace
Access List<Pulumi.Properties Aws. Workspaces. Outputs. Get Directory Workspace Access Property> (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
- Workspace
Creation List<Pulumi.Properties Aws. Workspaces. Outputs. Get Directory Workspace Creation Property> The default properties that are used for creating WorkSpaces. Defined below.
- Workspace
Security stringGroup Id The identifier of the security group that is assigned to new WorkSpaces. Defined below.
- Dictionary<string, string>
A map of tags assigned to the WorkSpaces directory.
- Alias string
Directory alias.
- Customer
User stringName User name for the service account.
- Directory
Id string - Directory
Name string Name of the directory.
- Directory
Type string Directory type.
- Dns
Ip []stringAddresses IP addresses of the DNS servers for the directory.
- Iam
Role stringId 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.
- Ip
Group []stringIds Identifiers of the IP access control groups associated with the directory.
- Registration
Code string 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 []GetPermissions Directory Self Service Permission The permissions to enable or disable self-service capabilities.
- Subnet
Ids []string Identifiers of the subnets where the directory resides.
- Workspace
Access []GetProperties Directory Workspace Access Property (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
- Workspace
Creation []GetProperties Directory Workspace Creation Property The default properties that are used for creating WorkSpaces. Defined below.
- Workspace
Security stringGroup Id The identifier of the security group that is assigned to new WorkSpaces. Defined below.
- map[string]string
A map of tags assigned to the WorkSpaces directory.
- alias String
Directory alias.
- customer
User StringName User name for the service account.
- directory
Id String - directory
Name String Name of the directory.
- directory
Type String Directory type.
- dns
Ip List<String>Addresses IP addresses of the DNS servers for the directory.
- iam
Role StringId 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.
- ip
Group List<String>Ids Identifiers of the IP access control groups associated with the directory.
- registration
Code String 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 List<GetPermissions Directory Self Service Permission> The permissions to enable or disable self-service capabilities.
- subnet
Ids List<String> Identifiers of the subnets where the directory resides.
- workspace
Access List<GetProperties Directory Workspace Access Property> (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
- workspace
Creation List<GetProperties Directory Workspace Creation Property> The default properties that are used for creating WorkSpaces. Defined below.
- workspace
Security StringGroup Id The identifier of the security group that is assigned to new WorkSpaces. Defined below.
- Map<String,String>
A map of tags assigned to the WorkSpaces directory.
- alias string
Directory alias.
- customer
User stringName User name for the service account.
- directory
Id string - directory
Name string Name of the directory.
- directory
Type string Directory type.
- dns
Ip string[]Addresses IP addresses of the DNS servers for the directory.
- iam
Role stringId 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.
- ip
Group string[]Ids Identifiers of the IP access control groups associated with the directory.
- registration
Code string 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 GetPermissions Directory Self Service Permission[] The permissions to enable or disable self-service capabilities.
- subnet
Ids string[] Identifiers of the subnets where the directory resides.
- workspace
Access GetProperties Directory Workspace Access Property[] (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
- workspace
Creation GetProperties Directory Workspace Creation Property[] The default properties that are used for creating WorkSpaces. Defined below.
- workspace
Security stringGroup Id The identifier of the security group that is assigned to new WorkSpaces. Defined below.
- {[key: string]: string}
A map of tags assigned to the WorkSpaces directory.
- alias str
Directory alias.
- customer_
user_ strname User name for the service account.
- directory_
id str - directory_
name str Name of the directory.
- directory_
type str Directory type.
- dns_
ip_ Sequence[str]addresses IP addresses of the DNS servers for the directory.
- iam_
role_ strid 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_ Sequence[str]ids 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_ Sequence[Getpermissions Directory Self Service Permission] The permissions to enable or disable self-service capabilities.
- subnet_
ids Sequence[str] Identifiers of the subnets where the directory resides.
- workspace_
access_ Sequence[Getproperties Directory Workspace Access Property] (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
- workspace_
creation_ Sequence[Getproperties Directory Workspace Creation Property] The default properties that are used for creating WorkSpaces. Defined below.
- workspace_
security_ strgroup_ id The identifier of the security group that is assigned to new WorkSpaces. Defined below.
- Mapping[str, str]
A map of tags assigned to the WorkSpaces directory.
- alias String
Directory alias.
- customer
User StringName User name for the service account.
- directory
Id String - directory
Name String Name of the directory.
- directory
Type String Directory type.
- dns
Ip List<String>Addresses IP addresses of the DNS servers for the directory.
- iam
Role StringId 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.
- ip
Group List<String>Ids Identifiers of the IP access control groups associated with the directory.
- registration
Code String 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 List<Property Map>Permissions The permissions to enable or disable self-service capabilities.
- subnet
Ids List<String> Identifiers of the subnets where the directory resides.
- workspace
Access List<Property Map>Properties (Optional) Specifies which devices and operating systems users can use to access their WorkSpaces. Defined below.
- workspace
Creation List<Property Map>Properties The default properties that are used for creating WorkSpaces. Defined below.
- workspace
Security StringGroup Id The identifier of the security group that is assigned to new WorkSpaces. Defined below.
- Map<String>
A map of tags assigned to the WorkSpaces directory.
Supporting Types
GetDirectorySelfServicePermission
- Change
Compute boolType Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.
- Increase
Volume boolSize 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 boolMode Whether WorkSpaces directory users can switch the running mode of their workspace.
- Change
Compute boolType Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.
- Increase
Volume boolSize 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 boolMode Whether WorkSpaces directory users can switch the running mode of their workspace.
- change
Compute BooleanType Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.
- increase
Volume BooleanSize Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.
- rebuild
Workspace Boolean Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.
- restart
Workspace Boolean Whether WorkSpaces directory users can restart their workspace.
- switch
Running BooleanMode Whether WorkSpaces directory users can switch the running mode of their workspace.
- change
Compute booleanType Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.
- increase
Volume booleanSize Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.
- rebuild
Workspace boolean Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.
- restart
Workspace boolean Whether WorkSpaces directory users can restart their workspace.
- switch
Running booleanMode Whether WorkSpaces directory users can switch the running mode of their workspace.
- change_
compute_ booltype Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.
- increase_
volume_ boolsize 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_ boolmode Whether WorkSpaces directory users can switch the running mode of their workspace.
- change
Compute BooleanType Whether WorkSpaces directory users can change the compute type (bundle) for their workspace.
- increase
Volume BooleanSize Whether WorkSpaces directory users can increase the volume size of the drives on their workspace.
- rebuild
Workspace Boolean Whether WorkSpaces directory users can rebuild the operating system of a workspace to its original state.
- restart
Workspace Boolean Whether WorkSpaces directory users can restart their workspace.
- switch
Running BooleanMode Whether WorkSpaces directory users can switch the running mode of their workspace.
GetDirectoryWorkspaceAccessProperty
- Device
Type stringAndroid (Optional) Indicates whether users can use Android devices to access their WorkSpaces.
- Device
Type stringChromeos (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.
- Device
Type stringIos (Optional) Indicates whether users can use iOS devices to access their WorkSpaces.
- Device
Type stringLinux (Optional) Indicates whether users can use Linux clients to access their WorkSpaces.
- Device
Type stringOsx (Optional) Indicates whether users can use macOS clients to access their WorkSpaces.
- Device
Type stringWeb (Optional) Indicates whether users can access their WorkSpaces through a web browser.
- Device
Type stringWindows (Optional) Indicates whether users can use Windows clients to access their WorkSpaces.
- Device
Type stringZeroclient (Optional) Indicates whether users can use zero client devices to access their WorkSpaces.
- Device
Type stringAndroid (Optional) Indicates whether users can use Android devices to access their WorkSpaces.
- Device
Type stringChromeos (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.
- Device
Type stringIos (Optional) Indicates whether users can use iOS devices to access their WorkSpaces.
- Device
Type stringLinux (Optional) Indicates whether users can use Linux clients to access their WorkSpaces.
- Device
Type stringOsx (Optional) Indicates whether users can use macOS clients to access their WorkSpaces.
- Device
Type stringWeb (Optional) Indicates whether users can access their WorkSpaces through a web browser.
- Device
Type stringWindows (Optional) Indicates whether users can use Windows clients to access their WorkSpaces.
- Device
Type stringZeroclient (Optional) Indicates whether users can use zero client devices to access their WorkSpaces.
- device
Type StringAndroid (Optional) Indicates whether users can use Android devices to access their WorkSpaces.
- device
Type StringChromeos (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.
- device
Type StringIos (Optional) Indicates whether users can use iOS devices to access their WorkSpaces.
- device
Type StringLinux (Optional) Indicates whether users can use Linux clients to access their WorkSpaces.
- device
Type StringOsx (Optional) Indicates whether users can use macOS clients to access their WorkSpaces.
- device
Type StringWeb (Optional) Indicates whether users can access their WorkSpaces through a web browser.
- device
Type StringWindows (Optional) Indicates whether users can use Windows clients to access their WorkSpaces.
- device
Type StringZeroclient (Optional) Indicates whether users can use zero client devices to access their WorkSpaces.
- device
Type stringAndroid (Optional) Indicates whether users can use Android devices to access their WorkSpaces.
- device
Type stringChromeos (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.
- device
Type stringIos (Optional) Indicates whether users can use iOS devices to access their WorkSpaces.
- device
Type stringLinux (Optional) Indicates whether users can use Linux clients to access their WorkSpaces.
- device
Type stringOsx (Optional) Indicates whether users can use macOS clients to access their WorkSpaces.
- device
Type stringWeb (Optional) Indicates whether users can access their WorkSpaces through a web browser.
- device
Type stringWindows (Optional) Indicates whether users can use Windows clients to access their WorkSpaces.
- device
Type stringZeroclient (Optional) Indicates whether users can use zero client devices to access their WorkSpaces.
- device_
type_ strandroid (Optional) Indicates whether users can use Android devices to access their WorkSpaces.
- device_
type_ strchromeos (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.
- device_
type_ strios (Optional) Indicates whether users can use iOS devices to access their WorkSpaces.
- device_
type_ strlinux (Optional) Indicates whether users can use Linux clients to access their WorkSpaces.
- device_
type_ strosx (Optional) Indicates whether users can use macOS clients to access their WorkSpaces.
- device_
type_ strweb (Optional) Indicates whether users can access their WorkSpaces through a web browser.
- device_
type_ strwindows (Optional) Indicates whether users can use Windows clients to access their WorkSpaces.
- device_
type_ strzeroclient (Optional) Indicates whether users can use zero client devices to access their WorkSpaces.
- device
Type StringAndroid (Optional) Indicates whether users can use Android devices to access their WorkSpaces.
- device
Type StringChromeos (Optional) Indicates whether users can use Chromebooks to access their WorkSpaces.
- device
Type StringIos (Optional) Indicates whether users can use iOS devices to access their WorkSpaces.
- device
Type StringLinux (Optional) Indicates whether users can use Linux clients to access their WorkSpaces.
- device
Type StringOsx (Optional) Indicates whether users can use macOS clients to access their WorkSpaces.
- device
Type StringWeb (Optional) Indicates whether users can access their WorkSpaces through a web browser.
- device
Type StringWindows (Optional) Indicates whether users can use Windows clients to access their WorkSpaces.
- device
Type StringZeroclient (Optional) Indicates whether users can use zero client devices to access their WorkSpaces.
GetDirectoryWorkspaceCreationProperty
- Custom
Security stringGroup Id The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.
- Default
Ou string The default organizational unit (OU) for your WorkSpace directories.
- Enable
Internet boolAccess Indicates whether internet access is enabled for your WorkSpaces.
- Enable
Maintenance boolMode Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- User
Enabled boolAs Local Administrator Indicates whether users are local administrators of their WorkSpaces.
- Custom
Security stringGroup Id The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.
- Default
Ou string The default organizational unit (OU) for your WorkSpace directories.
- Enable
Internet boolAccess Indicates whether internet access is enabled for your WorkSpaces.
- Enable
Maintenance boolMode Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- User
Enabled boolAs Local Administrator Indicates whether users are local administrators of their WorkSpaces.
- custom
Security StringGroup Id The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.
- default
Ou String The default organizational unit (OU) for your WorkSpace directories.
- enable
Internet BooleanAccess Indicates whether internet access is enabled for your WorkSpaces.
- enable
Maintenance BooleanMode Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- user
Enabled BooleanAs Local Administrator Indicates whether users are local administrators of their WorkSpaces.
- custom
Security stringGroup Id The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.
- default
Ou string The default organizational unit (OU) for your WorkSpace directories.
- enable
Internet booleanAccess Indicates whether internet access is enabled for your WorkSpaces.
- enable
Maintenance booleanMode Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- user
Enabled booleanAs Local Administrator Indicates whether users are local administrators of their WorkSpaces.
- custom_
security_ strgroup_ id 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_ boolaccess Indicates whether internet access is enabled for your WorkSpaces.
- enable_
maintenance_ boolmode Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- user_
enabled_ boolas_ local_ administrator Indicates whether users are local administrators of their WorkSpaces.
- custom
Security StringGroup Id The identifier of your custom security group. Should relate to the same VPC, where workspaces reside in.
- default
Ou String The default organizational unit (OU) for your WorkSpace directories.
- enable
Internet BooleanAccess Indicates whether internet access is enabled for your WorkSpaces.
- enable
Maintenance BooleanMode Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
- user
Enabled BooleanAs Local Administrator Indicates whether users are local administrators of their WorkSpaces.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
aws
Terraform Provider.