Interface RegisterWorkspaceDirectoryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>, SdkBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>, SdkPojo, SdkRequest.Builder, WorkSpacesRequest.Builder
Enclosing class:
RegisterWorkspaceDirectoryRequest
@Mutable @NotThreadSafe public static interface RegisterWorkspaceDirectoryRequest.Builder extends WorkSpacesRequest.Builder, SdkPojo, CopyableBuilder<RegisterWorkspaceDirectoryRequest.Builder,RegisterWorkspaceDirectoryRequest>

  • Method Details

    • directoryId

      RegisterWorkspaceDirectoryRequest.Builder directoryId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      RegisterWorkspaceDirectoryRequest.Builder subnetIds(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      RegisterWorkspaceDirectoryRequest.Builder subnetIds(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • enableSelfService

      RegisterWorkspaceDirectoryRequest.Builder enableSelfService(Boolean enableSelfService)

      Indicates whether self-service capabilities are enabled or disabled.

      Parameters:
      enableSelfService - Indicates whether self-service capabilities are enabled or disabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tenancy

      RegisterWorkspaceDirectoryRequest.Builder tenancy(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tenancy

      RegisterWorkspaceDirectoryRequest.Builder tenancy(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      RegisterWorkspaceDirectoryRequest.Builder tags(Collection<Tag> tags)

      The tags associated with the directory.

      Parameters:
      tags - The tags associated with the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterWorkspaceDirectoryRequest.Builder tags(Tag... tags)

      The tags associated with the directory.

      Parameters:
      tags - The tags associated with the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      RegisterWorkspaceDirectoryRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags associated with the directory.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceDirectoryName

      RegisterWorkspaceDirectoryRequest.Builder workspaceDirectoryName(String workspaceDirectoryName)

      The name of the directory to register.

      Parameters:
      workspaceDirectoryName - The name of the directory to register.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceDirectoryDescription

      RegisterWorkspaceDirectoryRequest.Builder workspaceDirectoryDescription(String workspaceDirectoryDescription)

      Description of the directory to register.

      Parameters:
      workspaceDirectoryDescription - Description of the directory to register.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userIdentityType

      RegisterWorkspaceDirectoryRequest.Builder userIdentityType(String userIdentityType)

      The type of identity management the user is using.

      Parameters:
      userIdentityType - The type of identity management the user is using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userIdentityType

      RegisterWorkspaceDirectoryRequest.Builder userIdentityType(UserIdentityType userIdentityType)

      The type of identity management the user is using.

      Parameters:
      userIdentityType - The type of identity management the user is using.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • idcInstanceArn

      RegisterWorkspaceDirectoryRequest.Builder idcInstanceArn(String idcInstanceArn)

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

      Parameters:
      idcInstanceArn - The Amazon Resource Name (ARN) of the identity center instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • microsoftEntraConfig

      RegisterWorkspaceDirectoryRequest.Builder microsoftEntraConfig(MicrosoftEntraConfig microsoftEntraConfig)

      The details about Microsoft Entra config.

      Parameters:
      microsoftEntraConfig - The details about Microsoft Entra config.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • microsoftEntraConfig

      default RegisterWorkspaceDirectoryRequest.Builder microsoftEntraConfig(Consumer<MicrosoftEntraConfig.Builder> microsoftEntraConfig)

      The details about Microsoft Entra config.

      This is a convenience method that creates an instance of the MicrosoftEntraConfig.Builder avoiding the need to create one manually via MicrosoftEntraConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to microsoftEntraConfig(MicrosoftEntraConfig).

      Parameters:
      microsoftEntraConfig - a consumer that will call methods on MicrosoftEntraConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceType

      RegisterWorkspaceDirectoryRequest.Builder workspaceType(String workspaceType)

      Indicates whether the directory's WorkSpace type is personal or pools.

      Parameters:
      workspaceType - Indicates whether the directory's WorkSpace type is personal or pools.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceType

      RegisterWorkspaceDirectoryRequest.Builder workspaceType(WorkspaceType workspaceType)

      Indicates whether the directory's WorkSpace type is personal or pools.

      Parameters:
      workspaceType - Indicates whether the directory's WorkSpace type is personal or pools.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • activeDirectoryConfig

      RegisterWorkspaceDirectoryRequest.Builder activeDirectoryConfig(ActiveDirectoryConfig activeDirectoryConfig)

      The active directory config of the directory.

      Parameters:
      activeDirectoryConfig - The active directory config of the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeDirectoryConfig

      default RegisterWorkspaceDirectoryRequest.Builder activeDirectoryConfig(Consumer<ActiveDirectoryConfig.Builder> activeDirectoryConfig)

      The active directory config of the directory.

      This is a convenience method that creates an instance of the ActiveDirectoryConfig.Builder avoiding the need to create one manually via ActiveDirectoryConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to activeDirectoryConfig(ActiveDirectoryConfig).

      Parameters:
      activeDirectoryConfig - a consumer that will call methods on ActiveDirectoryConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      RegisterWorkspaceDirectoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      RegisterWorkspaceDirectoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.