Package software.amazon.awssdk.services.workspaces.model

Class DefaultWorkspaceCreationProperties

java.lang.Object

software.amazon.awssdk.services.workspaces.model.DefaultWorkspaceCreationProperties

All Implemented Interfaces:

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

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

Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultWorkspaceCreationProperties.Builder

Method Summary

Modifier and Type	Method	Description
static DefaultWorkspaceCreationProperties.Builder	builder()
String	customSecurityGroupId()	The identifier of the default security group to apply to WorkSpaces when they are created.
String	defaultOu()	The organizational unit (OU) in the directory for the WorkSpace machine accounts.
Boolean	enableInternetAccess()	Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default.
Boolean	enableMaintenanceMode()	Specifies whether maintenance mode is enabled for WorkSpaces.
Boolean	enableWorkDocs()	Specifies whether the directory is enabled for Amazon WorkDocs.
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 DefaultWorkspaceCreationProperties.Builder>	serializableBuilderClass()
DefaultWorkspaceCreationProperties.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	userEnabledAsLocalAdministrator()	Specifies whether WorkSpace users are local administrators on 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()

Specifies whether the directory is enabled for Amazon WorkDocs.

Returns:

Specifies whether the directory is enabled for Amazon WorkDocs.

enableInternetAccess

public final Boolean enableInternetAccess()

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

Returns:

Specifies whether to automatically assign an Elastic public IP address to WorkSpaces in this directory by default. If enabled, the Elastic public IP address allows outbound internet access from your WorkSpaces when you’re using an internet gateway in the Amazon VPC in which your WorkSpaces are located. If you're using a Network Address Translation (NAT) gateway for outbound internet access from your VPC, or if your WorkSpaces are in public subnets and you manually assign them Elastic IP addresses, you should disable this setting. This setting applies to new WorkSpaces that you launch or to existing WorkSpaces that you rebuild. For more information, see Configure a VPC for Amazon WorkSpaces.

defaultOu

public final String defaultOu()

The organizational unit (OU) in the directory for the WorkSpace machine accounts.

Returns:

The organizational unit (OU) in the directory for the WorkSpace machine accounts.

customSecurityGroupId

public final String customSecurityGroupId()

The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

Returns:

The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see Security Groups for Your WorkSpaces.

userEnabledAsLocalAdministrator

public final Boolean userEnabledAsLocalAdministrator()

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

Returns:

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

enableMaintenanceMode

public final Boolean enableMaintenanceMode()

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

Returns:

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

toBuilder

public DefaultWorkspaceCreationProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DefaultWorkspaceCreationProperties.Builder,DefaultWorkspaceCreationProperties>

builder

public static DefaultWorkspaceCreationProperties.Builder builder()

serializableBuilderClass

public static Class<? extends DefaultWorkspaceCreationProperties.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