# Amazon WorkSpaces Construct Library

This module is part of the [AWS Cloud Development Kit](https://github.com/aws/aws-cdk) project.

```ts
import * as workspaces from 'aws-cdk-lib/aws-workspaces';
```

There are no official hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet. Here are some suggestions on how to proceed:

- Search [Construct Hub for WorkSpaces construct libraries](https://constructs.dev/search?q=workspaces)
- Use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, in the same way you would use [the CloudFormation AWS::WorkSpaces resources](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_WorkSpaces.html) directly.

There are no hand-written ([L2](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_lib)) constructs for this service yet.
However, you can still use the automatically generated [L1](https://docs.aws.amazon.com/cdk/latest/guide/constructs.html#constructs_l1_using) constructs, and use this service exactly as you would using CloudFormation directly.

For more information on the resources and properties available for this service, see the [CloudFormation documentation for AWS::WorkSpaces](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/AWS_WorkSpaces.html).

(Read the [CDK Contributing Guide](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and submit an RFC if you are interested in contributing to this construct library.)

## Types

| Name | Kind | Summary |
| --- | --- | --- |
| [`CfnConnectionAlias`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnConnectionAlias) | Construct (L1) | The `AWS::WorkSpaces::ConnectionAlias` resource specifies a connection alias. |
| [`CfnDirectory`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory) | Construct (L1) | Resource Type definition for AWS::WorkSpaces::Directory. |
| [`CfnWorkspace`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspace) | Construct (L1) | The `AWS::WorkSpaces::Workspace` resource specifies a WorkSpace. |
| [`CfnWorkspaceIpGroup`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspaceIpGroup) | Construct (L1) | Resource Type definition for an IP access control group for Amazon WorkSpaces. |
| [`CfnWorkspacesPool`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspacesPool) | Construct (L1) | Describes a pool of WorkSpaces. |
| [`CfnConnectionAlias.ConnectionAliasAssociationProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnConnectionAlias.ConnectionAliasAssociationProperty) | Struct | Describes a connection alias association that is used for cross-Region redirection. |
| [`CfnConnectionAliasProps`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnConnectionAliasProps) | Struct | Properties for defining a `CfnConnectionAlias`. |
| [`CfnDirectory.AccessEndpointConfigProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.AccessEndpointConfigProperty) | Struct | Describes the access endpoint configuration for a WorkSpace. |
| [`CfnDirectory.AccessEndpointProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.AccessEndpointProperty) | Struct | Describes the access type and endpoint for a WorkSpace. |
| [`CfnDirectory.ActiveDirectoryConfigProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.ActiveDirectoryConfigProperty) | Struct | Information about the Active Directory config. |
| [`CfnDirectory.CertificateBasedAuthPropertiesProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.CertificateBasedAuthPropertiesProperty) | Struct | Describes the properties of the certificate-based authentication you want to use with your WorkSpaces. |
| [`CfnDirectory.DefaultWorkspaceCreationPropertiesProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.DefaultWorkspaceCreationPropertiesProperty) | Struct | The default values that are used to create WorkSpaces. |
| [`CfnDirectory.GlobalAcceleratorForDirectoryProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.GlobalAcceleratorForDirectoryProperty) | Struct | Describes the Global Accelerator for directory. |
| [`CfnDirectory.IDCConfigProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.IDCConfigProperty) | Struct | Specifies the configurations of the identity center. |
| [`CfnDirectory.MicrosoftEntraConfigProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.MicrosoftEntraConfigProperty) | Struct | Specifies the configurations of the Microsoft Entra. |
| [`CfnDirectory.SamlPropertiesProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.SamlPropertiesProperty) | Struct | Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider. |
| [`CfnDirectory.SelfservicePermissionsProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.SelfservicePermissionsProperty) | Struct | Describes the self-service permissions for a directory. |
| [`CfnDirectory.StorageConnectorProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.StorageConnectorProperty) | Struct | Describes the storage connector. |
| [`CfnDirectory.StreamingPropertiesProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.StreamingPropertiesProperty) | Struct | Describes the streaming properties. |
| [`CfnDirectory.UserSettingProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.UserSettingProperty) | Struct | Information about the user's permission settings. |
| [`CfnDirectory.WorkspaceAccessPropertiesProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectory.WorkspaceAccessPropertiesProperty) | Struct | The device types and operating systems that can be used to access a WorkSpace. |
| [`CfnDirectoryProps`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnDirectoryProps) | Struct | Properties for defining a `CfnDirectory`. |
| [`CfnWorkspace.WorkspacePropertiesProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspace.WorkspacePropertiesProperty) | Struct | Information about a WorkSpace. |
| [`CfnWorkspaceIpGroup.IpRuleItemProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspaceIpGroup.IpRuleItemProperty) | Struct | Describes a rule for an IP access control group. |
| [`CfnWorkspaceIpGroupProps`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspaceIpGroupProps) | Struct | Properties for defining a `CfnWorkspaceIpGroup`. |
| [`CfnWorkspaceProps`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspaceProps) | Struct | Properties for defining a `CfnWorkspace`. |
| [`CfnWorkspacesPool.ApplicationSettingsProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspacesPool.ApplicationSettingsProperty) | Struct | The persistent application settings for users in the pool. |
| [`CfnWorkspacesPool.CapacityProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspacesPool.CapacityProperty) | Struct | Describes the user capacity for the pool. |
| [`CfnWorkspacesPool.TimeoutSettingsProperty`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspacesPool.TimeoutSettingsProperty) | Struct | Describes the timeout settings for the pool. |
| [`CfnWorkspacesPoolProps`](/v2/docs/aws-cdk-lib.aws_workspaces.CfnWorkspacesPoolProps) | Struct | Properties for defining a `CfnWorkspacesPool`. |