AWS::WorkSpaces::Directory

WorkSpaces Directory

Resource Type definition for AWS::WorkSpaces::Directory

Properties

19 configurable properties. Click a row to see details.

Filter:
PropertyTypeFlags
ActiveDirectoryConfig
ActiveDirectoryConfig
Create-only
CertificateBasedAuthProperties
CertificateBasedAuthProperties
EnableSelfService
boolean
Create-onlyWrite-only
EndpointEncryptionMode
string
IdcInstanceArn
string
Create-onlyWrite-only
IpGroupIds
Array<string>
MicrosoftEntraConfig
MicrosoftEntraConfig
Create-only
SamlProperties
SamlProperties
SelfservicePermissions
SelfservicePermissions
StreamingProperties
StreamingProperties
SubnetIds
Array<string>
Create-only
Tags
Array<Tag>
Tenancy
string
Create-only
UserIdentityType
string
Create-only
WorkspaceAccessProperties
WorkspaceAccessProperties
WorkspaceCreationProperties
DefaultWorkspaceCreationProperties
WorkspaceDirectoryDescription
string
Create-only
WorkspaceDirectoryName
string
Create-only
WorkspaceType
string
Create-only

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
AliasstringThe directory alias.
ArnstringThe Amazon Resource Name (ARN) of the WorkSpace directory.
CustomerUserNamestringThe user name for the service account.
DirectoryIdstringThe directory identifier.
DirectoryNamestringThe name of the directory.
DirectoryTypestringThe directory type.
DnsIpAddressesArray<string>The IP addresses of the DNS servers for the directory.
DnsIpv6AddressesArray<string>The IPv6 addresses of the DNS servers for the directory.
IamRoleIdstringThe identifier of the IAM role.
IDCConfigIDCConfig-
RegistrationCodestringThe registration code for the directory.
StatestringThe state of the directory's registration with Amazon WorkSpaces.
WorkspaceSecurityGroupIdstringThe identifier of the security group that is assigned to new WorkSpaces.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::WorkSpaces::Directory

Resources:
  MyResource:
    Type: AWS::WorkSpaces::Directory
    Properties:
      Tags:
        - Key: Environment
          Value: Production

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

workspaces:RegisterWorkspaceDirectoryworkspaces:DescribeWorkspaceDirectoriesworkspaces:CreateTagsworkspaces:ModifyWorkspaceCreationPropertiesworkspaces:ModifyWorkspaceAccessPropertiesworkspaces:ModifySelfservicePermissionsworkspaces:ModifySamlPropertiesworkspaces:ModifyCertificateBasedAuthPropertiesworkspaces:ModifyStreamingPropertiesworkspaces:ModifyEndpointEncryptionModeworkspaces:AssociateIpGroupsec2:CreateSecurityGroupec2:CreateTagsec2:DescribeAvailabilityZonesec2:DescribeInternetGatewaysec2:DescribeNetworkInterfacesec2:DescribeRouteTablesec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeVpcEndpointsiam:GetRoleiam:PassRole

read

workspaces:DescribeWorkspaceDirectoriesworkspaces:DescribeTags

update

workspaces:CreateTagsworkspaces:DeleteTagsworkspaces:DescribeTagsworkspaces:DescribeWorkspaceDirectoriesworkspaces:ModifyWorkspaceCreationPropertiesworkspaces:ModifyWorkspaceAccessPropertiesworkspaces:ModifySelfservicePermissionsworkspaces:ModifySamlPropertiesworkspaces:ModifyCertificateBasedAuthPropertiesworkspaces:ModifyStreamingPropertiesworkspaces:ModifyEndpointEncryptionModeworkspaces:AssociateIpGroupsworkspaces:DisassociateIpGroupsec2:DescribeNetworkInterfacesec2:DescribeSecurityGroupsec2:DescribeSubnetsec2:DescribeVpcsec2:DescribeVpcEndpointsiam:GetRoleiam:PassRole

delete

workspaces:DeregisterWorkspaceDirectoryworkspaces:DescribeWorkspaceDirectoriesworkspaces:DescribeTags

list

workspaces:DescribeWorkspaceDirectories

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceWorkSpaces
Properties32
Required0
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

SubnetIdsEnableSelfServiceTenancyWorkspaceDirectoryNameWorkspaceDirectoryDescriptionUserIdentityTypeWorkspaceTypeActiveDirectoryConfigIdcInstanceArnMicrosoftEntraConfig

Related Resources

External Links