WorkspaceDirectory (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.workspaces.model.WorkspaceDirectory

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>
```
@Generated("software.amazon.awssdk:codegen")
public class WorkspaceDirectory
extends Object
implements StructuredPojo, ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>
```
Contains information about an AWS Directory Service directory for use with Amazon WorkSpaces.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkspaceDirectory.Builder

Nested Classes
Modifier and Type	Class	Description
`static interface`	`WorkspaceDirectory.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`alias()`	The directory alias.
`static WorkspaceDirectory.Builder`	`builder()`
`String`	`customerUserName()`	The user name for the service account.
`String`	`directoryId()`	The directory identifier.
`String`	`directoryName()`	The name of the directory.
`String`	`directoryType()`	The directory type.
`List<String>`	`dnsIpAddresses()`	An array of strings that contains the IP addresses of the DNS servers for the directory.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`String`	`iamRoleId()`	The identifier of the IAM role.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`	Marshalls this structured data using the given `ProtocolMarshaller`.
`String`	`registrationCode()`	The registration code for the directory.
`static Class<? extends WorkspaceDirectory.Builder>`	`serializableBuilderClass()`
`String`	`state()`	The state of the directory's registration with Amazon WorkSpaces
`List<String>`	`subnetIds()`	An array of strings that contains the identifiers of the subnets used with the directory.
`WorkspaceDirectory.Builder`	`toBuilder()`	Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`DefaultWorkspaceCreationProperties`	`workspaceCreationProperties()`	A structure that specifies the default creation properties for all WorkSpaces in the directory.
`String`	`workspaceSecurityGroupId()`	The identifier of the security group that is assigned to new WorkSpaces.

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

- Method Detail
  - directoryId
```
public String directoryId()
```
    The directory identifier.
    
    Returns:
    
    The directory identifier.
  - alias
```
public String alias()
```
    The directory alias.
    
    Returns:
    
    The directory alias.
  - directoryName
```
public String directoryName()
```
    The name of the directory.
    
    Returns:
    
    The name of the directory.
  - registrationCode
```
public 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:
    
    The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.
  - subnetIds
```
public List<String> subnetIds()
```
    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.
  - dnsIpAddresses
```
public List<String> dnsIpAddresses()
```
    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.
  - customerUserName
```
public String customerUserName()
```
    The user name for the service account.
    
    Returns:
    
    The user name for the service account.
  - iamRoleId
```
public 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:
    
    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.
  - directoryType
```
public String directoryType()
```
    The directory type.
    
    Returns:
    
    The directory type.
    
    See Also:
    
    WorkspaceDirectoryType
  - workspaceSecurityGroupId
```
public String workspaceSecurityGroupId()
```
    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.
  - state
```
public String state()
```
    The state of the directory's registration with Amazon WorkSpaces
    
    Returns:
    
    The state of the directory's registration with Amazon WorkSpaces
    
    See Also:
    
    WorkspaceDirectoryState
  - workspaceCreationProperties
```
public DefaultWorkspaceCreationProperties workspaceCreationProperties()
```
    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.
  - toBuilder
```
public WorkspaceDirectory.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>
    
    Returns:
    
    a builder for type T
  - builder
```
public static WorkspaceDirectory.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkspaceDirectory.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString 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.

Class WorkspaceDirectory

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

directoryId

alias

directoryName

registrationCode

subnetIds

dnsIpAddresses

customerUserName

iamRoleId

directoryType

workspaceSecurityGroupId

state

workspaceCreationProperties

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

marshall