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

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>

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

Describes a directory that is used with Amazon WorkSpaces.

See Also:: Serialized Form

Nested Class Summary

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
`ActiveDirectoryConfig`	`activeDirectoryConfig()`	Information about the Active Directory config.
`String`	`alias()`	The directory alias.
`static WorkspaceDirectory.Builder`	`builder()`
`CertificateBasedAuthProperties`	`certificateBasedAuthProperties()`	The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
`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)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorMessage()`	The error message returned.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDnsIpAddresses()`	For responses, this returns true if the service returned a value for the DnsIpAddresses property.
`int`	`hashCode()`
`boolean`	`hasIpGroupIds()`	For responses, this returns true if the service returned a value for the IpGroupIds property.
`boolean`	`hasSubnetIds()`	For responses, this returns true if the service returned a value for the SubnetIds property.
`String`	`iamRoleId()`	The identifier of the IAM role.
`IDCConfig`	`idcConfig()`	Specifies details about identity center configurations.
`List<String>`	`ipGroupIds()`	The identifiers of the IP access control groups associated with the directory.
`MicrosoftEntraConfig`	`microsoftEntraConfig()`	Specifies details about Microsoft Entra configurations.
`String`	`registrationCode()`	The registration code for the directory.
`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.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`SelfservicePermissions`	`selfservicePermissions()`	The default self-service permissions for WorkSpaces in the directory.
`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.
`StreamingProperties`	`streamingProperties()`	The streaming properties to configure.
`List<String>`	`subnetIds()`	The identifiers of the subnets used with the directory.
`Tenancy`	`tenancy()`	Specifies whether the directory is dedicated or shared.
`String`	`tenancyAsString()`	Specifies whether the directory is dedicated or shared.
`WorkspaceDirectory.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UserIdentityType`	`userIdentityType()`	Indicates the identity type of the specifired user.
`String`	`userIdentityTypeAsString()`	Indicates the identity type of the specifired user.
`WorkspaceAccessProperties`	`workspaceAccessProperties()`	The devices and operating systems that users can use to access WorkSpaces.
`DefaultWorkspaceCreationProperties`	`workspaceCreationProperties()`	The default creation properties for all WorkSpaces in the directory.
`String`	`workspaceDirectoryDescription()`	The description of the WorkSpace directory
`String`	`workspaceDirectoryName()`	The name fo the WorkSpace directory.
`String`	`workspaceSecurityGroupId()`	The identifier of the security group that is assigned to new WorkSpaces.
`WorkspaceType`	`workspaceType()`	Indicates whether the directory's WorkSpace type is personal or pools.
`String`	`workspaceTypeAsString()`	Indicates whether the directory's WorkSpace type is personal or pools.

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

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

- Method Detail
  - directoryId
```
public final String directoryId()
```
    The directory identifier.
    
    Returns:
    
    The directory identifier.
  - alias
```
public final String alias()
```
    The directory alias.
    
    Returns:
    
    The directory alias.
  - directoryName
```
public final String directoryName()
```
    The name of the directory.
    
    Returns:
    
    The name of the directory.
  - registrationCode
```
public final 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.
  - hasSubnetIds
```
public final boolean hasSubnetIds()
```
    For responses, this returns true if the service returned a value for the SubnetIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - subnetIds
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSubnetIds() method.
    
    Returns:
    
    The identifiers of the subnets used with the directory.
  - hasDnsIpAddresses
```
public final boolean hasDnsIpAddresses()
```
    For responses, this returns true if the service returned a value for the DnsIpAddresses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - dnsIpAddresses
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDnsIpAddresses() method.
    
    Returns:
    
    The IP addresses of the DNS servers for the directory.
  - customerUserName
```
public final String customerUserName()
```
    The user name for the service account.
    
    Returns:
    
    The user name for the service account.
  - iamRoleId
```
public final 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 final 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 final 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 final 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 final 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.
    
    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. 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
  - stateAsString
```
public final String stateAsString()
```
    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.
    
    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. 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
  - workspaceCreationProperties
```
public final DefaultWorkspaceCreationProperties workspaceCreationProperties()
```
    The default creation properties for all WorkSpaces in the directory.
    
    Returns:
    
    The default creation properties for all WorkSpaces in the directory.
  - hasIpGroupIds
```
public final boolean hasIpGroupIds()
```
    For responses, this returns true if the service returned a value for the IpGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - ipGroupIds
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIpGroupIds() method.
    
    Returns:
    
    The identifiers of the IP access control groups associated with the directory.
  - workspaceAccessProperties
```
public final WorkspaceAccessProperties workspaceAccessProperties()
```
    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.
  - tenancy
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    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
  - tenancyAsString
```
public final String tenancyAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, tenancy will return Tenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from tenancyAsString().
    
    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
  - selfservicePermissions
```
public final SelfservicePermissions selfservicePermissions()
```
    The default self-service permissions for WorkSpaces in the directory.
    
    Returns:
    
    The default self-service permissions for WorkSpaces in the directory.
  - samlProperties
```
public final 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.
    
    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.
  - certificateBasedAuthProperties
```
public final CertificateBasedAuthProperties certificateBasedAuthProperties()
```
    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.
  - microsoftEntraConfig
```
public final MicrosoftEntraConfig microsoftEntraConfig()
```
    Specifies details about Microsoft Entra configurations.
    
    Returns:
    
    Specifies details about Microsoft Entra configurations.
  - workspaceDirectoryName
```
public final String workspaceDirectoryName()
```
    The name fo the WorkSpace directory.
    
    Returns:
    
    The name fo the WorkSpace directory.
  - workspaceDirectoryDescription
```
public final String workspaceDirectoryDescription()
```
    The description of the WorkSpace directory
    
    Returns:
    
    The description of the WorkSpace directory
  - userIdentityType
```
public final UserIdentityType userIdentityType()
```
    Indicates the identity type of the specifired user.
    
    If the service returns an enum value that is not available in the current SDK version, userIdentityType will return UserIdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userIdentityTypeAsString().
    
    Returns:
    
    Indicates the identity type of the specifired user.
    
    See Also:
    
    UserIdentityType
  - userIdentityTypeAsString
```
public final String userIdentityTypeAsString()
```
    Indicates the identity type of the specifired user.
    
    If the service returns an enum value that is not available in the current SDK version, userIdentityType will return UserIdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userIdentityTypeAsString().
    
    Returns:
    
    Indicates the identity type of the specifired user.
    
    See Also:
    
    UserIdentityType
  - workspaceType
```
public final WorkspaceType workspaceType()
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    If the service returns an enum value that is not available in the current SDK version, workspaceType will return WorkspaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workspaceTypeAsString().
    
    Returns:
    
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    See Also:
    
    WorkspaceType
  - workspaceTypeAsString
```
public final String workspaceTypeAsString()
```
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    If the service returns an enum value that is not available in the current SDK version, workspaceType will return WorkspaceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from workspaceTypeAsString().
    
    Returns:
    
    Indicates whether the directory's WorkSpace type is personal or pools.
    
    See Also:
    
    WorkspaceType
  - idcConfig
```
public final IDCConfig idcConfig()
```
    Specifies details about identity center configurations.
    
    Returns:
    
    Specifies details about identity center configurations.
  - activeDirectoryConfig
```
public final ActiveDirectoryConfig activeDirectoryConfig()
```
    Information about the Active Directory config.
    
    Returns:
    
    Information about the Active Directory config.
  - streamingProperties
```
public final StreamingProperties streamingProperties()
```
    The streaming properties to configure.
    
    Returns:
    
    The streaming properties to configure.
  - errorMessage
```
public final String errorMessage()
```
    The error message returned.
    
    Returns:
    
    The error message returned.
  - toBuilder
```
public WorkspaceDirectory.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>
  - builder
```
public static WorkspaceDirectory.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkspaceDirectory.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class WorkspaceDirectory

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

directoryId

alias

directoryName

registrationCode

hasSubnetIds

subnetIds

hasDnsIpAddresses

dnsIpAddresses

customerUserName

iamRoleId

directoryType

directoryTypeAsString

workspaceSecurityGroupId

state

stateAsString

workspaceCreationProperties

hasIpGroupIds

ipGroupIds

workspaceAccessProperties

tenancy

tenancyAsString

selfservicePermissions

samlProperties

certificateBasedAuthProperties

microsoftEntraConfig

workspaceDirectoryName

workspaceDirectoryDescription

userIdentityType

userIdentityTypeAsString

workspaceType

workspaceTypeAsString

idcConfig

activeDirectoryConfig

streamingProperties

errorMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField