software.amazon.awssdk.services.workspaces.model

Interface WorkspaceDirectory.Builder

All Superinterfaces:

Buildable, CopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>, SdkBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>, SdkPojo

Enclosing class:

WorkspaceDirectory

public static interface WorkspaceDirectory.Builder
extends SdkPojo, CopyableBuilder<WorkspaceDirectory.Builder,WorkspaceDirectory>

Method Summary

Modifier and Type	Method and Description
WorkspaceDirectory.Builder	alias(String alias) The directory alias.
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.
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.
WorkspaceDirectory.Builder	customerUserName(String customerUserName) The user name for the service account.
WorkspaceDirectory.Builder	directoryId(String directoryId) The directory identifier.
WorkspaceDirectory.Builder	directoryName(String directoryName) The name of the directory.
WorkspaceDirectory.Builder	directoryType(String directoryType) The directory type.
WorkspaceDirectory.Builder	directoryType(WorkspaceDirectoryType directoryType) The directory type.
WorkspaceDirectory.Builder	dnsIpAddresses(Collection<String> dnsIpAddresses) The IP addresses of the DNS servers for the directory.
WorkspaceDirectory.Builder	dnsIpAddresses(String... dnsIpAddresses) The IP addresses of the DNS servers for the directory.
WorkspaceDirectory.Builder	iamRoleId(String iamRoleId) The identifier of the IAM role.
WorkspaceDirectory.Builder	ipGroupIds(Collection<String> ipGroupIds) The identifiers of the IP access control groups associated with the directory.
WorkspaceDirectory.Builder	ipGroupIds(String... ipGroupIds) The identifiers of the IP access control groups associated with the directory.
WorkspaceDirectory.Builder	registrationCode(String registrationCode) The registration code for the directory.
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.
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.
default WorkspaceDirectory.Builder	selfservicePermissions(Consumer<SelfservicePermissions.Builder> selfservicePermissions) The default self-service permissions for WorkSpaces in the directory.
WorkspaceDirectory.Builder	selfservicePermissions(SelfservicePermissions selfservicePermissions) The default self-service permissions for WorkSpaces in the directory.
WorkspaceDirectory.Builder	state(String state) The state of the directory's registration with Amazon WorkSpaces.
WorkspaceDirectory.Builder	state(WorkspaceDirectoryState state) The state of the directory's registration with Amazon WorkSpaces.
WorkspaceDirectory.Builder	subnetIds(Collection<String> subnetIds) The identifiers of the subnets used with the directory.
WorkspaceDirectory.Builder	subnetIds(String... subnetIds) The identifiers of the subnets used with the directory.
WorkspaceDirectory.Builder	tenancy(String tenancy) Specifies whether the directory is dedicated or shared.
WorkspaceDirectory.Builder	tenancy(Tenancy tenancy) Specifies whether the directory is dedicated or shared.
default WorkspaceDirectory.Builder	workspaceAccessProperties(Consumer<WorkspaceAccessProperties.Builder> workspaceAccessProperties) The devices and operating systems that users can use to access WorkSpaces.
WorkspaceDirectory.Builder	workspaceAccessProperties(WorkspaceAccessProperties workspaceAccessProperties) The devices and operating systems that users can use to access WorkSpaces.
default WorkspaceDirectory.Builder	workspaceCreationProperties(Consumer<DefaultWorkspaceCreationProperties.Builder> workspaceCreationProperties) The default creation properties for all WorkSpaces in the directory.
WorkspaceDirectory.Builder	workspaceCreationProperties(DefaultWorkspaceCreationProperties workspaceCreationProperties) The default creation properties for all WorkSpaces in the directory.
WorkspaceDirectory.Builder	workspaceSecurityGroupId(String workspaceSecurityGroupId) The identifier of the security group that is assigned to new WorkSpaces.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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.

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:

WorkspaceDirectoryType, WorkspaceDirectoryType

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:

WorkspaceDirectoryType, WorkspaceDirectoryType

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:

WorkspaceDirectoryState, WorkspaceDirectoryState

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:

WorkspaceDirectoryState, WorkspaceDirectoryState

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:

workspaceCreationProperties(DefaultWorkspaceCreationProperties)

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:

workspaceAccessProperties(WorkspaceAccessProperties)

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, Tenancy

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:

Tenancy, Tenancy

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:

selfservicePermissions(SelfservicePermissions)

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:

samlProperties(SamlProperties)

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:

certificateBasedAuthProperties(CertificateBasedAuthProperties)