software.amazon.awscdk.services.workspaces

Class CfnWorkspace

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.workspaces.CfnWorkspace

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.831Z")
 @Stability(value=Stable)
public class CfnWorkspace
extends CfnResource
implements IInspectable

A CloudFormation `AWS::WorkSpaces::Workspace`.

The AWS::WorkSpaces::Workspace resource specifies a WorkSpace.

Updates are not supported for the BundleId , RootVolumeEncryptionEnabled , UserVolumeEncryptionEnabled , or VolumeEncryptionKey properties. To update these properties, you must also update a property that triggers a replacement, such as the UserName property.

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.*;
 CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWorkspace.Builder A fluent builder for CfnWorkspace.
static interface	CfnWorkspace.WorkspacePropertiesProperty Information about a WorkSpace.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnWorkspace(software.constructs.Construct scope, String id, CfnWorkspaceProps props) Create a new `AWS::WorkSpaces::Workspace`.
protected	CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getBundleId() The identifier of the bundle for the WorkSpace.
protected Map<String,Object>	getCfnProperties()
String	getDirectoryId() The identifier of the AWS Directory Service directory for the WorkSpace.
Object	getRootVolumeEncryptionEnabled() Indicates whether the data stored on the root volume is encrypted.
TagManager	getTags() The tags for the WorkSpace.
String	getUserName() The user name of the user for the WorkSpace.
Object	getUserVolumeEncryptionEnabled() Indicates whether the data stored on the user volume is encrypted.
String	getVolumeEncryptionKey() The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
Object	getWorkspaceProperties() The WorkSpace properties.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBundleId(String value) The identifier of the bundle for the WorkSpace.
void	setDirectoryId(String value) The identifier of the AWS Directory Service directory for the WorkSpace.
void	setRootVolumeEncryptionEnabled(Boolean value) Indicates whether the data stored on the root volume is encrypted.
void	setRootVolumeEncryptionEnabled(IResolvable value) Indicates whether the data stored on the root volume is encrypted.
void	setUserName(String value) The user name of the user for the WorkSpace.
void	setUserVolumeEncryptionEnabled(Boolean value) Indicates whether the data stored on the user volume is encrypted.
void	setUserVolumeEncryptionEnabled(IResolvable value) Indicates whether the data stored on the user volume is encrypted.
void	setVolumeEncryptionKey(String value) The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
void	setWorkspaceProperties(CfnWorkspace.WorkspacePropertiesProperty value) The WorkSpace properties.
void	setWorkspaceProperties(IResolvable value) The WorkSpace properties.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnWorkspace

protected CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)

CfnWorkspace

protected CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnWorkspace

@Stability(value=Stable)
public CfnWorkspace(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnWorkspaceProps props)

Create a new `AWS::WorkSpaces::Workspace`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The tags for the WorkSpace.

getBundleId

@Stability(value=Stable)
 @NotNull
public String getBundleId()

The identifier of the bundle for the WorkSpace.

setBundleId

@Stability(value=Stable)
public void setBundleId(@NotNull
                                                 String value)

The identifier of the bundle for the WorkSpace.

getDirectoryId

@Stability(value=Stable)
 @NotNull
public String getDirectoryId()

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

setDirectoryId

@Stability(value=Stable)
public void setDirectoryId(@NotNull
                                                    String value)

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

getUserName

@Stability(value=Stable)
 @NotNull
public 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.

setUserName

@Stability(value=Stable)
public void setUserName(@NotNull
                                                 String value)

The user name of the user for the WorkSpace.

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

getRootVolumeEncryptionEnabled

@Stability(value=Stable)
 @Nullable
public Object getRootVolumeEncryptionEnabled()

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

setRootVolumeEncryptionEnabled

@Stability(value=Stable)
public void setRootVolumeEncryptionEnabled(@Nullable
                                                                    Boolean value)

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

setRootVolumeEncryptionEnabled

@Stability(value=Stable)
public void setRootVolumeEncryptionEnabled(@Nullable
                                                                    IResolvable value)

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

getUserVolumeEncryptionEnabled

@Stability(value=Stable)
 @Nullable
public Object getUserVolumeEncryptionEnabled()

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

setUserVolumeEncryptionEnabled

@Stability(value=Stable)
public void setUserVolumeEncryptionEnabled(@Nullable
                                                                    Boolean value)

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

setUserVolumeEncryptionEnabled

@Stability(value=Stable)
public void setUserVolumeEncryptionEnabled(@Nullable
                                                                    IResolvable value)

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

getVolumeEncryptionKey

@Stability(value=Stable)
 @Nullable
public String getVolumeEncryptionKey()

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

Amazon WorkSpaces does not support asymmetric KMS keys.

setVolumeEncryptionKey

@Stability(value=Stable)
public void setVolumeEncryptionKey(@Nullable
                                                            String value)

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

Amazon WorkSpaces does not support asymmetric KMS keys.

getWorkspaceProperties

@Stability(value=Stable)
 @Nullable
public Object getWorkspaceProperties()

The WorkSpace properties.

setWorkspaceProperties

@Stability(value=Stable)
public void setWorkspaceProperties(@Nullable
                                                            CfnWorkspace.WorkspacePropertiesProperty value)

The WorkSpace properties.

setWorkspaceProperties

@Stability(value=Stable)
public void setWorkspaceProperties(@Nullable
                                                            IResolvable value)

The WorkSpace properties.