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

Inherits:

Struct

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

Defined in:

gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Describes a directory that is used with Amazon WorkSpaces.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #active_directory_config ⇒ Types::ActiveDirectoryConfig

  Information about the Active Directory config.

• #alias ⇒ String

  The directory alias.

• #certificate_based_auth_properties ⇒ Types::CertificateBasedAuthProperties

  The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

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

• #dns_ipv_6_addresses ⇒ Array<String>

  The IPv6 addresses of the DNS servers for the directory.

• #endpoint_encryption_mode ⇒ String

  Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

• #error_message ⇒ String

  The error message returned.

• #iam_role_id ⇒ String

  The identifier of the IAM role.

• #idc_config ⇒ Types::IDCConfig

  Specifies details about identity center configurations.

• #ip_group_ids ⇒ Array<String>

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

• #microsoft_entra_config ⇒ Types::MicrosoftEntraConfig

  Specifies details about Microsoft Entra configurations.

• #registration_code ⇒ String

  The registration code for the directory.

• #saml_properties ⇒ Types::SamlProperties

  Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

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

• #streaming_properties ⇒ Types::StreamingProperties

  The streaming properties to configure.

• #subnet_ids ⇒ Array<String>

  The identifiers of the subnets used with the directory.

• #tenancy ⇒ String

  Specifies whether the directory is dedicated or shared.

• #user_identity_type ⇒ String

  Indicates the identity type of the specifired user.

• #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_directory_description ⇒ String

  The description of the WorkSpace directory.

• #workspace_directory_name ⇒ String

  The name fo the WorkSpace directory.

• #workspace_security_group_id ⇒ String

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

• #workspace_type ⇒ String

  Indicates whether the directory's WorkSpace type is personal or pools.

Instance Attribute Details

#active_directory_config ⇒ Types::ActiveDirectoryConfig

Information about the Active Directory config.

Returns:

• (Types::ActiveDirectoryConfig)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#alias ⇒ String

The directory alias.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#certificate_based_auth_properties ⇒ Types::CertificateBasedAuthProperties

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

Returns:

• (Types::CertificateBasedAuthProperties)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#customer_user_name ⇒ String

The user name for the service account.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#directory_id ⇒ String

The directory identifier.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#directory_name ⇒ String

The name of the directory.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#directory_type ⇒ String

The directory type.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#dns_ip_addresses ⇒ Array<String>

The IP addresses of the DNS servers for the directory.

Returns:

• (Array<String>)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#dns_ipv_6_addresses ⇒ Array<String>

The IPv6 addresses of the DNS servers for the directory.

Returns:

• (Array<String>)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_encryption_mode ⇒ String

Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

The error message returned.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  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 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6024

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#idc_config ⇒ Types::IDCConfig

Specifies details about identity center configurations.

Returns:

• (Types::IDCConfig)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  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 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6024

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#microsoft_entra_config ⇒ Types::MicrosoftEntraConfig

Specifies details about Microsoft Entra configurations.

Returns:

• (Types::MicrosoftEntraConfig)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  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 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 6024

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#saml_properties ⇒ Types::SamlProperties

Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

Returns:

• (Types::SamlProperties)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#selfservice_permissions ⇒ Types::SelfservicePermissions

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

Returns:

• (Types::SelfservicePermissions)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#streaming_properties ⇒ Types::StreamingProperties

The streaming properties to configure.

Returns:

• (Types::StreamingProperties)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The identifiers of the subnets used with the directory.

Returns:

• (Array<String>)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

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

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#user_identity_type ⇒ String

Indicates the identity type of the specifired user.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_access_properties ⇒ Types::WorkspaceAccessProperties

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

Returns:

• (Types::WorkspaceAccessProperties)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_creation_properties ⇒ Types::DefaultWorkspaceCreationProperties

The default creation properties for all WorkSpaces in the directory.

Returns:

• (Types::DefaultWorkspaceCreationProperties)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_directory_description ⇒ String

The description of the WorkSpace directory

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_directory_name ⇒ String

The name fo the WorkSpace directory.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_security_group_id ⇒ String

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

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_type ⇒ String

Indicates whether the directory's WorkSpace type is personal or pools.

Returns:

• (String)

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

class WorkspaceDirectory < Struct.new(
  :directory_id,
  :alias,
  :directory_name,
  :registration_code,
  :subnet_ids,
  :dns_ip_addresses,
  :dns_ipv_6_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,
  :saml_properties,
  :certificate_based_auth_properties,
  :endpoint_encryption_mode,
  :microsoft_entra_config,
  :workspace_directory_name,
  :workspace_directory_description,
  :user_identity_type,
  :workspace_type,
  :idc_config,
  :active_directory_config,
  :streaming_properties,
  :error_message)
  SENSITIVE = []
  include Aws::Structure
end