Class RegisterWorkspaceDirectoryRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.workspaces.model.WorkSpacesRequest
software.amazon.awssdk.services.workspaces.model.RegisterWorkspaceDirectoryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>
@Generated("software.amazon.awssdk:codegen") public final class RegisterWorkspaceDirectoryRequest extends WorkSpacesRequest implements ToCopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>

  • Method Details

    • directoryId

      public final String directoryId()

      The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

      Returns:
      The identifier of the directory. You cannot register a directory if it does not have a status of Active. If the directory does not have a status of Active, you will receive an InvalidResourceStateException error. If you have already registered the maximum number of directories that you can register with Amazon WorkSpaces, you will receive a ResourceLimitExceededException error. Deregister directories that you are not using for WorkSpaces, and try again.

    • 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 for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

      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 for your virtual private cloud (VPC). Make sure that the subnets are in supported Availability Zones. The subnets must also be in separate Availability Zones. If these conditions are not met, you will receive an OperationNotSupportedException error.

    • enableWorkDocs

      public final Boolean enableWorkDocs()

      Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

      Returns:
      Indicates whether Amazon WorkDocs is enabled or disabled. If you have enabled this parameter and WorkDocs is not available in the Region, you will receive an OperationNotSupportedException error. Set EnableWorkDocs to disabled, and try again.

    • enableSelfService

      public final Boolean enableSelfService()

      Indicates whether self-service capabilities are enabled or disabled.

      Returns:
      Indicates whether self-service capabilities are enabled or disabled.

    • tenancy

      public final Tenancy tenancy()

      Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, 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:
      Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
      See Also:

    • tenancyAsString

      public final String tenancyAsString()

      Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, 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:
      Indicates whether your WorkSpace directory is dedicated or shared. To use Bring Your Own License (BYOL) images, this value must be set to DEDICATED and your Amazon Web Services account must be enabled for BYOL. If your account has not been enabled for BYOL, you will receive an InvalidParameterValuesException error. For more information about BYOL images, see Bring Your Own Windows Desktop Images.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags 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 hasTags() method.

      Returns:
      The tags associated with the directory.

    • workspaceDirectoryName

      public final String workspaceDirectoryName()

      The name of the directory to register.

      Returns:
      The name of the directory to register.

    • workspaceDirectoryDescription

      public final String workspaceDirectoryDescription()

      Description of the directory to register.

      Returns:
      Description of the directory to register.

    • userIdentityType

      public final UserIdentityType userIdentityType()

      The type of identity management the user is using.

      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:
      The type of identity management the user is using.
      See Also:

    • userIdentityTypeAsString

      public final String userIdentityTypeAsString()

      The type of identity management the user is using.

      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:
      The type of identity management the user is using.
      See Also:

    • idcInstanceArn

      public final String idcInstanceArn()

      The Amazon Resource Name (ARN) of the identity center instance.

      Returns:
      The Amazon Resource Name (ARN) of the identity center instance.

    • microsoftEntraConfig

      public final MicrosoftEntraConfig microsoftEntraConfig()

      The details about Microsoft Entra config.

      Returns:
      The details about Microsoft Entra config.

    • 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:

    • 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:

    • activeDirectoryConfig

      public final ActiveDirectoryConfig activeDirectoryConfig()

      The active directory config of the directory.

      Returns:
      The active directory config of the directory.

    • toBuilder

      public RegisterWorkspaceDirectoryRequest.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<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>
      Specified by:
      toBuilder in class WorkSpacesRequest
      Returns:
      a builder for type T

    • builder

      public static RegisterWorkspaceDirectoryRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegisterWorkspaceDirectoryRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final 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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.