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

#active_directory_configTypes::ActiveDirectoryConfig

Information about the Active Directory config.



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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

#aliasString

The directory alias.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_propertiesTypes::CertificateBasedAuthProperties

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



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_nameString

The user name for the service account.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_idString

The directory identifier.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_nameString

The name of the directory.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_typeString

The directory type.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_addressesArray<String>

The IP addresses of the DNS servers for the directory.

Returns:

  • (Array<String>)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_modeString

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

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_messageString

The error message returned.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_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)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_configTypes::IDCConfig

Specifies details about identity center configurations.

Returns:



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_idsArray<String>

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

Returns:

  • (Array<String>)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_configTypes::MicrosoftEntraConfig

Specifies details about Microsoft Entra configurations.



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_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)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_propertiesTypes::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.



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_permissionsTypes::SelfservicePermissions

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



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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

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


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_propertiesTypes::StreamingProperties

The streaming properties to configure.



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_idsArray<String>

The identifiers of the subnets used with the directory.

Returns:

  • (Array<String>)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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

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


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_typeString

Indicates the identity type of the specifired user.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_propertiesTypes::WorkspaceAccessProperties

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



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_propertiesTypes::DefaultWorkspaceCreationProperties

The default creation properties for all WorkSpaces in the directory.



5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_descriptionString

The description of the WorkSpace directory

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_nameString

The name fo the WorkSpace directory.

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_idString

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

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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_typeString

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

Returns:

  • (String)


5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 5996

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,
  :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