View a markdown version of this page

AWS::WorkSpaces::Directory DefaultWorkspaceCreationProperties - AWS CloudFormation
SyntaxProperties

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::WorkSpaces::Directory DefaultWorkspaceCreationProperties

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

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "CustomSecurityGroupId" : String,
  "DefaultOu" : String,
  "EnableInternetAccess" : Boolean,
  "EnableMaintenanceMode" : Boolean,
  "InstanceIamRoleArn" : String,
  "UserEnabledAsLocalAdministrator" : Boolean
}

Properties

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.

Required: No

Type: String

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

Minimum: 11

Maximum: 20

Update requires: No interruption

DefaultOu

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

Required: No

Type: String

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

EnableMaintenanceMode

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

Required: No

Type: Boolean

Update requires: No interruption

InstanceIamRoleArn

Indicates the IAM role ARN of the instance.

Required: No

Type: String

Pattern: ^arn:aws[a-z-]{0,7}:[A-Za-z0-9][A-za-z0-9_/.-]{0,62}:[A-za-z0-9_/.-]{0,63}:[A-za-z0-9_/.-]{0,63}:[A-Za-z0-9][A-Za-z0-9:_/+=,@.\\-]{0,1023}$

Update requires: No interruption

UserEnabledAsLocalAdministrator

Specifies whether WorkSpace users are local administrators on their WorkSpaces.

Required: No

Type: Boolean

Update requires: No interruption