Interface WorkspaceDirectory.Builder

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

  • Method Details

    • directoryId

      WorkspaceDirectory.Builder directoryId(String directoryId)

      The directory identifier.

      Parameters:
      directoryId - The directory identifier.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • alias

      WorkspaceDirectory.Builder alias(String alias)

      The directory alias.

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

    • directoryName

      WorkspaceDirectory.Builder directoryName(String directoryName)

      The name of the directory.

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

    • registrationCode

      WorkspaceDirectory.Builder registrationCode(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.

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

    • subnetIds

      WorkspaceDirectory.Builder subnetIds(Collection<String> subnetIds)

      The identifiers of the subnets used with the directory.

      Parameters:
      subnetIds - The identifiers of the subnets used with the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subnetIds

      WorkspaceDirectory.Builder subnetIds(String... subnetIds)

      The identifiers of the subnets used with the directory.

      Parameters:
      subnetIds - The identifiers of the subnets used with the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsIpAddresses

      WorkspaceDirectory.Builder dnsIpAddresses(Collection<String> dnsIpAddresses)

      The IP addresses of the DNS servers for the directory.

      Parameters:
      dnsIpAddresses - The IP addresses of the DNS servers for the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsIpAddresses

      WorkspaceDirectory.Builder dnsIpAddresses(String... dnsIpAddresses)

      The IP addresses of the DNS servers for the directory.

      Parameters:
      dnsIpAddresses - The IP addresses of the DNS servers for the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsIpv6Addresses

      WorkspaceDirectory.Builder dnsIpv6Addresses(Collection<String> dnsIpv6Addresses)

      The IPv6 addresses of the DNS servers for the directory.

      Parameters:
      dnsIpv6Addresses - The IPv6 addresses of the DNS servers for the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dnsIpv6Addresses

      WorkspaceDirectory.Builder dnsIpv6Addresses(String... dnsIpv6Addresses)

      The IPv6 addresses of the DNS servers for the directory.

      Parameters:
      dnsIpv6Addresses - The IPv6 addresses of the DNS servers for the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerUserName

      WorkspaceDirectory.Builder customerUserName(String customerUserName)

      The user name for the service account.

      Parameters:
      customerUserName - The user name for the service account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • iamRoleId

      WorkspaceDirectory.Builder iamRoleId(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.

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

    • directoryType

      WorkspaceDirectory.Builder directoryType(String directoryType)

      The directory type.

      Parameters:
      directoryType - The directory type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • directoryType

      WorkspaceDirectory.Builder directoryType(WorkspaceDirectoryType directoryType)

      The directory type.

      Parameters:
      directoryType - The directory type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceSecurityGroupId

      WorkspaceDirectory.Builder workspaceSecurityGroupId(String workspaceSecurityGroupId)

      The identifier of the security group that is assigned to new WorkSpaces.

      Parameters:
      workspaceSecurityGroupId - The identifier of the security group that is assigned to new WorkSpaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • state

      WorkspaceDirectory.Builder state(String 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.

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

    • state

      WorkspaceDirectory.Builder state(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.

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

    • workspaceCreationProperties

      WorkspaceDirectory.Builder workspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties)

      The default creation properties for all WorkSpaces in the directory.

      Parameters:
      workspaceCreationProperties - The default creation properties for all WorkSpaces in the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceCreationProperties

      default WorkspaceDirectory.Builder workspaceCreationProperties(Consumer<DefaultWorkspaceCreationProperties.Builder> workspaceCreationProperties)

      The default creation properties for all WorkSpaces in the directory.

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

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

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

    • ipGroupIds

      WorkspaceDirectory.Builder ipGroupIds(Collection<String> ipGroupIds)

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

      Parameters:
      ipGroupIds - The identifiers of the IP access control groups associated with the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • ipGroupIds

      WorkspaceDirectory.Builder ipGroupIds(String... ipGroupIds)

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

      Parameters:
      ipGroupIds - The identifiers of the IP access control groups associated with the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceAccessProperties

      WorkspaceDirectory.Builder workspaceAccessProperties(WorkspaceAccessProperties workspaceAccessProperties)

      The devices and operating systems that users can use to access WorkSpaces.

      Parameters:
      workspaceAccessProperties - The devices and operating systems that users can use to access WorkSpaces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceAccessProperties

      default WorkspaceDirectory.Builder workspaceAccessProperties(Consumer<WorkspaceAccessProperties.Builder> workspaceAccessProperties)

      The devices and operating systems that users can use to access WorkSpaces.

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

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

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

    • tenancy

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

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

    • tenancy

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

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

    • selfservicePermissions

      WorkspaceDirectory.Builder selfservicePermissions(SelfservicePermissions selfservicePermissions)

      The default self-service permissions for WorkSpaces in the directory.

      Parameters:
      selfservicePermissions - The default self-service permissions for WorkSpaces in the directory.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selfservicePermissions

      default WorkspaceDirectory.Builder selfservicePermissions(Consumer<SelfservicePermissions.Builder> selfservicePermissions)

      The default self-service permissions for WorkSpaces in the directory.

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

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

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

    • samlProperties

      WorkspaceDirectory.Builder samlProperties(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.

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

    • samlProperties

      default WorkspaceDirectory.Builder samlProperties(Consumer<SamlProperties.Builder> 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.

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

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

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

    • certificateBasedAuthProperties

      WorkspaceDirectory.Builder certificateBasedAuthProperties(CertificateBasedAuthProperties certificateBasedAuthProperties)

      The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

      Parameters:
      certificateBasedAuthProperties - The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • certificateBasedAuthProperties

      default WorkspaceDirectory.Builder certificateBasedAuthProperties(Consumer<CertificateBasedAuthProperties.Builder> certificateBasedAuthProperties)

      The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory for WorkSpaces login.

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

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

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

    • endpointEncryptionMode

      WorkspaceDirectory.Builder endpointEncryptionMode(String endpointEncryptionMode)

      Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

      Parameters:
      endpointEncryptionMode - Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endpointEncryptionMode

      WorkspaceDirectory.Builder endpointEncryptionMode(EndpointEncryptionMode endpointEncryptionMode)

      Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.

      Parameters:
      endpointEncryptionMode - Endpoint encryption mode that allows you to configure the specified directory between Standard TLS and FIPS 140-2 validated mode.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • microsoftEntraConfig

      WorkspaceDirectory.Builder microsoftEntraConfig(MicrosoftEntraConfig microsoftEntraConfig)

      Specifies details about Microsoft Entra configurations.

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

    • microsoftEntraConfig

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

      Specifies details about Microsoft Entra configurations.

      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:

    • workspaceDirectoryName

      WorkspaceDirectory.Builder workspaceDirectoryName(String workspaceDirectoryName)

      The name fo the WorkSpace directory.

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

    • workspaceDirectoryDescription

      WorkspaceDirectory.Builder workspaceDirectoryDescription(String workspaceDirectoryDescription)

      The description of the WorkSpace directory

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

    • userIdentityType

      WorkspaceDirectory.Builder userIdentityType(String userIdentityType)

      Indicates the identity type of the specifired user.

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

    • userIdentityType

      WorkspaceDirectory.Builder userIdentityType(UserIdentityType userIdentityType)

      Indicates the identity type of the specifired user.

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

    • workspaceType

      WorkspaceDirectory.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

      WorkspaceDirectory.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:

    • idcConfig

      WorkspaceDirectory.Builder idcConfig(IDCConfig idcConfig)

      Specifies details about identity center configurations.

      Parameters:
      idcConfig - Specifies details about identity center configurations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idcConfig

      default WorkspaceDirectory.Builder idcConfig(Consumer<IDCConfig.Builder> idcConfig)

      Specifies details about identity center configurations.

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

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

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

    • activeDirectoryConfig

      WorkspaceDirectory.Builder activeDirectoryConfig(ActiveDirectoryConfig activeDirectoryConfig)

      Information about the Active Directory config.

      Parameters:
      activeDirectoryConfig - Information about the Active Directory config.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • activeDirectoryConfig

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

      Information about the Active Directory config.

      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:

    • streamingProperties

      WorkspaceDirectory.Builder streamingProperties(StreamingProperties streamingProperties)

      The streaming properties to configure.

      Parameters:
      streamingProperties - The streaming properties to configure.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • streamingProperties

      default WorkspaceDirectory.Builder streamingProperties(Consumer<StreamingProperties.Builder> streamingProperties)

      The streaming properties to configure.

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

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

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

    • errorMessage

      WorkspaceDirectory.Builder errorMessage(String errorMessage)

      The error message returned.

      Parameters:
      errorMessage - The error message returned.
      Returns:
      Returns a reference to this object so that method calls can be chained together.