software.amazon.awssdk.services.workspaces.model

Class WorkspaceCreationProperties

java.lang.Object

software.amazon.awssdk.services.workspaces.model.WorkspaceCreationProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkspaceCreationProperties.Builder,WorkspaceCreationProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkspaceCreationProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceCreationProperties.Builder,WorkspaceCreationProperties>

Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkspaceCreationProperties.Builder

Method Summary

Modifier and Type	Method and Description
static WorkspaceCreationProperties.Builder	builder()
String	customSecurityGroupId() The identifier of your custom security group.
String	defaultOu() The default organizational unit (OU) for your WorkSpaces directories.
Boolean	enableInternetAccess() Indicates whether internet access is enabled for your WorkSpaces.
Boolean	enableMaintenanceMode() Indicates whether maintenance mode is enabled for your WorkSpaces.
Boolean	enableWorkDocs() Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends WorkspaceCreationProperties.Builder>	serializableBuilderClass()
WorkspaceCreationProperties.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Boolean	userEnabledAsLocalAdministrator() Indicates whether users are local administrators of their WorkSpaces.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

enableWorkDocs

public final Boolean enableWorkDocs()

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

Returns:

Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.

If WorkDocs is already enabled for a WorkSpaces directory and you disable it, new WorkSpaces launched in the directory will not have WorkDocs enabled. However, WorkDocs remains enabled for any existing WorkSpaces, unless you either disable users' access to WorkDocs or you delete the WorkDocs site. To disable users' access to WorkDocs, see Disabling Users in the Amazon WorkDocs Administration Guide. To delete a WorkDocs site, see Deleting a Site in the Amazon WorkDocs Administration Guide.

If you enable WorkDocs on a directory that already has existing WorkSpaces, the existing WorkSpaces and any new WorkSpaces that are launched in the directory will have WorkDocs enabled.

enableInternetAccess

public final Boolean enableInternetAccess()

Indicates whether internet access is enabled for your WorkSpaces.

Returns:

Indicates whether internet access is enabled for your WorkSpaces.

defaultOu

public final String defaultOu()

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

• To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

• The API doesn't validate whether the OU exists.

Returns:

The default organizational unit (OU) for your WorkSpaces directories. This string must be the full Lightweight Directory Access Protocol (LDAP) distinguished name for the target domain and OU. It must be in the form "OU=value,DC=value,DC=value", where value is any string of characters, and the number of domain components (DCs) is two or more. For example, OU=WorkSpaces_machines,DC=machines,DC=example,DC=com.

• To avoid errors, certain characters in the distinguished name must be escaped. For more information, see Distinguished Names in the Microsoft documentation.

• The API doesn't validate whether the OU exists.

customSecurityGroupId

public final String customSecurityGroupId()

The identifier of your custom security group.

Returns:

The identifier of your custom security group.

userEnabledAsLocalAdministrator

public final Boolean userEnabledAsLocalAdministrator()

Indicates whether users are local administrators of their WorkSpaces.

Returns:

Indicates whether users are local administrators of their WorkSpaces.

enableMaintenanceMode

public final Boolean enableMaintenanceMode()

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

Returns:

Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.

toBuilder

public WorkspaceCreationProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkspaceCreationProperties.Builder,WorkspaceCreationProperties>

builder

public static WorkspaceCreationProperties.Builder builder()

serializableBuilderClass

public static Class<? extends WorkspaceCreationProperties.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo