Class CfnWorkspace

A CloudFormation AWS::WorkSpaces::Workspace.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnWorkspace

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.WorkSpaces

Assembly: Amazon.CDK.AWS.WorkSpaces.dll

Syntax (csharp)

public class CfnWorkspace : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnWorkspace
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

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.

CloudformationResource: AWS::WorkSpaces::Workspace

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

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;

CfnWorkspace 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(Construct, String, ICfnWorkspaceProps)	Create a new AWS::WorkSpaces::Workspace.
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

Properties

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	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 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(Construct, String, ICfnWorkspaceProps)

Create a new AWS::WorkSpaces::Workspace.

public CfnWorkspace(Construct scope, string id, ICfnWorkspaceProps props)

Parameters

scope Construct

• scope in which this resource is defined.

id System.String

• scoped id of the resource.

props ICfnWorkspaceProps

• resource properties.

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

Properties

BundleId

The identifier of the bundle for the WorkSpace.

public virtual string BundleId { get; set; }

Property Value

System.String

Remarks

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

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

CfnResource.CfnProperties

DirectoryId

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

public virtual string DirectoryId { get; set; }

Property Value

System.String

Remarks

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

RootVolumeEncryptionEnabled

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

public virtual object RootVolumeEncryptionEnabled { get; set; }

Property Value

System.Object

Remarks

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

Tags

The tags for the WorkSpace.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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

UserName

The user name of the user for the WorkSpace.

public virtual string UserName { get; set; }

Property Value

System.String

Remarks

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

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

UserVolumeEncryptionEnabled

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

public virtual object UserVolumeEncryptionEnabled { get; set; }

Property Value

System.Object

Remarks

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

VolumeEncryptionKey

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

public virtual string VolumeEncryptionKey { get; set; }

Property Value

System.String

Remarks

Amazon WorkSpaces does not support asymmetric KMS keys.

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

WorkspaceProperties

The WorkSpace properties.

public virtual object WorkspaceProperties { get; set; }

Property Value

System.Object

Remarks

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

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>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable