software.amazon.awssdk.services.workspaces.model

Class WorkspaceDirectory

java.lang.Object

software.amazon.awssdk.services.workspaces.model.WorkspaceDirectory

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkspaceDirectory
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>

Describes an AWS Directory Service directory that is used with Amazon WorkSpaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkspaceDirectory.Builder

Method Summary

Modifier and Type	Method and 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.
WorkspaceDirectoryType	directoryType() The directory type.
String	directoryTypeAsString() The directory type.
List<String>	dnsIpAddresses() The IP addresses of the DNS servers for the directory.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	iamRoleId() The identifier of the IAM role.
List<String>	ipGroupIds() The identifiers of the IP access control groups associated with the directory.
String	registrationCode() The registration code for the directory.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkspaceDirectory.Builder>	serializableBuilderClass()
WorkspaceDirectoryState	state() The state of the directory's registration with Amazon WorkSpaces
String	stateAsString() The state of the directory's registration with Amazon WorkSpaces
List<String>	subnetIds() 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() 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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

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()

The identifiers of the subnets used with the directory.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The identifiers of the subnets used with the directory.

dnsIpAddresses

public List<String> dnsIpAddresses()

The IP addresses of the DNS servers for the directory.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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 WorkspaceDirectoryType directoryType()

The directory type.

If the service returns an enum value that is not available in the current SDK version, directoryType will return WorkspaceDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directoryTypeAsString().

Returns:

The directory type.

See Also:

WorkspaceDirectoryType

directoryTypeAsString

public String directoryTypeAsString()

The directory type.

If the service returns an enum value that is not available in the current SDK version, directoryType will return WorkspaceDirectoryType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from directoryTypeAsString().

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 WorkspaceDirectoryState state()

The state of the directory's registration with Amazon WorkSpaces

If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceDirectoryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the directory's registration with Amazon WorkSpaces

See Also:

WorkspaceDirectoryState

stateAsString

public String stateAsString()

The state of the directory's registration with Amazon WorkSpaces

If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceDirectoryState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

Returns:

The state of the directory's registration with Amazon WorkSpaces

See Also:

WorkspaceDirectoryState

workspaceCreationProperties

public DefaultWorkspaceCreationProperties workspaceCreationProperties()

The default creation properties for all WorkSpaces in the directory.

Returns:

The default creation properties for all WorkSpaces in the directory.

ipGroupIds

public List<String> ipGroupIds()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The identifiers of the IP access control groups associated with 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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.