aws-cdk-lib.aws_workspaces.CfnWorkspaceProps

interface CfnWorkspaceProps

LanguageType name
.NETAmazon.CDK.AWS.WorkSpaces.CfnWorkspaceProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsworkspaces#CfnWorkspaceProps
Javasoftware.amazon.awscdk.services.workspaces.CfnWorkspaceProps
Pythonaws_cdk.aws_workspaces.CfnWorkspaceProps
TypeScript aws-cdk-lib » aws_workspaces » CfnWorkspaceProps

Properties for defining a CfnWorkspace.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspaces as workspaces } from 'aws-cdk-lib';
const cfnWorkspaceProps: workspaces.CfnWorkspaceProps = {
  bundleId: 'bundleId',
  directoryId: 'directoryId',
  userName: 'userName',

  // the properties below are optional
  rootVolumeEncryptionEnabled: false,
  tags: [{
    key: 'key',
    value: 'value',
  }],
  userVolumeEncryptionEnabled: false,
  volumeEncryptionKey: 'volumeEncryptionKey',
  workspaceProperties: {
    computeTypeName: 'computeTypeName',
    rootVolumeSizeGib: 123,
    runningMode: 'runningMode',
    runningModeAutoStopTimeoutInMinutes: 123,
    userVolumeSizeGib: 123,
  },
};

Properties

NameTypeDescription
bundleIdstringThe identifier of the bundle for the WorkSpace.
directoryIdstringThe identifier of the AWS Directory Service directory for the WorkSpace.
userNamestringThe user name of the user for the WorkSpace.
rootVolumeEncryptionEnabled?boolean | IResolvableIndicates whether the data stored on the root volume is encrypted.
tags?CfnTag[]The tags for the WorkSpace.
userVolumeEncryptionEnabled?boolean | IResolvableIndicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey?stringThe symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
workspaceProperties?IResolvable | WorkspacePropertiesPropertyThe WorkSpace properties.

bundleId

Type: string

The identifier of the bundle for the WorkSpace.


directoryId

Type: string

The identifier of the AWS Directory Service directory for the WorkSpace.


userName

Type: string

The user name of the user for the WorkSpace.

This user name must exist in the AWS Directory Service directory for the WorkSpace.


rootVolumeEncryptionEnabled?

Type: boolean | IResolvable (optional)

Indicates whether the data stored on the root volume is encrypted.


tags?

Type: CfnTag[] (optional)

The tags for the WorkSpace.


userVolumeEncryptionEnabled?

Type: boolean | IResolvable (optional)

Indicates whether the data stored on the user volume is encrypted.


volumeEncryptionKey?

Type: string (optional)

The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.

Amazon WorkSpaces does not support asymmetric KMS keys.


workspaceProperties?

Type: IResolvable | WorkspacePropertiesProperty (optional)

The WorkSpace properties.