interface CfnWorkspaceProps

Language	Type name
.NET	Amazon.CDK.AWS.WorkSpaces.CfnWorkspaceProps
Java	software.amazon.awscdk.services.workspaces.CfnWorkspaceProps
Python	aws_cdk.aws_workspaces.CfnWorkspaceProps
TypeScript	@aws-cdk/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 * as workspaces from '@aws-cdk/aws-workspaces';
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

Name	Type	Description
bundleId	string	The identifier of the bundle for the WorkSpace.
directoryId	string	The identifier of the AWS Directory Service directory for the WorkSpace.
userName	string	The user name of the user for the WorkSpace.
rootVolumeEncryptionEnabled?	boolean | IResolvable	Indicates whether the data stored on the root volume is encrypted.
tags?	CfnTag[]	The tags for the WorkSpace.
userVolumeEncryptionEnabled?	boolean | IResolvable	Indicates whether the data stored on the user volume is encrypted.
volumeEncryptionKey?	string	The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
workspaceProperties?	IResolvable | WorkspacePropertiesProperty	The 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.