Class CfnWorkspace

Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnWorkspace

Implements

IInspectable

IWorkspaceRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTTwinMaker

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnWorkspace : CfnResource, IInspectable, IWorkspaceRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnWorkspace Inherits CfnResource Implements IInspectable, IWorkspaceRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::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.IoTTwinMaker;

             var cfnWorkspace = new CfnWorkspace(this, "MyCfnWorkspace", new CfnWorkspaceProps {
                 Role = "role",
                 S3Location = "s3Location",
                 WorkspaceId = "workspaceId",

                 // the properties below are optional
                 Description = "description",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

Synopsis

Constructors

CfnWorkspace(Construct, string, ICfnWorkspaceProps)

Create a new AWS::IoTTwinMaker::Workspace.

Properties

AttrArn	The workspace ARN.
AttrCreationDateTime	The date and time the workspace was created.
AttrUpdateDateTime	The date and time the workspace was updated.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.
Description	The description of the workspace.
Role	The ARN of the execution role associated with the workspace.
S3Location	The ARN of the S3 bucket where resources associated with the workspace are stored.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Metadata that you can use to manage the workspace.
WorkspaceId	The ID of the workspace.
WorkspaceRef	A reference to a Workspace resource.

Methods

ArnForWorkspace(IWorkspaceRef)	Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.
FromWorkspaceArn(Construct, string, string)	Creates a new IWorkspaceRef from an ARN.
FromWorkspaceId(Construct, string, string)	Creates a new IWorkspaceRef from a workspaceId.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnWorkspace(object)	Checks whether the given object is a CfnWorkspace.
RenderProperties(IDictionary<string, object>)	Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.

Constructors

CfnWorkspace(Construct, string, ICfnWorkspaceProps)

Create a new AWS::IoTTwinMaker::Workspace.

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

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnWorkspaceProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

Properties

AttrArn

The workspace ARN.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationDateTime

The date and time the workspace was created.

public virtual string AttrCreationDateTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationDateTime

AttrUpdateDateTime

The date and time the workspace was updated.

public virtual string AttrUpdateDateTime { get; }

Property Value

string

Remarks

CloudformationAttribute: UpdateDateTime

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

CfnProperties

Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

Description

The description of the workspace.

public virtual string? Description { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

Role

The ARN of the execution role associated with the workspace.

public virtual string Role { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

S3Location

The ARN of the S3 bucket where resources associated with the workspace are stored.

public virtual string S3Location { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

TagsRaw

Metadata that you can use to manage the workspace.

public virtual IDictionary<string, string>? TagsRaw { get; set; }

Property Value

IDictionary<string, string>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

WorkspaceId

The ID of the workspace.

public virtual string WorkspaceId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

WorkspaceRef

A reference to a Workspace resource.

public virtual IWorkspaceReference WorkspaceRef { get; }

Property Value

IWorkspaceReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

Methods

ArnForWorkspace(IWorkspaceRef)

Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.

public static string ArnForWorkspace(IWorkspaceRef resource)

Parameters

resource IWorkspaceRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::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.IoTTwinMaker;

             var cfnWorkspace = new CfnWorkspace(this, "MyCfnWorkspace", new CfnWorkspaceProps {
                 Role = "role",
                 S3Location = "s3Location",
                 WorkspaceId = "workspaceId",

                 // the properties below are optional
                 Description = "description",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 }
             });

FromWorkspaceArn(Construct, string, string)

Creates a new IWorkspaceRef from an ARN.

public static IWorkspaceRef FromWorkspaceArn(Construct scope, string id, string arn)

Parameters

scope Construct

id string

arn string

Returns

IWorkspaceRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

FromWorkspaceId(Construct, string, string)

Creates a new IWorkspaceRef from a workspaceId.

public static IWorkspaceRef FromWorkspaceId(Construct scope, string id, string workspaceId)

Parameters

scope Construct

id string

workspaceId string

Returns

IWorkspaceRef

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

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.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

IsCfnWorkspace(object)

Checks whether the given object is a CfnWorkspace.

public static bool IsCfnWorkspace(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Use the AWS::IoTTwinMaker::Workspace resource to declare a workspace.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-workspace.html

CloudformationResource: AWS::IoTTwinMaker::Workspace

ExampleMetadata: fixture=_generated

Implements

IInspectable

IWorkspaceRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable