Amazon WorkSpaces Service
API Reference (API Version 2015-04-08)

DefaultWorkspaceCreationProperties

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

Contents

CustomSecurityGroupId

The identifier of any security groups to apply to WorkSpaces when they are created.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 20.

Pattern: ^(sg-([0-9a-f]{8}|[0-9a-f]{17}))$

Required: No

DefaultOu

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

Type: String

Required: No

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.

Type: Boolean

Required: No

EnableMaintenanceMode

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

Type: Boolean

Required: No

EnableWorkDocs

Specifies whether the directory is enabled for Amazon WorkDocs.

Type: Boolean

Required: No

UserEnabledAsLocalAdministrator

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

Type: Boolean

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: