aws-cdk-lib.aws_workspaces.CfnWorkspaceProps

CfnWorkspaceProps Struct

Properties for defining a CfnWorkspace.

Source

Generated code

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

bundleIdstringbundle_idstrbundleIdStringBundleIdstringBundleId*stringrequired#

The identifier of the bundle for the WorkSpace.

directoryIdstringdirectory_idstrdirectoryIdStringDirectoryIdstringDirectoryId*stringrequired#

The identifier of the Directory Service directory for the WorkSpace.

rootVolumeEncryptionEnabledboolean | IResolvableroot_volume_encryption_enabledtyping.Union[bool, IResolvable]rootVolumeEncryptionEnabledBooleanRootVolumeEncryptionEnabledboolRootVolumeEncryptionEnabledinterface{}#

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

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#

The tags for the WorkSpace.

userNamestringuser_namestruserNameStringUserNamestringUserName*stringrequired#

The user name of the user for the WorkSpace.

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

userVolumeEncryptionEnabledboolean | IResolvableuser_volume_encryption_enabledtyping.Union[bool, IResolvable]userVolumeEncryptionEnabledBooleanUserVolumeEncryptionEnabledboolUserVolumeEncryptionEnabledinterface{}#

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

volumeEncryptionKeystringvolume_encryption_keystrvolumeEncryptionKeyStringVolumeEncryptionKeystringVolumeEncryptionKey*string#

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

Amazon WorkSpaces does not support asymmetric KMS keys.

workspacePropertiesIResolvable | CfnWorkspace.WorkspacePropertiesPropertyworkspace_propertiestyping.Union[IResolvable, WorkspacePropertiesProperty]workspacePropertiesIResolvableWorkspacePropertiesIResolvableWorkspacePropertiesinterface{}#

The WorkSpace properties.

Used as props by

• CfnWorkspace