class Aws::WorkSpaces::Types::WorkspaceDirectory

Describes a directory that is used with Amazon WorkSpaces.

@!attribute [rw] directory_id

The directory identifier.
@return [String]

@!attribute [rw] alias

The directory alias.
@return [String]

@!attribute [rw] directory_name

The name of the directory.
@return [String]

@!attribute [rw] registration_code

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

@!attribute [rw] subnet_ids

The identifiers of the subnets used with the directory.
@return [Array<String>]

@!attribute [rw] dns_ip_addresses

The IP addresses of the DNS servers for the directory.
@return [Array<String>]

@!attribute [rw] customer_user_name

The user name for the service account.
@return [String]

@!attribute [rw] iam_role_id

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.
@return [String]

@!attribute [rw] directory_type

The directory type.
@return [String]

@!attribute [rw] workspace_security_group_id

The identifier of the security group that is assigned to new
WorkSpaces.
@return [String]

@!attribute [rw] state

The state of the directory's registration with Amazon WorkSpaces.
After a directory is deregistered, the `DEREGISTERED` state is
returned very briefly before the directory metadata is cleaned up,
so this state is rarely returned. To confirm that a directory is
deregistered, check for the directory ID by using [
DescribeWorkspaceDirectories][1]. If the directory ID isn't
returned, then the directory has been successfully deregistered.

[1]: https://docs.aws.amazon.com/workspaces/latest/api/API_DescribeWorkspaceDirectories.html
@return [String]

@!attribute [rw] workspace_creation_properties

The default creation properties for all WorkSpaces in the directory.
@return [Types::DefaultWorkspaceCreationProperties]

@!attribute [rw] ip_group_ids

The identifiers of the IP access control groups associated with the
directory.
@return [Array<String>]

@!attribute [rw] workspace_access_properties

The devices and operating systems that users can use to access
WorkSpaces.
@return [Types::WorkspaceAccessProperties]

@!attribute [rw] 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][1].

[1]: https://docs.aws.amazon.com/workspaces/latest/adminguide/byol-windows-images.html
@return [String]

@!attribute [rw] selfservice_permissions

The default self-service permissions for WorkSpaces in the
directory.
@return [Types::SelfservicePermissions]

@see docs.aws.amazon.com/goto/WebAPI/workspaces-2015-04-08/WorkspaceDirectory AWS API Documentation

Constants

SENSITIVE