You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::WorkSpaces::Types::WorkspaceDirectory
- Inherits:
-
Struct
- Object
- Struct
- Aws::WorkSpaces::Types::WorkspaceDirectory
- Defined in:
- (unknown)
Overview
Describes a directory that is used with Amazon WorkSpaces.
Instance Attribute Summary collapse
-
#alias ⇒ String
The directory alias.
-
#customer_user_name ⇒ String
The user name for the service account.
-
#directory_id ⇒ String
The directory identifier.
-
#directory_name ⇒ String
The name of the directory.
-
#directory_type ⇒ String
The directory type.
-
#dns_ip_addresses ⇒ Array<String>
The IP addresses of the DNS servers for the directory.
-
#iam_role_id ⇒ String
The identifier of the IAM role.
-
#ip_group_ids ⇒ Array<String>
The identifiers of the IP access control groups associated with the directory.
-
#registration_code ⇒ String
The registration code for the directory.
-
#selfservice_permissions ⇒ Types::SelfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
-
#state ⇒ String
The state of the directory\'s registration with Amazon WorkSpaces.
-
#subnet_ids ⇒ Array<String>
The identifiers of the subnets used with the directory.
-
#tenancy ⇒ String
Specifies whether the directory is dedicated or shared.
-
#workspace_access_properties ⇒ Types::WorkspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
-
#workspace_creation_properties ⇒ Types::DefaultWorkspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
-
#workspace_security_group_id ⇒ String
The identifier of the security group that is assigned to new WorkSpaces.
Instance Attribute Details
#alias ⇒ String
The directory alias.
#customer_user_name ⇒ String
The user name for the service account.
#directory_id ⇒ String
The directory identifier.
#directory_name ⇒ String
The name of the directory.
#directory_type ⇒ String
The directory type.
Possible values:
- SIMPLE_AD
- AD_CONNECTOR
#dns_ip_addresses ⇒ Array<String>
The IP addresses of the DNS servers for the directory.
#iam_role_id ⇒ String
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.
#ip_group_ids ⇒ Array<String>
The identifiers of the IP access control groups associated with the directory.
#registration_code ⇒ String
The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
#selfservice_permissions ⇒ Types::SelfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
#state ⇒ String
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. If the
directory ID isn\'t returned, then the directory has been successfully
deregistered.
#subnet_ids ⇒ Array<String>
The identifiers of the subnets used with the directory.
#tenancy ⇒ String
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.
#workspace_access_properties ⇒ Types::WorkspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
#workspace_creation_properties ⇒ Types::DefaultWorkspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
#workspace_security_group_id ⇒ String
The identifier of the security group that is assigned to new WorkSpaces.