@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:40.837Z") public class CfnWorkspace extends CfnResource implements IInspectable
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();
Modifier and Type | Class and Description |
---|---|
static class |
CfnWorkspace.Builder
A fluent builder for
CfnWorkspace . |
static interface |
CfnWorkspace.WorkspacePropertiesProperty
Information about a WorkSpace.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnWorkspace(Construct scope,
java.lang.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) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getBundleId()
The identifier of the bundle for the WorkSpace.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.String |
getDirectoryId()
The identifier of the AWS Directory Service directory for the WorkSpace.
|
java.lang.Object |
getRootVolumeEncryptionEnabled()
Indicates whether the data stored on the root volume is encrypted.
|
TagManager |
getTags()
The tags for the WorkSpace.
|
java.lang.String |
getUserName()
The user name of the user for the WorkSpace.
|
java.lang.Object |
getUserVolumeEncryptionEnabled()
Indicates whether the data stored on the user volume is encrypted.
|
java.lang.String |
getVolumeEncryptionKey()
The symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
|
java.lang.Object |
getWorkspaceProperties()
The WorkSpace properties.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setBundleId(java.lang.String value)
The identifier of the bundle for the WorkSpace.
|
void |
setDirectoryId(java.lang.String value)
The identifier of the AWS Directory Service directory for the WorkSpace.
|
void |
setRootVolumeEncryptionEnabled(java.lang.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(java.lang.String value)
The user name of the user for the WorkSpace.
|
void |
setUserVolumeEncryptionEnabled(java.lang.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(java.lang.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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnWorkspace(Construct scope, java.lang.String id, CfnWorkspaceProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.String getBundleId()
public void setBundleId(java.lang.String value)
public java.lang.String getDirectoryId()
public void setDirectoryId(java.lang.String value)
public java.lang.String getUserName()
This user name must exist in the AWS Directory Service directory for the WorkSpace.
public void setUserName(java.lang.String value)
This user name must exist in the AWS Directory Service directory for the WorkSpace.
public java.lang.Object getRootVolumeEncryptionEnabled()
public void setRootVolumeEncryptionEnabled(java.lang.Boolean value)
public void setRootVolumeEncryptionEnabled(IResolvable value)
public java.lang.Object getUserVolumeEncryptionEnabled()
public void setUserVolumeEncryptionEnabled(java.lang.Boolean value)
public void setUserVolumeEncryptionEnabled(IResolvable value)
public java.lang.String getVolumeEncryptionKey()
Amazon WorkSpaces does not support asymmetric KMS keys.
public void setVolumeEncryptionKey(java.lang.String value)
Amazon WorkSpaces does not support asymmetric KMS keys.
public java.lang.Object getWorkspaceProperties()
public void setWorkspaceProperties(IResolvable value)
public void setWorkspaceProperties(CfnWorkspace.WorkspacePropertiesProperty value)