WorkspaceDirectory (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspaces.model.WorkspaceDirectory

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkspaceDirectory
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes a directory that is used with Amazon WorkSpaces.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceDirectory()

Constructors
Constructor and Description
`WorkspaceDirectory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceDirectory`	`clone()`
`boolean`	`equals(Object obj)`
`ActiveDirectoryConfig`	`getActiveDirectoryConfig()` Information about the Active Directory config.
`String`	`getAlias()` The directory alias.
`CertificateBasedAuthProperties`	`getCertificateBasedAuthProperties()` The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
`String`	`getCustomerUserName()` The user name for the service account.
`String`	`getDirectoryId()` The directory identifier.
`String`	`getDirectoryName()` The name of the directory.
`String`	`getDirectoryType()` The directory type.
`List<String>`	`getDnsIpAddresses()` The IP addresses of the DNS servers for the directory.
`String`	`getErrorMessage()` The error message returned.
`String`	`getIamRoleId()` The identifier of the IAM role.
`List<String>`	`getIpGroupIds()` The identifiers of the IP access control groups associated with the directory.
`String`	`getRegistrationCode()` The registration code for the directory.
`SamlProperties`	`getSamlProperties()` 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.
`SelfservicePermissions`	`getSelfservicePermissions()` The default self-service permissions for WorkSpaces in the directory.
`String`	`getState()` The state of the directory's registration with Amazon WorkSpaces.
`StreamingProperties`	`getStreamingProperties()` The streaming properties to configure.
`List<String>`	`getSubnetIds()` The identifiers of the subnets used with the directory.
`String`	`getTenancy()` Specifies whether the directory is dedicated or shared.
`String`	`getUserIdentityType()` Indicates the identity type of the specifired user.
`WorkspaceAccessProperties`	`getWorkspaceAccessProperties()` The devices and operating systems that users can use to access WorkSpaces.
`DefaultWorkspaceCreationProperties`	`getWorkspaceCreationProperties()` The default creation properties for all WorkSpaces in the directory.
`String`	`getWorkspaceDirectoryDescription()` The description of the WorkSpace directory
`String`	`getWorkspaceDirectoryName()` The name fo the WorkSpace directory.
`String`	`getWorkspaceSecurityGroupId()` The identifier of the security group that is assigned to new WorkSpaces.
`String`	`getWorkspaceType()` Indicates whether the directory's WorkSpace type is personal or pools.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveDirectoryConfig(ActiveDirectoryConfig activeDirectoryConfig)` Information about the Active Directory config.
`void`	`setAlias(String alias)` The directory alias.
`void`	`setCertificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties)` The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
`void`	`setCustomerUserName(String customerUserName)` The user name for the service account.
`void`	`setDirectoryId(String directoryId)` The directory identifier.
`void`	`setDirectoryName(String directoryName)` The name of the directory.
`void`	`setDirectoryType(String directoryType)` The directory type.
`void`	`setDirectoryType(WorkspaceDirectoryType directoryType)` The directory type.
`void`	`setDnsIpAddresses(Collection<String> dnsIpAddresses)` The IP addresses of the DNS servers for the directory.
`void`	`setErrorMessage(String errorMessage)` The error message returned.
`void`	`setIamRoleId(String iamRoleId)` The identifier of the IAM role.
`void`	`setIpGroupIds(Collection<String> ipGroupIds)` The identifiers of the IP access control groups associated with the directory.
`void`	`setRegistrationCode(String registrationCode)` The registration code for the directory.
`void`	`setSamlProperties(SamlProperties 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.
`void`	`setSelfservicePermissions(SelfservicePermissions selfservicePermissions)` The default self-service permissions for WorkSpaces in the directory.
`void`	`setState(String state)` The state of the directory's registration with Amazon WorkSpaces.
`void`	`setState(WorkspaceDirectoryState state)` The state of the directory's registration with Amazon WorkSpaces.
`void`	`setStreamingProperties(StreamingProperties streamingProperties)` The streaming properties to configure.
`void`	`setSubnetIds(Collection<String> subnetIds)` The identifiers of the subnets used with the directory.
`void`	`setTenancy(String tenancy)` Specifies whether the directory is dedicated or shared.
`void`	`setTenancy(Tenancy tenancy)` Specifies whether the directory is dedicated or shared.
`void`	`setUserIdentityType(String userIdentityType)` Indicates the identity type of the specifired user.
`void`	`setUserIdentityType(UserIdentityType userIdentityType)` Indicates the identity type of the specifired user.
`void`	`setWorkspaceAccessProperties(WorkspaceAccessProperties workspaceAccessProperties)` The devices and operating systems that users can use to access WorkSpaces.
`void`	`setWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)` The default creation properties for all WorkSpaces in the directory.
`void`	`setWorkspaceDirectoryDescription(String workspaceDirectoryDescription)` The description of the WorkSpace directory
`void`	`setWorkspaceDirectoryName(String workspaceDirectoryName)` The name fo the WorkSpace directory.
`void`	`setWorkspaceSecurityGroupId(String workspaceSecurityGroupId)` The identifier of the security group that is assigned to new WorkSpaces.
`void`	`setWorkspaceType(String workspaceType)` Indicates whether the directory's WorkSpace type is personal or pools.
`void`	`setWorkspaceType(WorkspaceType workspaceType)` Indicates whether the directory's WorkSpace type is personal or pools.
`String`	`toString()` Returns a string representation of this object.
`WorkspaceDirectory`	`withActiveDirectoryConfig(ActiveDirectoryConfig activeDirectoryConfig)` Information about the Active Directory config.
`WorkspaceDirectory`	`withAlias(String alias)` The directory alias.
`WorkspaceDirectory`	`withCertificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties)` The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
`WorkspaceDirectory`	`withCustomerUserName(String customerUserName)` The user name for the service account.
`WorkspaceDirectory`	`withDirectoryId(String directoryId)` The directory identifier.
`WorkspaceDirectory`	`withDirectoryName(String directoryName)` The name of the directory.
`WorkspaceDirectory`	`withDirectoryType(String directoryType)` The directory type.
`WorkspaceDirectory`	`withDirectoryType(WorkspaceDirectoryType directoryType)` The directory type.
`WorkspaceDirectory`	`withDnsIpAddresses(Collection<String> dnsIpAddresses)` The IP addresses of the DNS servers for the directory.
`WorkspaceDirectory`	`withDnsIpAddresses(String... dnsIpAddresses)` The IP addresses of the DNS servers for the directory.
`WorkspaceDirectory`	`withErrorMessage(String errorMessage)` The error message returned.
`WorkspaceDirectory`	`withIamRoleId(String iamRoleId)` The identifier of the IAM role.
`WorkspaceDirectory`	`withIpGroupIds(Collection<String> ipGroupIds)` The identifiers of the IP access control groups associated with the directory.
`WorkspaceDirectory`	`withIpGroupIds(String... ipGroupIds)` The identifiers of the IP access control groups associated with the directory.
`WorkspaceDirectory`	`withRegistrationCode(String registrationCode)` The registration code for the directory.
`WorkspaceDirectory`	`withSamlProperties(SamlProperties 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.
`WorkspaceDirectory`	`withSelfservicePermissions(SelfservicePermissions selfservicePermissions)` The default self-service permissions for WorkSpaces in the directory.
`WorkspaceDirectory`	`withState(String state)` The state of the directory's registration with Amazon WorkSpaces.
`WorkspaceDirectory`	`withState(WorkspaceDirectoryState state)` The state of the directory's registration with Amazon WorkSpaces.
`WorkspaceDirectory`	`withStreamingProperties(StreamingProperties streamingProperties)` The streaming properties to configure.
`WorkspaceDirectory`	`withSubnetIds(Collection<String> subnetIds)` The identifiers of the subnets used with the directory.
`WorkspaceDirectory`	`withSubnetIds(String... subnetIds)` The identifiers of the subnets used with the directory.
`WorkspaceDirectory`	`withTenancy(String tenancy)` Specifies whether the directory is dedicated or shared.
`WorkspaceDirectory`	`withTenancy(Tenancy tenancy)` Specifies whether the directory is dedicated or shared.
`WorkspaceDirectory`	`withUserIdentityType(String userIdentityType)` Indicates the identity type of the specifired user.
`WorkspaceDirectory`	`withUserIdentityType(UserIdentityType userIdentityType)` Indicates the identity type of the specifired user.
`WorkspaceDirectory`	`withWorkspaceAccessProperties(WorkspaceAccessProperties workspaceAccessProperties)` The devices and operating systems that users can use to access WorkSpaces.
`WorkspaceDirectory`	`withWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)` The default creation properties for all WorkSpaces in the directory.
`WorkspaceDirectory`	`withWorkspaceDirectoryDescription(String workspaceDirectoryDescription)` The description of the WorkSpace directory
`WorkspaceDirectory`	`withWorkspaceDirectoryName(String workspaceDirectoryName)` The name fo the WorkSpace directory.
`WorkspaceDirectory`	`withWorkspaceSecurityGroupId(String workspaceSecurityGroupId)` The identifier of the security group that is assigned to new WorkSpaces.
`WorkspaceDirectory`	`withWorkspaceType(String workspaceType)` Indicates whether the directory's WorkSpace type is personal or pools.
`WorkspaceDirectory`	`withWorkspaceType(WorkspaceType workspaceType)` Indicates whether the directory's WorkSpace type is personal or pools.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkspaceDirectory
```
public WorkspaceDirectory()
```
- Method Detail
  - setDirectoryId
```
public void setDirectoryId(String directoryId)
```
    The directory identifier.
    
    Parameters:
    
    directoryId - The directory identifier.
  - getDirectoryId
```
public String getDirectoryId()
```
    The directory identifier.
    
    Returns:
    
    The directory identifier.
  - withDirectoryId
```
public WorkspaceDirectory withDirectoryId(String directoryId)
```
    The directory identifier.
    
    Parameters:
    
    directoryId - The directory identifier.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAlias
```
public void setAlias(String alias)
```
    The directory alias.
    
    Parameters:
    
    alias - The directory alias.
  - getAlias
```
public String getAlias()
```
    The directory alias.
    
    Returns:
    
    The directory alias.
  - withAlias
```
public WorkspaceDirectory withAlias(String alias)
```
    The directory alias.
    
    Parameters:
    
    alias - The directory alias.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDirectoryName
```
public void setDirectoryName(String directoryName)
```
    The name of the directory.
    
    Parameters:
    
    directoryName - The name of the directory.
  - getDirectoryName
```
public String getDirectoryName()
```
    The name of the directory.
    
    Returns:
    
    The name of the directory.
  - withDirectoryName
```
public WorkspaceDirectory withDirectoryName(String directoryName)
```
    The name of the directory.
    
    Parameters:
    
    directoryName - The name of the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegistrationCode
```
public void setRegistrationCode(String 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.
    
    Parameters:
    
    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.
  - getRegistrationCode
```
public String getRegistrationCode()
```
    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:
    
    The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
  - withRegistrationCode
```
public WorkspaceDirectory withRegistrationCode(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    The identifiers of the subnets used with the directory.
    
    Returns:
    
    The identifiers of the subnets used with the directory.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    The identifiers of the subnets used with the directory.
    
    Parameters:
    
    subnetIds - The identifiers of the subnets used with the directory.
  - withSubnetIds
```
public WorkspaceDirectory withSubnetIds(String... subnetIds)
```
    The identifiers of the subnets used with the directory.
    
    NOTE: This method appends the values to the existing list (if any). Use setSubnetIds(java.util.Collection) or withSubnetIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    subnetIds - The identifiers of the subnets used with the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withSubnetIds
```
public WorkspaceDirectory withSubnetIds(Collection<String> subnetIds)
```
    The identifiers of the subnets used with the directory.
    
    Parameters:
    
    subnetIds - The identifiers of the subnets used with the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDnsIpAddresses
```
public List<String> getDnsIpAddresses()
```
    The IP addresses of the DNS servers for the directory.
    
    Returns:
    
    The IP addresses of the DNS servers for the directory.
  - setDnsIpAddresses
```
public void setDnsIpAddresses(Collection<String> dnsIpAddresses)
```
    The IP addresses of the DNS servers for the directory.
    
    Parameters:
    
    dnsIpAddresses - The IP addresses of the DNS servers for the directory.
  - withDnsIpAddresses
```
public WorkspaceDirectory withDnsIpAddresses(String... dnsIpAddresses)
```
    The IP addresses of the DNS servers for the directory.
    
    NOTE: This method appends the values to the existing list (if any). Use setDnsIpAddresses(java.util.Collection) or withDnsIpAddresses(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    dnsIpAddresses - The IP addresses of the DNS servers for the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withDnsIpAddresses
```
public WorkspaceDirectory withDnsIpAddresses(Collection<String> dnsIpAddresses)
```
    The IP addresses of the DNS servers for the directory.
    
    Parameters:
    
    dnsIpAddresses - The IP addresses of the DNS servers for the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomerUserName
```
public void setCustomerUserName(String customerUserName)
```
    The user name for the service account.
    
    Parameters:
    
    customerUserName - The user name for the service account.
  - getCustomerUserName
```
public String getCustomerUserName()
```
    The user name for the service account.
    
    Returns:
    
    The user name for the service account.
  - withCustomerUserName
```
public WorkspaceDirectory withCustomerUserName(String customerUserName)
```
    The user name for the service account.
    
    Parameters:
    
    customerUserName - The user name for the service account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIamRoleId
```
public void setIamRoleId(String 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.
    
    Parameters:
    
    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.
  - getIamRoleId
```
public String getIamRoleId()
```
    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:
    
    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.
  - withIamRoleId
```
public WorkspaceDirectory withIamRoleId(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDirectoryType
```
public void setDirectoryType(String directoryType)
```
    The directory type.
    
    Parameters:
    
    directoryType - The directory type.
    
    See Also:
    
    WorkspaceDirectoryType
  - getDirectoryType
```
public String getDirectoryType()
```
    The directory type.
    
    Returns:
    
    The directory type.
    
    See Also:
    
    WorkspaceDirectoryType
  - withDirectoryType
```
public WorkspaceDirectory withDirectoryType(String directoryType)
```
    The directory type.
    
    Parameters:
    
    directoryType - The directory type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceDirectoryType
  - setDirectoryType
```
public void setDirectoryType(WorkspaceDirectoryType directoryType)
```
    The directory type.
    
    Parameters:
    
    directoryType - The directory type.
    
    See Also:
    
    WorkspaceDirectoryType
  - withDirectoryType
```
public WorkspaceDirectory withDirectoryType(WorkspaceDirectoryType directoryType)
```
    The directory type.
    
    Parameters:
    
    directoryType - The directory type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceDirectoryType
  - setWorkspaceSecurityGroupId
```
public void setWorkspaceSecurityGroupId(String workspaceSecurityGroupId)
```
    The identifier of the security group that is assigned to new WorkSpaces.
    
    Parameters:
    
    workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.
  - getWorkspaceSecurityGroupId
```
public String getWorkspaceSecurityGroupId()
```
    The identifier of the security group that is assigned to new WorkSpaces.
    
    Returns:
    
    The identifier of the security group that is assigned to new WorkSpaces.
  - withWorkspaceSecurityGroupId
```
public WorkspaceDirectory withWorkspaceSecurityGroupId(String workspaceSecurityGroupId)
```
    The identifier of the security group that is assigned to new WorkSpaces.
    
    Parameters:
    
    workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    WorkspaceDirectoryState
  - getState
```
public String getState()
```
    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:
    
    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.
    
    See Also:
    
    WorkspaceDirectoryState
  - withState
```
public WorkspaceDirectory withState(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceDirectoryState
  - setState
```
public void setState(WorkspaceDirectoryState 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    WorkspaceDirectoryState
  - withState
```
public WorkspaceDirectory withState(WorkspaceDirectoryState 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceDirectoryState
  - setWorkspaceCreationProperties
```
public void setWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)
```
    The default creation properties for all WorkSpaces in the directory.
    
    Parameters:
    
    workspaceCreationProperties - The default creation properties for all WorkSpaces in the directory.
  - getWorkspaceCreationProperties
```
public DefaultWorkspaceCreationProperties getWorkspaceCreationProperties()
```
    The default creation properties for all WorkSpaces in the directory.
    
    Returns:
    
    The default creation properties for all WorkSpaces in the directory.
  - withWorkspaceCreationProperties
```
public WorkspaceDirectory withWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)
```
    The default creation properties for all WorkSpaces in the directory.
    
    Parameters:
    
    workspaceCreationProperties - The default creation properties for all WorkSpaces in the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getIpGroupIds
```
public List<String> getIpGroupIds()
```
    The identifiers of the IP access control groups associated with the directory.
    
    Returns:
    
    The identifiers of the IP access control groups associated with the directory.
  - setIpGroupIds
```
public void setIpGroupIds(Collection<String> ipGroupIds)
```
    The identifiers of the IP access control groups associated with the directory.
    
    Parameters:
    
    ipGroupIds - The identifiers of the IP access control groups associated with the directory.
  - withIpGroupIds
```
public WorkspaceDirectory withIpGroupIds(String... ipGroupIds)
```
    The identifiers of the IP access control groups associated with the directory.
    
    NOTE: This method appends the values to the existing list (if any). Use setIpGroupIds(java.util.Collection) or withIpGroupIds(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    ipGroupIds - The identifiers of the IP access control groups associated with the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withIpGroupIds
```
public WorkspaceDirectory withIpGroupIds(Collection<String> ipGroupIds)
```
    The identifiers of the IP access control groups associated with the directory.
    
    Parameters:
    
    ipGroupIds - The identifiers of the IP access control groups associated with the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkspaceAccessProperties
```
public void setWorkspaceAccessProperties(WorkspaceAccessProperties workspaceAccessProperties)
```
    The devices and operating systems that users can use to access WorkSpaces.
    
    Parameters:
    
    workspaceAccessProperties - The devices and operating systems that users can use to access WorkSpaces.
  - getWorkspaceAccessProperties
```
public WorkspaceAccessProperties getWorkspaceAccessProperties()
```
    The devices and operating systems that users can use to access WorkSpaces.
    
    Returns:
    
    The devices and operating systems that users can use to access WorkSpaces.
  - withWorkspaceAccessProperties
```
public WorkspaceDirectory withWorkspaceAccessProperties(WorkspaceAccessProperties workspaceAccessProperties)
```
    The devices and operating systems that users can use to access WorkSpaces.
    
    Parameters:
    
    workspaceAccessProperties - The devices and operating systems that users can use to access WorkSpaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTenancy
```
public void setTenancy(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    Tenancy
  - getTenancy
```
public String getTenancy()
```
    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:
    
    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.
    
    See Also:
    
    Tenancy
  - withTenancy
```
public WorkspaceDirectory withTenancy(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tenancy
  - setTenancy
```
public void setTenancy(Tenancy 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    Tenancy
  - withTenancy
```
public WorkspaceDirectory withTenancy(Tenancy 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Tenancy
  - setSelfservicePermissions
```
public void setSelfservicePermissions(SelfservicePermissions selfservicePermissions)
```
    The default self-service permissions for WorkSpaces in the directory.
    
    Parameters:
    
    selfservicePermissions - The default self-service permissions for WorkSpaces in the directory.
  - getSelfservicePermissions
```
public SelfservicePermissions getSelfservicePermissions()
```
    The default self-service permissions for WorkSpaces in the directory.
    
    Returns:
    
    The default self-service permissions for WorkSpaces in the directory.
  - withSelfservicePermissions
```
public WorkspaceDirectory withSelfservicePermissions(SelfservicePermissions selfservicePermissions)
```
    The default self-service permissions for WorkSpaces in the directory.
    
    Parameters:
    
    selfservicePermissions - The default self-service permissions for WorkSpaces in the directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSamlProperties
```
public void setSamlProperties(SamlProperties 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.
    
    Parameters:
    
    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.
  - getSamlProperties
```
public SamlProperties getSamlProperties()
```
    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:
    
    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.
  - withSamlProperties
```
public WorkspaceDirectory withSamlProperties(SamlProperties 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificateBasedAuthProperties
```
public void setCertificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties)
```
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
    
    Parameters:
    
    certificateBasedAuthProperties - The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
  - getCertificateBasedAuthProperties
```
public CertificateBasedAuthProperties getCertificateBasedAuthProperties()
```
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
    
    Returns:
    
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
  - withCertificateBasedAuthProperties
```
public WorkspaceDirectory withCertificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties)
```
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
    
    Parameters:
    
    certificateBasedAuthProperties - The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkspaceDirectoryName
```
public void setWorkspaceDirectoryName(String workspaceDirectoryName)
```
    The name fo the WorkSpace directory.
    
    Parameters:
    
    workspaceDirectoryName - The name fo the WorkSpace directory.
  - getWorkspaceDirectoryName
```
public String getWorkspaceDirectoryName()
```
    The name fo the WorkSpace directory.
    
    Returns:
    
    The name fo the WorkSpace directory.
  - withWorkspaceDirectoryName
```
public WorkspaceDirectory withWorkspaceDirectoryName(String workspaceDirectoryName)
```
    The name fo the WorkSpace directory.
    
    Parameters:
    
    workspaceDirectoryName - The name fo the WorkSpace directory.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkspaceDirectoryDescription
```
public void setWorkspaceDirectoryDescription(String workspaceDirectoryDescription)
```
    The description of the WorkSpace directory
    
    Parameters:
    
    workspaceDirectoryDescription - The description of the WorkSpace directory
  - getWorkspaceDirectoryDescription
```
public String getWorkspaceDirectoryDescription()
```
    The description of the WorkSpace directory
    
    Returns:
    
    The description of the WorkSpace directory
  - withWorkspaceDirectoryDescription
```
public WorkspaceDirectory withWorkspaceDirectoryDescription(String workspaceDirectoryDescription)
```
    The description of the WorkSpace directory
    
    Parameters:
    
    workspaceDirectoryDescription - The description of the WorkSpace directory
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserIdentityType
```
public void setUserIdentityType(String userIdentityType)
```
    Indicates the identity type of the specifired user.
    
    Parameters:
    
    userIdentityType - Indicates the identity type of the specifired user.
    
    See Also:
    
    UserIdentityType
  - getUserIdentityType
```
public String getUserIdentityType()
```
    Indicates the identity type of the specifired user.
    
    Returns:
    
    Indicates the identity type of the specifired user.
    
    See Also:
    
    UserIdentityType
  - withUserIdentityType
```
public WorkspaceDirectory withUserIdentityType(String userIdentityType)
```
    Indicates the identity type of the specifired user.
    
    Parameters:
    
    userIdentityType - Indicates the identity type of the specifired user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserIdentityType
  - setUserIdentityType
```
public void setUserIdentityType(UserIdentityType userIdentityType)
```
    Indicates the identity type of the specifired user.
    
    Parameters:
    
    userIdentityType - Indicates the identity type of the specifired user.
    
    See Also:
    
    UserIdentityType
  - withUserIdentityType
```
public WorkspaceDirectory withUserIdentityType(UserIdentityType userIdentityType)
```
    Indicates the identity type of the specifired user.
    
    Parameters:
    
    userIdentityType - Indicates the identity type of the specifired user.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserIdentityType
  - setWorkspaceType
```
public void setWorkspaceType(String workspaceType)
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    Parameters:
    
    workspaceType - Indicates whether the directory's WorkSpace type is personal or pools.
    
    See Also:
    
    WorkspaceType
  - getWorkspaceType
```
public String getWorkspaceType()
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    Returns:
    
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    See Also:
    
    WorkspaceType
  - withWorkspaceType
```
public WorkspaceDirectory withWorkspaceType(String workspaceType)
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    Parameters:
    
    workspaceType - Indicates whether the directory's WorkSpace type is personal or pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceType
  - setWorkspaceType
```
public void setWorkspaceType(WorkspaceType workspaceType)
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    Parameters:
    
    workspaceType - Indicates whether the directory's WorkSpace type is personal or pools.
    
    See Also:
    
    WorkspaceType
  - withWorkspaceType
```
public WorkspaceDirectory withWorkspaceType(WorkspaceType workspaceType)
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    Parameters:
    
    workspaceType - Indicates whether the directory's WorkSpace type is personal or pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceType
  - setActiveDirectoryConfig
```
public void setActiveDirectoryConfig(ActiveDirectoryConfig activeDirectoryConfig)
```
    Information about the Active Directory config.
    
    Parameters:
    
    activeDirectoryConfig - Information about the Active Directory config.
  - getActiveDirectoryConfig
```
public ActiveDirectoryConfig getActiveDirectoryConfig()
```
    Information about the Active Directory config.
    
    Returns:
    
    Information about the Active Directory config.
  - withActiveDirectoryConfig
```
public WorkspaceDirectory withActiveDirectoryConfig(ActiveDirectoryConfig activeDirectoryConfig)
```
    Information about the Active Directory config.
    
    Parameters:
    
    activeDirectoryConfig - Information about the Active Directory config.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStreamingProperties
```
public void setStreamingProperties(StreamingProperties streamingProperties)
```
    The streaming properties to configure.
    
    Parameters:
    
    streamingProperties - The streaming properties to configure.
  - getStreamingProperties
```
public StreamingProperties getStreamingProperties()
```
    The streaming properties to configure.
    
    Returns:
    
    The streaming properties to configure.
  - withStreamingProperties
```
public WorkspaceDirectory withStreamingProperties(StreamingProperties streamingProperties)
```
    The streaming properties to configure.
    
    Parameters:
    
    streamingProperties - The streaming properties to configure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    The error message returned.
    
    Parameters:
    
    errorMessage - The error message returned.
  - getErrorMessage
```
public String getErrorMessage()
```
    The error message returned.
    
    Returns:
    
    The error message returned.
  - withErrorMessage
```
public WorkspaceDirectory withErrorMessage(String errorMessage)
```
    The error message returned.
    
    Parameters:
    
    errorMessage - The error message returned.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkspaceDirectory clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.782

Class WorkspaceDirectory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceDirectory

Method Detail

setDirectoryId

getDirectoryId

withDirectoryId

setAlias

getAlias

withAlias

setDirectoryName

getDirectoryName

withDirectoryName

setRegistrationCode

getRegistrationCode

withRegistrationCode

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getDnsIpAddresses

setDnsIpAddresses

withDnsIpAddresses

withDnsIpAddresses

setCustomerUserName

getCustomerUserName

withCustomerUserName

setIamRoleId

getIamRoleId

withIamRoleId

setDirectoryType

getDirectoryType

withDirectoryType

setDirectoryType

withDirectoryType

setWorkspaceSecurityGroupId

getWorkspaceSecurityGroupId

withWorkspaceSecurityGroupId

setState

getState

withState

setState

withState

setWorkspaceCreationProperties

getWorkspaceCreationProperties

withWorkspaceCreationProperties

getIpGroupIds

setIpGroupIds

withIpGroupIds

withIpGroupIds

setWorkspaceAccessProperties

getWorkspaceAccessProperties

withWorkspaceAccessProperties

setTenancy

getTenancy

withTenancy

setTenancy

withTenancy

setSelfservicePermissions

getSelfservicePermissions

withSelfservicePermissions

setSamlProperties

getSamlProperties

withSamlProperties

setCertificateBasedAuthProperties

getCertificateBasedAuthProperties

withCertificateBasedAuthProperties

setWorkspaceDirectoryName

getWorkspaceDirectoryName

withWorkspaceDirectoryName

setWorkspaceDirectoryDescription

getWorkspaceDirectoryDescription

withWorkspaceDirectoryDescription

setUserIdentityType

getUserIdentityType

withUserIdentityType