WorkspaceDirectory - Amazon WorkSpaces Service

WorkspaceDirectory

Describes a directory that is used with Amazon WorkSpaces.

Contents

Alias

The directory alias.

Type: String

Required: No

CustomerUserName

The user name for the service account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

DirectoryId

The directory identifier.

Type: String

Length Constraints: Minimum length of 10. Maximum length of 65.

Pattern: ^d-[0-9a-f]{8,63}$

Required: No

DirectoryName

The name of the directory.

Type: String

Required: No

DirectoryType

The directory type.

Type: String

Valid Values: SIMPLE_AD | AD_CONNECTOR

Required: No

DnsIpAddresses

The IP addresses of the DNS servers for the directory.

Type: Array of strings

Required: No

IamRoleId

The 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.

Type: String

Pattern: ^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$

Required: No

ipGroupIds

The identifiers of the IP access control groups associated with the directory.

Type: Array of strings

Pattern: wsipg-[0-9a-z]{8,63}$

Required: No

RegistrationCode

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Required: No

SelfservicePermissions

The default self-service permissions for WorkSpaces in the directory.

Type: SelfservicePermissions object

Required: No

State

The state of the directory's registration with Amazon WorkSpaces.

Type: String

Valid Values: REGISTERING | REGISTERED | DEREGISTERING | DEREGISTERED | ERROR

Required: No

SubnetIds

The identifiers of the subnets used with the directory.

Type: Array of strings

Array Members: Maximum number of 2 items.

Length Constraints: Minimum length of 15. Maximum length of 24.

Pattern: ^(subnet-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

Tenancy

Specifies whether the directory is dedicated or shared. To use Bring Your Own License (BYOL), this value must be set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.

Type: String

Valid Values: DEDICATED | SHARED

Required: No

WorkspaceAccessProperties

The devices and operating systems that users can use to access WorkSpaces.

Type: WorkspaceAccessProperties object

Required: No

WorkspaceCreationProperties

The default creation properties for all WorkSpaces in the directory.

Type: DefaultWorkspaceCreationProperties object

Required: No

WorkspaceSecurityGroupId

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

Type: String

Length Constraints: Minimum length of 11. Maximum length of 20.

Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: