Class CfnWorkspace
The AWS::WorkSpaces::Workspace
resource specifies a WorkSpace.
Inherited Members
Namespace: Amazon.CDK.AWS.WorkSpaces
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnWorkspace : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnWorkspace
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-workspaces-workspace.html
CloudformationResource: AWS::WorkSpaces::Workspace
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpaces;
var cfnWorkspace = new CfnWorkspace(this, "MyCfnWorkspace", new CfnWorkspaceProps {
BundleId = "bundleId",
DirectoryId = "directoryId",
UserName = "userName",
// the properties below are optional
RootVolumeEncryptionEnabled = false,
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
UserVolumeEncryptionEnabled = false,
VolumeEncryptionKey = "volumeEncryptionKey",
WorkspaceProperties = new WorkspacePropertiesProperty {
ComputeTypeName = "computeTypeName",
RootVolumeSizeGib = 123,
RunningMode = "runningMode",
RunningModeAutoStopTimeoutInMinutes = 123,
UserVolumeSizeGib = 123
}
});
Synopsis
Constructors
CfnWorkspace(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnWorkspace(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnWorkspace(Construct, String, ICfnWorkspaceProps) |
Properties
AttrId | The identifier of the WorkSpace, returned as a string. |
BundleId | The identifier of the bundle for the WorkSpace. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DirectoryId | The identifier of the AWS Directory Service directory for the WorkSpace. |
RootVolumeEncryptionEnabled | Indicates whether the data stored on the root volume is encrypted. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags for the WorkSpace. |
UserName | The user name of the user for the WorkSpace. |
UserVolumeEncryptionEnabled | Indicates whether the data stored on the user volume is encrypted. |
VolumeEncryptionKey | The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace. |
WorkspaceProperties | The WorkSpace properties. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnWorkspace(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnWorkspace(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnWorkspace(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnWorkspace(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnWorkspace(Construct, String, ICfnWorkspaceProps)
public CfnWorkspace(Construct scope, string id, ICfnWorkspaceProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnWorkspaceProps
Resource properties.
Properties
AttrId
The identifier of the WorkSpace, returned as a string.
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
BundleId
The identifier of the bundle for the WorkSpace.
public virtual string BundleId { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DirectoryId
The identifier of the AWS Directory Service directory for the WorkSpace.
public virtual string DirectoryId { get; set; }
Property Value
System.String
RootVolumeEncryptionEnabled
Indicates whether the data stored on the root volume is encrypted.
public virtual object RootVolumeEncryptionEnabled { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
UserName
The user name of the user for the WorkSpace.
public virtual string UserName { get; set; }
Property Value
System.String
UserVolumeEncryptionEnabled
Indicates whether the data stored on the user volume is encrypted.
public virtual object UserVolumeEncryptionEnabled { get; set; }
Property Value
System.Object
VolumeEncryptionKey
The ARN of the symmetric AWS KMS key used to encrypt data stored on your WorkSpace.
public virtual string VolumeEncryptionKey { get; set; }
Property Value
System.String
WorkspaceProperties
The WorkSpace properties.
public virtual object WorkspaceProperties { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>