Class: Aws::WorkSpaces::Types::WorkspaceDirectory

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a directory that is used with Amazon WorkSpaces.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The directory alias.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#customer_user_nameString

The user name for the service account.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#directory_idString

The directory identifier.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#directory_nameString

The name of the directory.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#directory_typeString

The directory type.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#dns_ip_addressesArray<String>

The IP addresses of the DNS servers for the directory.

Returns:

  • (Array<String>)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#iam_role_idString

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.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#ip_group_idsArray<String>

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

Returns:

  • (Array<String>)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#registration_codeString

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

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#selfservice_permissionsTypes::SelfservicePermissions

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



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#stateString

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.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_idsArray<String>

The identifiers of the subnets used with the directory.

Returns:

  • (Array<String>)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#tenancyString

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.

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_access_propertiesTypes::WorkspaceAccessProperties

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



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_creation_propertiesTypes::DefaultWorkspaceCreationProperties

The default creation properties for all WorkSpaces in the directory.



3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_security_group_idString

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

Returns:

  • (String)


3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 3641

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :customer_user_name,
  :iam_role_id,
  :directory_type,
  :workspace_security_group_id,
  :state,
  :workspace_creation_properties,
  :ip_group_ids,
  :workspace_access_properties,
  :tenancy,
  :selfservice_permissions)
  SENSITIVE = []
  include Aws::Structure
end