Package 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, IEnvironmentAware, IWorkspaceRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:38.569Z") @Stability(Stable) public class CfnWorkspace extends CfnResource implements IInspectable, IWorkspaceRef, ITaggable
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();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWorkspace

      protected CfnWorkspace(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWorkspace

      protected CfnWorkspace(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWorkspace

      @Stability(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 - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForWorkspace

      @Stability(Stable) @NotNull public static String arnForWorkspace(@NotNull IWorkspaceRef resource)
      Parameters:
      resource - This parameter is required.

    • fromWorkspaceArn

      @Stability(Stable) @NotNull public static IWorkspaceRef fromWorkspaceArn(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String arn)
      Creates a new IWorkspaceRef from an ARN.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      arn - This parameter is required.

    • fromWorkspaceId

      @Stability(Stable) @NotNull public static IWorkspaceRef fromWorkspaceId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String workspaceId)
      Creates a new IWorkspaceRef from a workspaceId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      workspaceId - This parameter is required.

    • isCfnWorkspace

      @Stability(Stable) @NotNull public static Boolean isCfnWorkspace(@NotNull Object x)
      Checks whether the given object is a CfnWorkspace.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(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(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(Stable) @NotNull public String getAttrArn()
      The workspace ARN.

    • getAttrCreationDateTime

      @Stability(Stable) @NotNull public String getAttrCreationDateTime()
      The date and time the workspace was created.

    • getAttrUpdateDateTime

      @Stability(Stable) @NotNull public String getAttrUpdateDateTime()
      The date and time the workspace was updated.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getWorkspaceRef

      @Stability(Stable) @NotNull public WorkspaceReference getWorkspaceRef()
      A reference to a Workspace resource.
      Specified by:
      getWorkspaceRef in interface IWorkspaceRef

    • getRole

      @Stability(Stable) @NotNull public String getRole()
      The ARN of the execution role associated with the workspace.

    • setRole

      @Stability(Stable) public void setRole(@NotNull String value)
      The ARN of the execution role associated with the workspace.

    • getS3Location

      @Stability(Stable) @NotNull public String getS3Location()
      The ARN of the S3 bucket where resources associated with the workspace are stored.

    • setS3Location

      @Stability(Stable) public void setS3Location(@NotNull String value)
      The ARN of the S3 bucket where resources associated with the workspace are stored.

    • getWorkspaceId

      @Stability(Stable) @NotNull public String getWorkspaceId()
      The ID of the workspace.

    • setWorkspaceId

      @Stability(Stable) public void setWorkspaceId(@NotNull String value)
      The ID of the workspace.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the workspace.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the workspace.

    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      Metadata that you can use to manage the workspace.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      Metadata that you can use to manage the workspace.