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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#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.
-
#subnet_ids ⇒ Array<String>
The identifiers of the subnets used with the directory.
-
#tenancy ⇒ String
Specifies whether the directory is dedicated or shared.
-
#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_security_group_id ⇒ String
The identifier of the security group that is assigned to new WorkSpaces.
Instance Attribute Details
#alias ⇒ String
The directory alias.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) 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.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#customer_user_name ⇒ String
The user name for the service account.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#directory_id ⇒ String
The directory identifier.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#directory_name ⇒ String
The name of the directory.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#directory_type ⇒ String
The directory type.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#dns_ip_addresses ⇒ Array<String>
The IP addresses of the DNS servers for the directory.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) 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.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#ip_group_ids ⇒ Array<String>
The identifiers of the IP access control groups associated with the directory.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) 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.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) 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.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#selfservice_permissions ⇒ Types::SelfservicePermissions
The default self-service permissions for WorkSpaces in the directory.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) 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.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#subnet_ids ⇒ Array<String>
The identifiers of the subnets used with the directory.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) 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.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#workspace_access_properties ⇒ Types::WorkspaceAccessProperties
The devices and operating systems that users can use to access WorkSpaces.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#workspace_creation_properties ⇒ Types::DefaultWorkspaceCreationProperties
The default creation properties for all WorkSpaces in the directory.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |
#workspace_security_group_id ⇒ String
The identifier of the security group that is assigned to new WorkSpaces.
4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 |
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 4954 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) SENSITIVE = [] include Aws::Structure end |