workspaces/aws.sdk.kotlin.services.workspaces.model/WorkspaceDirectory/Builder

Builder

class Builder

Properties

activeDirectoryConfig

var activeDirectoryConfig: ActiveDirectoryConfig?

Information about the Active Directory config.

alias

var alias: String?

The directory alias.

certificateBasedAuthProperties

var 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

var customerUserName: String?

The user name for the service account.

directoryId

var directoryId: String?

The directory identifier.

directoryName

var directoryName: String?

The name of the directory.

directoryType

var directoryType: WorkspaceDirectoryType?

The directory type.

dnsIpAddresses

var dnsIpAddresses: List<String>?

The IP addresses of the DNS servers for the directory.

endpointEncryptionMode

var endpointEncryptionMode: EndpointEncryptionMode?

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

errorMessage

var errorMessage: String?

The error message returned.

iamRoleId

var iamRoleId: String?

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.

idcConfig

var idcConfig: IdcConfig?

Specifies details about identity center configurations.

ipGroupIds

var ipGroupIds: List<String>?

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

microsoftEntraConfig

var microsoftEntraConfig: MicrosoftEntraConfig?

Specifies details about Microsoft Entra configurations.

registrationCode

var registrationCode: String?

The registration code for the directory. This is the code that users enter in their Amazon WorkSpaces client application to connect to the directory.

samlProperties

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

selfservicePermissions

var selfservicePermissions: SelfservicePermissions?

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

state

var state: WorkspaceDirectoryState?

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.

streamingProperties

var streamingProperties: StreamingProperties?

The streaming properties to configure.

subnetIds

var subnetIds: List<String>?

The identifiers of the subnets used with the directory.

tenancy

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

userIdentityType

var userIdentityType: UserIdentityType?

Indicates the identity type of the specifired user.

workspaceAccessProperties

var workspaceAccessProperties: WorkspaceAccessProperties?

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

workspaceCreationProperties

var workspaceCreationProperties: DefaultWorkspaceCreationProperties?

The default creation properties for all WorkSpaces in the directory.

workspaceDirectoryDescription

var workspaceDirectoryDescription: String?

The description of the WorkSpace directory