software.amazon.awscdk.services.iottwinmaker

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.iottwinmaker.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:40.074Z")
 @Stability(value=Stable)
public class CfnWorkspace
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTTwinMaker::Workspace`.

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

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.iottwinmaker.*;
 CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
         .role("role")
         .s3Location("s3Location")
         .workspaceId("workspaceId")
         // the properties below are optional
         .description("description")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnWorkspace.Builder A fluent builder for CfnWorkspace.

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::IoTTwinMaker::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	getAttrArn() The workspace ARN.
String	getAttrCreationDateTime() The date and time the workspace was created.
String	getAttrUpdateDateTime() The date and time the workspace was updated.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the workspace.
String	getRole() The ARN of the execution role associated with the workspace.
String	getS3Location() The ARN of the S3 bucket where resources associated with the workspace are stored.
TagManager	getTags() Metadata that you can use to manage the workspace.
String	getWorkspaceId() The ID of the workspace.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the workspace.
void	setRole(String value) The ARN of the execution role associated with the workspace.
void	setS3Location(String value) The ARN of the S3 bucket where resources associated with the workspace are stored.
void	setWorkspaceId(String value) The ID of the workspace.

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::IoTTwinMaker::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.

getAttrArn

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

The workspace ARN.

getAttrCreationDateTime

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

The date and time the workspace was created.

getAttrUpdateDateTime

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

The date and time the workspace was updated.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

Metadata that you can use to manage the workspace.

getRole

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

The ARN of the execution role associated with the workspace.

setRole

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

The ARN of the execution role associated with the workspace.

getS3Location

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

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

setS3Location

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

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

getWorkspaceId

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

The ID of the workspace.

setWorkspaceId

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

The ID of the workspace.

getDescription

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

The description of the workspace.

setDescription

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

The description of the workspace.