Skip to content
v2.274.0

Amazon WorkSpaces Construct Library ​

This module is part of the AWS Cloud Development Kit project.

ts
import * as workspaces from 'aws-cdk-lib/aws-workspaces';
python
import aws_cdk.aws_workspaces as workspaces
java
import software.amazon.awscdk.services.workspaces.*;
csharp
using Amazon.CDK.AWS.WorkSpaces;
go
import workspaces "github.com/aws/aws-cdk-go/awscdk"

There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:

There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 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.

(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)

Types ​

NameKindSummary
CfnConnectionAliasConstruct (L1)The AWS::WorkSpaces::ConnectionAlias resource specifies a connection alias.
CfnDirectoryConstruct (L1)Resource Type definition for AWS::WorkSpaces::Directory.
CfnWorkspaceConstruct (L1)The AWS::WorkSpaces::Workspace resource specifies a WorkSpace.
CfnWorkspaceIpGroupConstruct (L1)Resource Type definition for an IP access control group for Amazon WorkSpaces.
CfnWorkspacesPoolConstruct (L1)Describes a pool of WorkSpaces.
CfnConnectionAlias.ConnectionAliasAssociationPropertyStructDescribes a connection alias association that is used for cross-Region redirection.
CfnConnectionAliasPropsStructProperties for defining a CfnConnectionAlias.
CfnDirectory.AccessEndpointConfigPropertyStructDescribes the access endpoint configuration for a WorkSpace.
CfnDirectory.AccessEndpointPropertyStructDescribes the access type and endpoint for a WorkSpace.
CfnDirectory.ActiveDirectoryConfigPropertyStructInformation about the Active Directory config.
CfnDirectory.CertificateBasedAuthPropertiesPropertyStructDescribes the properties of the certificate-based authentication you want to use with your WorkSpaces.
CfnDirectory.DefaultWorkspaceCreationPropertiesPropertyStructThe default values that are used to create WorkSpaces.
CfnDirectory.GlobalAcceleratorForDirectoryPropertyStructDescribes the Global Accelerator for directory.
CfnDirectory.IDCConfigPropertyStructSpecifies the configurations of the identity center.
CfnDirectory.MicrosoftEntraConfigPropertyStructSpecifies the configurations of the Microsoft Entra.
CfnDirectory.SamlPropertiesPropertyStructDescribes 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.SelfservicePermissionsPropertyStructDescribes the self-service permissions for a directory.
CfnDirectory.StorageConnectorPropertyStructDescribes the storage connector.
CfnDirectory.StreamingPropertiesPropertyStructDescribes the streaming properties.
CfnDirectory.UserSettingPropertyStructInformation about the user's permission settings.
CfnDirectory.WorkspaceAccessPropertiesPropertyStructThe device types and operating systems that can be used to access a WorkSpace.
CfnDirectoryPropsStructProperties for defining a CfnDirectory.
CfnWorkspace.WorkspacePropertiesPropertyStructInformation about a WorkSpace.
CfnWorkspaceIpGroup.IpRuleItemPropertyStructDescribes a rule for an IP access control group.
CfnWorkspaceIpGroupPropsStructProperties for defining a CfnWorkspaceIpGroup.
CfnWorkspacePropsStructProperties for defining a CfnWorkspace.
CfnWorkspacesPool.ApplicationSettingsPropertyStructThe persistent application settings for users in the pool.
CfnWorkspacesPool.CapacityPropertyStructDescribes the user capacity for the pool.
CfnWorkspacesPool.TimeoutSettingsPropertyStructDescribes the timeout settings for the pool.
CfnWorkspacesPoolPropsStructProperties for defining a CfnWorkspacesPool.