Amazon WorkSpaces · Schema
DefaultWorkspaceCreationProperties
Describes the default values that are used to create WorkSpaces. For more information, see Update Directory Details for Your WorkSpaces.
DesktopEnd User ComputingVirtual DesktopDesktop as a Service
Properties
| Name | Type | Description |
|---|---|---|
| EnableWorkDocs | object | |
| EnableInternetAccess | object | |
| DefaultOu | object | |
| CustomSecurityGroupId | object | |
| UserEnabledAsLocalAdministrator | object | |
| EnableMaintenanceMode | object |
JSON Schema
{
"type": "object",
"properties": {
"EnableWorkDocs": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanObject"
},
{
"description": "Specifies whether the directory is enabled for Amazon WorkDocs."
}
]
},
"EnableInternetAccess": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanObject"
},
{
"description": "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\u2019re 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 <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-vpc.html\"> Configure a VPC for Amazon WorkSpaces</a>."
}
]
},
"DefaultOu": {
"allOf": [
{
"$ref": "#/components/schemas/DefaultOu"
},
{
"description": "The organizational unit (OU) in the directory for the WorkSpace machine accounts."
}
]
},
"CustomSecurityGroupId": {
"allOf": [
{
"$ref": "#/components/schemas/SecurityGroupId"
},
{
"description": "The identifier of the default security group to apply to WorkSpaces when they are created. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/amazon-workspaces-security-groups.html\"> Security Groups for Your WorkSpaces</a>."
}
]
},
"UserEnabledAsLocalAdministrator": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanObject"
},
{
"description": "Specifies whether WorkSpace users are local administrators on their WorkSpaces."
}
]
},
"EnableMaintenanceMode": {
"allOf": [
{
"$ref": "#/components/schemas/BooleanObject"
},
{
"description": "Specifies whether maintenance mode is enabled for WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/workspace-maintenance.html\">WorkSpace Maintenance</a>."
}
]
}
},
"description": "Describes the default values that are used to create WorkSpaces. For more information, see <a href=\"https://docs.aws.amazon.com/workspaces/latest/adminguide/update-directory-details.html\">Update Directory Details for Your WorkSpaces</a>.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "DefaultWorkspaceCreationProperties",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-workspaces/refs/heads/main/json-schema/workspaces-default-workspace-creation-properties-schema.json"
}