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

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::WorkspaceDirectory

Includes:

Structure

Defined in:

lib/aws-sdk-workspaces/types.rb

Overview

Describes an AWS Directory Service directory that is used with Amazon WorkSpaces.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #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.

• #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.

• #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.

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#customer_user_name ⇒ String

The user name for the service account.

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#directory_id ⇒ String

The directory identifier.

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#directory_name ⇒ String

The name of the directory.

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#directory_type ⇒ String

The directory type.

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#dns_ip_addresses ⇒ Array<String>

The IP addresses of the DNS servers for the directory.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

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

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#ip_group_ids ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

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

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#state ⇒ String

The state of the directory’s registration with Amazon WorkSpaces

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#subnet_ids ⇒ Array<String>

The identifiers of the subnets used with the directory.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#workspace_creation_properties ⇒ Types::DefaultWorkspaceCreationProperties

The default creation properties for all WorkSpaces in the directory.

Returns:

• (Types::DefaultWorkspaceCreationProperties)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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

#workspace_security_group_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1820

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