Interface WorkspaceDirectory.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<WorkspaceDirectory.Builder,
,WorkspaceDirectory> SdkBuilder<WorkspaceDirectory.Builder,
,WorkspaceDirectory> SdkPojo
- Enclosing class:
WorkspaceDirectory
-
Method Summary
Modifier and TypeMethodDescriptionThe directory alias.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.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.customerUserName
(String customerUserName) The user name for the service account.directoryId
(String directoryId) The directory identifier.directoryName
(String directoryName) The name of the directory.directoryType
(String directoryType) The directory type.directoryType
(WorkspaceDirectoryType directoryType) The directory type.dnsIpAddresses
(String... dnsIpAddresses) The IP addresses of the DNS servers for the directory.dnsIpAddresses
(Collection<String> dnsIpAddresses) The IP addresses of the DNS servers for the directory.The identifier of the IAM role.ipGroupIds
(String... ipGroupIds) The identifiers of the IP access control groups associated with the directory.ipGroupIds
(Collection<String> ipGroupIds) The identifiers of the IP access control groups associated with the directory.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.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.selfservicePermissions
(SelfservicePermissions selfservicePermissions) The default self-service permissions for WorkSpaces in the directory.The state of the directory's registration with Amazon WorkSpaces.state
(WorkspaceDirectoryState state) The state of the directory's registration with Amazon WorkSpaces.The identifiers of the subnets used with the directory.subnetIds
(Collection<String> subnetIds) The identifiers of the subnets used with the directory.Specifies whether the directory is dedicated or shared.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.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.workspaceCreationProperties
(DefaultWorkspaceCreationProperties workspaceCreationProperties) The default creation properties for all WorkSpaces in the directory.workspaceSecurityGroupId
(String workspaceSecurityGroupId) The identifier of the security group that is assigned to new WorkSpaces.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
The directory alias.
- Parameters:
alias
- The directory alias.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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
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
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
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
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
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
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
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
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
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
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, theDEREGISTERED
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
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, theDEREGISTERED
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 theDefaultWorkspaceCreationProperties.Builder
avoiding the need to create one manually viaDefaultWorkspaceCreationProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkspaceCreationProperties(DefaultWorkspaceCreationProperties)
.- Parameters:
workspaceCreationProperties
- a consumer that will call methods onDefaultWorkspaceCreationProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theWorkspaceAccessProperties.Builder
avoiding the need to create one manually viaWorkspaceAccessProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toworkspaceAccessProperties(WorkspaceAccessProperties)
.- Parameters:
workspaceAccessProperties
- a consumer that will call methods onWorkspaceAccessProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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 toDEDICATED
. 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
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 toDEDICATED
. 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
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 theSelfservicePermissions.Builder
avoiding the need to create one manually viaSelfservicePermissions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toselfservicePermissions(SelfservicePermissions)
.- Parameters:
selfservicePermissions
- a consumer that will call methods onSelfservicePermissions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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 theSamlProperties.Builder
avoiding the need to create one manually viaSamlProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tosamlProperties(SamlProperties)
.- Parameters:
samlProperties
- a consumer that will call methods onSamlProperties.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 theCertificateBasedAuthProperties.Builder
avoiding the need to create one manually viaCertificateBasedAuthProperties.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tocertificateBasedAuthProperties(CertificateBasedAuthProperties)
.- Parameters:
certificateBasedAuthProperties
- a consumer that will call methods onCertificateBasedAuthProperties.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-