WorkspaceCreationProperties (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspaces.model.WorkspaceCreationProperties

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkspaceCreationProperties
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the default properties that are used for creating WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceCreationProperties()

Constructors
Constructor and Description
`WorkspaceCreationProperties()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceCreationProperties`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCustomSecurityGroupId()` The identifier of your custom security group.
`String`	`getDefaultOu()` The default organizational unit (OU) for your WorkSpaces directories.
`Boolean`	`getEnableInternetAccess()` Indicates whether internet access is enabled for your WorkSpaces.
`Boolean`	`getEnableMaintenanceMode()` Indicates whether maintenance mode is enabled for your WorkSpaces.
`Boolean`	`getEnableWorkDocs()` Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
`String`	`getInstanceIamRoleArn()` Indicates the IAM role ARN of the instance.
`Boolean`	`getUserEnabledAsLocalAdministrator()` Indicates whether users are local administrators of their WorkSpaces.
`int`	`hashCode()`
`Boolean`	`isEnableInternetAccess()` Indicates whether internet access is enabled for your WorkSpaces.
`Boolean`	`isEnableMaintenanceMode()` Indicates whether maintenance mode is enabled for your WorkSpaces.
`Boolean`	`isEnableWorkDocs()` Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
`Boolean`	`isUserEnabledAsLocalAdministrator()` Indicates whether users are local administrators of their WorkSpaces.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCustomSecurityGroupId(String customSecurityGroupId)` The identifier of your custom security group.
`void`	`setDefaultOu(String defaultOu)` The default organizational unit (OU) for your WorkSpaces directories.
`void`	`setEnableInternetAccess(Boolean enableInternetAccess)` Indicates whether internet access is enabled for your WorkSpaces.
`void`	`setEnableMaintenanceMode(Boolean enableMaintenanceMode)` Indicates whether maintenance mode is enabled for your WorkSpaces.
`void`	`setEnableWorkDocs(Boolean enableWorkDocs)` Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
`void`	`setInstanceIamRoleArn(String instanceIamRoleArn)` Indicates the IAM role ARN of the instance.
`void`	`setUserEnabledAsLocalAdministrator(Boolean userEnabledAsLocalAdministrator)` Indicates whether users are local administrators of their WorkSpaces.
`String`	`toString()` Returns a string representation of this object.
`WorkspaceCreationProperties`	`withCustomSecurityGroupId(String customSecurityGroupId)` The identifier of your custom security group.
`WorkspaceCreationProperties`	`withDefaultOu(String defaultOu)` The default organizational unit (OU) for your WorkSpaces directories.
`WorkspaceCreationProperties`	`withEnableInternetAccess(Boolean enableInternetAccess)` Indicates whether internet access is enabled for your WorkSpaces.
`WorkspaceCreationProperties`	`withEnableMaintenanceMode(Boolean enableMaintenanceMode)` Indicates whether maintenance mode is enabled for your WorkSpaces.
`WorkspaceCreationProperties`	`withEnableWorkDocs(Boolean enableWorkDocs)` Indicates whether Amazon WorkDocs is enabled for your WorkSpaces.
`WorkspaceCreationProperties`	`withInstanceIamRoleArn(String instanceIamRoleArn)` Indicates the IAM role ARN of the instance.
`WorkspaceCreationProperties`	`withUserEnabledAsLocalAdministrator(Boolean userEnabledAsLocalAdministrator)` Indicates whether users are local administrators of their WorkSpaces.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WorkspaceCreationProperties
```
public WorkspaceCreationProperties()
```
- Method Detail
  - setEnableWorkDocs
```
public void setEnableWorkDocs(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.
    
    Parameters:
    
    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.
  - getEnableWorkDocs
```
public Boolean getEnableWorkDocs()
```
    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.
  - withEnableWorkDocs
```
public WorkspaceCreationProperties withEnableWorkDocs(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableWorkDocs
```
public Boolean isEnableWorkDocs()
```
    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.
  - setEnableInternetAccess
```
public void setEnableInternetAccess(Boolean enableInternetAccess)
```
    Indicates whether internet access is enabled for your WorkSpaces.
    
    Parameters:
    
    enableInternetAccess - Indicates whether internet access is enabled for your WorkSpaces.
  - getEnableInternetAccess
```
public Boolean getEnableInternetAccess()
```
    Indicates whether internet access is enabled for your WorkSpaces.
    
    Returns:
    
    Indicates whether internet access is enabled for your WorkSpaces.
  - withEnableInternetAccess
```
public WorkspaceCreationProperties withEnableInternetAccess(Boolean enableInternetAccess)
```
    Indicates whether internet access is enabled for your WorkSpaces.
    
    Parameters:
    
    enableInternetAccess - Indicates whether internet access is enabled for your WorkSpaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableInternetAccess
```
public Boolean isEnableInternetAccess()
```
    Indicates whether internet access is enabled for your WorkSpaces.
    
    Returns:
    
    Indicates whether internet access is enabled for your WorkSpaces.
  - setDefaultOu
```
public void setDefaultOu(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.
    Parameters:
    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.
  - getDefaultOu
```
public String getDefaultOu()
```
    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.
  - withDefaultOu
```
public WorkspaceCreationProperties withDefaultOu(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.
    Parameters:
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCustomSecurityGroupId
```
public void setCustomSecurityGroupId(String customSecurityGroupId)
```
    The identifier of your custom security group.
    
    Parameters:
    
    customSecurityGroupId - The identifier of your custom security group.
  - getCustomSecurityGroupId
```
public String getCustomSecurityGroupId()
```
    The identifier of your custom security group.
    
    Returns:
    
    The identifier of your custom security group.
  - withCustomSecurityGroupId
```
public WorkspaceCreationProperties withCustomSecurityGroupId(String customSecurityGroupId)
```
    The identifier of your custom security group.
    
    Parameters:
    
    customSecurityGroupId - The identifier of your custom security group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserEnabledAsLocalAdministrator
```
public void setUserEnabledAsLocalAdministrator(Boolean userEnabledAsLocalAdministrator)
```
    Indicates whether users are local administrators of their WorkSpaces.
    
    Parameters:
    
    userEnabledAsLocalAdministrator - Indicates whether users are local administrators of their WorkSpaces.
  - getUserEnabledAsLocalAdministrator
```
public Boolean getUserEnabledAsLocalAdministrator()
```
    Indicates whether users are local administrators of their WorkSpaces.
    
    Returns:
    
    Indicates whether users are local administrators of their WorkSpaces.
  - withUserEnabledAsLocalAdministrator
```
public WorkspaceCreationProperties withUserEnabledAsLocalAdministrator(Boolean userEnabledAsLocalAdministrator)
```
    Indicates whether users are local administrators of their WorkSpaces.
    
    Parameters:
    
    userEnabledAsLocalAdministrator - Indicates whether users are local administrators of their WorkSpaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUserEnabledAsLocalAdministrator
```
public Boolean isUserEnabledAsLocalAdministrator()
```
    Indicates whether users are local administrators of their WorkSpaces.
    
    Returns:
    
    Indicates whether users are local administrators of their WorkSpaces.
  - setEnableMaintenanceMode
```
public void setEnableMaintenanceMode(Boolean enableMaintenanceMode)
```
    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
    
    Parameters:
    
    enableMaintenanceMode - Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
  - getEnableMaintenanceMode
```
public Boolean getEnableMaintenanceMode()
```
    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.
  - withEnableMaintenanceMode
```
public WorkspaceCreationProperties withEnableMaintenanceMode(Boolean enableMaintenanceMode)
```
    Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
    
    Parameters:
    
    enableMaintenanceMode - Indicates whether maintenance mode is enabled for your WorkSpaces. For more information, see WorkSpace Maintenance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isEnableMaintenanceMode
```
public Boolean isEnableMaintenanceMode()
```
    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.
  - setInstanceIamRoleArn
```
public void setInstanceIamRoleArn(String instanceIamRoleArn)
```
    Indicates the IAM role ARN of the instance.
    
    Parameters:
    
    instanceIamRoleArn - Indicates the IAM role ARN of the instance.
  - getInstanceIamRoleArn
```
public String getInstanceIamRoleArn()
```
    Indicates the IAM role ARN of the instance.
    
    Returns:
    
    Indicates the IAM role ARN of the instance.
  - withInstanceIamRoleArn
```
public WorkspaceCreationProperties withInstanceIamRoleArn(String instanceIamRoleArn)
```
    Indicates the IAM role ARN of the instance.
    
    Parameters:
    
    instanceIamRoleArn - Indicates the IAM role ARN of the instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public WorkspaceCreationProperties clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.782

Class WorkspaceCreationProperties

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceCreationProperties

Method Detail

setEnableWorkDocs

getEnableWorkDocs

withEnableWorkDocs

isEnableWorkDocs

setEnableInternetAccess

getEnableInternetAccess

withEnableInternetAccess

isEnableInternetAccess

setDefaultOu

getDefaultOu

withDefaultOu

setCustomSecurityGroupId

getCustomSecurityGroupId

withCustomSecurityGroupId

setUserEnabledAsLocalAdministrator

getUserEnabledAsLocalAdministrator

withUserEnabledAsLocalAdministrator

isUserEnabledAsLocalAdministrator

setEnableMaintenanceMode

getEnableMaintenanceMode

withEnableMaintenanceMode

isEnableMaintenanceMode

setInstanceIamRoleArn

getInstanceIamRoleArn

withInstanceIamRoleArn

toString

equals

hashCode

clone

marshall