AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Describes a directory that is used with Amazon WorkSpaces.

Inheritance Hierarchy

System.Object
  Amazon.WorkSpaces.Model.WorkspaceDirectory

Namespace: Amazon.WorkSpaces.Model
Assembly: AWSSDK.WorkSpaces.dll
Version: 3.x.y.z

Syntax

C#
public class WorkspaceDirectory

The WorkspaceDirectory type exposes the following members

Constructors

NameDescription
Public Method WorkspaceDirectory()

Properties

NameTypeDescription
Public Property Alias System.String

Gets and sets the property Alias.

The directory alias.

Public Property CertificateBasedAuthProperties Amazon.WorkSpaces.Model.CertificateBasedAuthProperties

Gets and sets the property CertificateBasedAuthProperties.

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

Public Property CustomerUserName System.String

Gets and sets the property CustomerUserName.

The user name for the service account.

Public Property DirectoryId System.String

Gets and sets the property DirectoryId.

The directory identifier.

Public Property DirectoryName System.String

Gets and sets the property DirectoryName.

The name of the directory.

Public Property DirectoryType Amazon.WorkSpaces.WorkspaceDirectoryType

Gets and sets the property DirectoryType.

The directory type.

Public Property DnsIpAddresses System.Collections.Generic.List<System.String>

Gets and sets the property DnsIpAddresses.

The IP addresses of the DNS servers for the directory.

Public Property IamRoleId System.String

Gets and sets the property IamRoleId.

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.

Public Property IpGroupIds System.Collections.Generic.List<System.String>

Gets and sets the property IpGroupIds.

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

Public Property RegistrationCode System.String

Gets and sets the property RegistrationCode.

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

Public Property SamlProperties Amazon.WorkSpaces.Model.SamlProperties

Gets and sets the property 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.

Public Property SelfservicePermissions Amazon.WorkSpaces.Model.SelfservicePermissions

Gets and sets the property SelfservicePermissions.

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

Public Property State Amazon.WorkSpaces.WorkspaceDirectoryState

Gets and sets the property State.

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.

Public Property SubnetIds System.Collections.Generic.List<System.String>

Gets and sets the property SubnetIds.

The identifiers of the subnets used with the directory.

Public Property Tenancy Amazon.WorkSpaces.Tenancy

Gets and sets the property Tenancy.

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.

Public Property WorkspaceAccessProperties Amazon.WorkSpaces.Model.WorkspaceAccessProperties

Gets and sets the property WorkspaceAccessProperties.

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

Public Property WorkspaceCreationProperties Amazon.WorkSpaces.Model.DefaultWorkspaceCreationProperties

Gets and sets the property WorkspaceCreationProperties.

The default creation properties for all WorkSpaces in the directory.

Public Property WorkspaceSecurityGroupId System.String

Gets and sets the property WorkspaceSecurityGroupId.

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

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5