Package software.amazon.awscdk.services.workspaces

Interface CfnWorkspaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-30T01:25:18.486Z")
@Stability(Stable)
public interface CfnWorkspaceProps
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.workspaces.*;
 CfnWorkspaceProps cfnWorkspaceProps = CfnWorkspaceProps.builder()
         .bundleId("bundleId")
         .directoryId("directoryId")
         .userName("userName")
         // the properties below are optional
         .rootVolumeEncryptionEnabled(false)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .userVolumeEncryptionEnabled(false)
         .volumeEncryptionKey("volumeEncryptionKey")
         .workspaceProperties(WorkspacePropertiesProperty.builder()
                 .computeTypeName("computeTypeName")
                 .rootVolumeSizeGib(123)
                 .runningMode("runningMode")
                 .runningModeAutoStopTimeoutInMinutes(123)
                 .userVolumeSizeGib(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspaceProps.Builder	A builder for CfnWorkspaceProps
static final class	CfnWorkspaceProps.Jsii$Proxy	An implementation for CfnWorkspaceProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspaceProps.Builder	builder()
String	getBundleId()	The identifier of the bundle for the WorkSpace.
String	getDirectoryId()	The identifier of the AWS Directory Service directory for the WorkSpace.
default Object	getRootVolumeEncryptionEnabled()	Indicates whether the data stored on the root volume is encrypted.
default List<CfnTag>	getTags()	The tags for the WorkSpace.
String	getUserName()	The user name of the user for the WorkSpace.
default Object	getUserVolumeEncryptionEnabled()	Indicates whether the data stored on the user volume is encrypted.
default String	getVolumeEncryptionKey()	The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
default Object	getWorkspaceProperties()	The WorkSpace properties.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBundleId

@Stability(Stable)
@NotNull
String getBundleId()

The identifier of the bundle for the WorkSpace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-bundleid

getDirectoryId

@Stability(Stable)
@NotNull
String getDirectoryId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-directoryid

getUserName

@Stability(Stable)
@NotNull
String getUserName()

The user name of the user for the WorkSpace.

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

The reserved keyword, [UNDEFINED] , is used when creating user-decoupled WorkSpaces.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-username

getRootVolumeEncryptionEnabled

@Stability(Stable)
@Nullable
default Object getRootVolumeEncryptionEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-rootvolumeencryptionenabled

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags for the WorkSpace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-tags

getUserVolumeEncryptionEnabled

@Stability(Stable)
@Nullable
default Object getUserVolumeEncryptionEnabled()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-uservolumeencryptionenabled

getVolumeEncryptionKey

@Stability(Stable)
@Nullable
default String getVolumeEncryptionKey()

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

Amazon WorkSpaces does not support asymmetric KMS keys.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-volumeencryptionkey

getWorkspaceProperties

@Stability(Stable)
@Nullable
default Object getWorkspaceProperties()

The WorkSpace properties.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html#cfn-workspaces-workspace-workspaceproperties

builder

@Stability(Stable)
static CfnWorkspaceProps.Builder builder()

Returns:

a CfnWorkspaceProps.Builder of CfnWorkspaceProps