WorkspaceDirectory (AWS SDK For Java for OSGi 1.9.36 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class WorkspaceDirectory
extends Object
implements Serializable, Cloneable
```
Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceDirectory()

Constructors
Constructor and Description
`WorkspaceDirectory()`

Method Summary

Methods
Modifier and Type	Method and Description
`WorkspaceDirectory`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAlias()` The directory alias.
`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()` An array of strings that contains the IP addresses of the DNS servers for the directory.
`String`	`getIamRoleId()` The identifier of the IAM role.
`String`	`getRegistrationCode()` The registration code for the directory.
`String`	`getState()` The state of the directory's registration with Amazon WorkSpaces
`List<String>`	`getSubnetIds()` An array of strings that contains the identifiers of the subnets used with the directory.
`DefaultWorkspaceCreationProperties`	`getWorkspaceCreationProperties()` A structure that specifies the default creation properties for all WorkSpaces in the directory.
`String`	`getWorkspaceSecurityGroupId()` The identifier of the security group that is assigned to new WorkSpaces.
`int`	`hashCode()`
`void`	`setAlias(String alias)` The directory alias.
`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)` An array of strings that contains the IP addresses of the DNS servers for the directory.
`void`	`setIamRoleId(String iamRoleId)` The identifier of the IAM role.
`void`	`setRegistrationCode(String registrationCode)` The registration code for 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`	`setSubnetIds(Collection<String> subnetIds)` An array of strings that contains the identifiers of the subnets used with the directory.
`void`	`setWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)` A structure that specifies the default creation properties for all WorkSpaces in the directory.
`void`	`setWorkspaceSecurityGroupId(String workspaceSecurityGroupId)` The identifier of the security group that is assigned to new WorkSpaces.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`WorkspaceDirectory`	`withAlias(String alias)` The directory alias.
`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)` An array of strings that contains the IP addresses of the DNS servers for the directory.
`WorkspaceDirectory`	`withDnsIpAddresses(String... dnsIpAddresses)` An array of strings that contains the IP addresses of the DNS servers for the directory.
`WorkspaceDirectory`	`withIamRoleId(String iamRoleId)` The identifier of the IAM role.
`WorkspaceDirectory`	`withRegistrationCode(String registrationCode)` The registration code for 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`	`withSubnetIds(Collection<String> subnetIds)` An array of strings that contains the identifiers of the subnets used with the directory.
`WorkspaceDirectory`	`withSubnetIds(String... subnetIds)` An array of strings that contains the identifiers of the subnets used with the directory.
`WorkspaceDirectory`	`withWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)` A structure that specifies the default creation properties for all WorkSpaces in the directory.
`WorkspaceDirectory`	`withWorkspaceSecurityGroupId(String workspaceSecurityGroupId)` The identifier of the security group that is assigned to new WorkSpaces.

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

- Constructor Detail
  - WorkspaceDirectory
```
public WorkspaceDirectory()
```
- Method Detail
  - getDirectoryId
```
public String getDirectoryId()
```
    The directory identifier.
    Constraints:
    Pattern: ^d-[0-9a-f]{8,63}$
    
    Returns:
    The directory identifier.
  - setDirectoryId
```
public void setDirectoryId(String directoryId)
```
    The directory identifier.
    Constraints:
    Pattern: ^d-[0-9a-f]{8,63}$
    
    Parameters:
    directoryId - The directory identifier.
  - withDirectoryId
```
public WorkspaceDirectory withDirectoryId(String directoryId)
```
    The directory identifier.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^d-[0-9a-f]{8,63}$
    
    Parameters:
    directoryId - The directory identifier.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getAlias
```
public String getAlias()
```
    The directory alias.
    
    Returns:
    The directory alias.
  - setAlias
```
public void setAlias(String alias)
```
    The directory alias.
    
    Parameters:
    alias - The directory alias.
  - withAlias
```
public WorkspaceDirectory withAlias(String alias)
```
    The directory alias.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    alias - The directory alias.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDirectoryName
```
public String getDirectoryName()
```
    The name of the directory.
    
    Returns:
    The name of the directory.
  - setDirectoryName
```
public void setDirectoryName(String directoryName)
```
    The name of the directory.
    
    Parameters:
    directoryName - The name of the directory.
  - withDirectoryName
```
public WorkspaceDirectory withDirectoryName(String directoryName)
```
    The name of the directory.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    directoryName - The name of the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Constraints:
    Length: 1 - 20
    
    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.
  - 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.
    Constraints:
    Length: 1 - 20
    
    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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 20
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getSubnetIds
```
public List<String> getSubnetIds()
```
    An array of strings that contains the identifiers of the subnets used with the directory.
    
    Returns:
    An array of strings that contains the identifiers of the subnets used with the directory.
  - setSubnetIds
```
public void setSubnetIds(Collection<String> subnetIds)
```
    An array of strings that contains the identifiers of the subnets used with the directory.
    
    Parameters:
    subnetIds - An array of strings that contains the identifiers of the subnets used with the directory.
  - withSubnetIds
```
public WorkspaceDirectory withSubnetIds(String... subnetIds)
```
    An array of strings that contains 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    subnetIds - An array of strings that contains the identifiers of the subnets used with the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withSubnetIds
```
public WorkspaceDirectory withSubnetIds(Collection<String> subnetIds)
```
    An array of strings that contains the identifiers of the subnets used with the directory.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    subnetIds - An array of strings that contains the identifiers of the subnets used with the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDnsIpAddresses
```
public List<String> getDnsIpAddresses()
```
    An array of strings that contains the IP addresses of the DNS servers for the directory.
    
    Returns:
    An array of strings that contains the IP addresses of the DNS servers for the directory.
  - setDnsIpAddresses
```
public void setDnsIpAddresses(Collection<String> dnsIpAddresses)
```
    An array of strings that contains the IP addresses of the DNS servers for the directory.
    
    Parameters:
    dnsIpAddresses - An array of strings that contains the IP addresses of the DNS servers for the directory.
  - withDnsIpAddresses
```
public WorkspaceDirectory withDnsIpAddresses(String... dnsIpAddresses)
```
    An array of strings that contains 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.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    dnsIpAddresses - An array of strings that contains the IP addresses of the DNS servers for the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - withDnsIpAddresses
```
public WorkspaceDirectory withDnsIpAddresses(Collection<String> dnsIpAddresses)
```
    An array of strings that contains the IP addresses of the DNS servers for the directory.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    dnsIpAddresses - An array of strings that contains the IP addresses of the DNS servers for the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getCustomerUserName
```
public String getCustomerUserName()
```
    The user name for the service account.
    Constraints:
    Length: 1 - 63
    
    Returns:
    The user name for the service account.
  - setCustomerUserName
```
public void setCustomerUserName(String customerUserName)
```
    The user name for the service account.
    Constraints:
    Length: 1 - 63
    
    Parameters:
    customerUserName - The user name for the service account.
  - withCustomerUserName
```
public WorkspaceDirectory withCustomerUserName(String customerUserName)
```
    The user name for the service account.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 63
    
    Parameters:
    customerUserName - The user name for the service account.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - 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.
    Constraints:
    Pattern: ^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$
    
    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.
  - 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.
    Constraints:
    Pattern: ^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$
    
    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.
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^arn:aws:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-za-z0-9_/.-]{0,127}$
    
    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:
    A reference to this updated object so that method calls can be chained together.
  - getDirectoryType
```
public String getDirectoryType()
```
    The directory type.
    Constraints:
    Allowed Values: SIMPLE_AD, AD_CONNECTOR
    
    Returns:
    The directory type.
    See Also:
    WorkspaceDirectoryType
  - setDirectoryType
```
public void setDirectoryType(String directoryType)
```
    The directory type.
    Constraints:
    Allowed Values: SIMPLE_AD, AD_CONNECTOR
    
    Parameters:
    directoryType - The directory type.
    See Also:
    WorkspaceDirectoryType
  - withDirectoryType
```
public WorkspaceDirectory withDirectoryType(String directoryType)
```
    The directory type.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SIMPLE_AD, AD_CONNECTOR
    
    Parameters:
    directoryType - The directory type.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    WorkspaceDirectoryType
  - setDirectoryType
```
public void setDirectoryType(WorkspaceDirectoryType directoryType)
```
    The directory type.
    Constraints:
    Allowed Values: SIMPLE_AD, AD_CONNECTOR
    
    Parameters:
    directoryType - The directory type.
    See Also:
    WorkspaceDirectoryType
  - withDirectoryType
```
public WorkspaceDirectory withDirectoryType(WorkspaceDirectoryType directoryType)
```
    The directory type.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SIMPLE_AD, AD_CONNECTOR
    
    Parameters:
    directoryType - The directory type.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    WorkspaceDirectoryType
  - getWorkspaceSecurityGroupId
```
public String getWorkspaceSecurityGroupId()
```
    The identifier of the security group that is assigned to new WorkSpaces.
    Constraints:
    Pattern: ^(sg-[0-9a-f]{8})$
    
    Returns:
    The identifier of the security group that is assigned to new WorkSpaces.
  - setWorkspaceSecurityGroupId
```
public void setWorkspaceSecurityGroupId(String workspaceSecurityGroupId)
```
    The identifier of the security group that is assigned to new WorkSpaces.
    Constraints:
    Pattern: ^(sg-[0-9a-f]{8})$
    
    Parameters:
    workspaceSecurityGroupId - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^(sg-[0-9a-f]{8})$
    
    Parameters:
    workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getState
```
public String getState()
```
    The state of the directory's registration with Amazon WorkSpaces
    Constraints:
    Allowed Values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR
    
    Returns:
    The state of the directory's registration with Amazon WorkSpaces
    See Also:
    WorkspaceDirectoryState
  - setState
```
public void setState(String state)
```
    The state of the directory's registration with Amazon WorkSpaces
    Constraints:
    Allowed Values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR
    
    Parameters:
    state - The state of the directory's registration with Amazon WorkSpaces
    See Also:
    WorkspaceDirectoryState
  - withState
```
public WorkspaceDirectory withState(String state)
```
    The state of the directory's registration with Amazon WorkSpaces
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR
    
    Parameters:
    state - The state of the directory's registration with Amazon WorkSpaces
    
    Returns:
    A reference to this updated 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
    Constraints:
    Allowed Values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR
    
    Parameters:
    state - The state of the directory's registration with Amazon WorkSpaces
    See Also:
    WorkspaceDirectoryState
  - withState
```
public WorkspaceDirectory withState(WorkspaceDirectoryState state)
```
    The state of the directory's registration with Amazon WorkSpaces
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: REGISTERING, REGISTERED, DEREGISTERING, DEREGISTERED, ERROR
    
    Parameters:
    state - The state of the directory's registration with Amazon WorkSpaces
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    WorkspaceDirectoryState
  - getWorkspaceCreationProperties
```
public DefaultWorkspaceCreationProperties getWorkspaceCreationProperties()
```
    A structure that specifies the default creation properties for all WorkSpaces in the directory.
    
    Returns:
    A structure that specifies the default creation properties for all WorkSpaces in the directory.
  - setWorkspaceCreationProperties
```
public void setWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)
```
    A structure that specifies the default creation properties for all WorkSpaces in the directory.
    
    Parameters:
    workspaceCreationProperties - A structure that specifies the default creation properties for all WorkSpaces in the directory.
  - withWorkspaceCreationProperties
```
public WorkspaceDirectory withWorkspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)
```
    A structure that specifies the default creation properties for all WorkSpaces in the directory.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    workspaceCreationProperties - A structure that specifies the default creation properties for all WorkSpaces in the directory.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public WorkspaceDirectory clone()
```
    Overrides:
    
    clone in class Object

Class WorkspaceDirectory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceDirectory

Method Detail

getDirectoryId

setDirectoryId

withDirectoryId

getAlias

setAlias

withAlias

getDirectoryName

setDirectoryName

withDirectoryName

getRegistrationCode

setRegistrationCode

withRegistrationCode

getSubnetIds

setSubnetIds

withSubnetIds

withSubnetIds

getDnsIpAddresses

setDnsIpAddresses

withDnsIpAddresses

withDnsIpAddresses

getCustomerUserName

setCustomerUserName

withCustomerUserName

getIamRoleId

setIamRoleId

withIamRoleId

getDirectoryType

setDirectoryType

withDirectoryType

setDirectoryType

withDirectoryType

getWorkspaceSecurityGroupId

setWorkspaceSecurityGroupId

withWorkspaceSecurityGroupId

getState

setState

withState

setState

withState

getWorkspaceCreationProperties

setWorkspaceCreationProperties

withWorkspaceCreationProperties

toString

hashCode

equals

clone