You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

Instance Attribute Summary collapse

Instance Attribute Details

#aliasString

The directory alias.

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#customer_user_nameString

The user name for the service account.

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#directory_idString

The directory identifier.

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#directory_nameString

The name of the directory.

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#directory_typeString

The directory type.

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#dns_ip_addressesArray<String>

An array of strings that contains the IP addresses of the DNS servers for the directory.

Returns:

  • (Array<String>)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  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)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  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)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#stateString

The state of the directory's registration with Amazon WorkSpaces

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#subnet_idsArray<String>

An array of strings that contains the identifiers of the subnets used with the directory.

Returns:

  • (Array<String>)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#workspace_creation_propertiesTypes::DefaultWorkspaceCreationProperties

A structure that specifies the default creation properties for all WorkSpaces in the directory.



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end

#workspace_security_group_idString

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

Returns:

  • (String)


1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1085

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)
  include Aws::Structure
end