Package software.amazon.awscdk.services.iotsitewise

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.iotsitewise.CfnWorkspace
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWorkspaceRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-10T17:51:47.412Z") @Stability(Stable) public class CfnWorkspace extends CfnResource implements IInspectable, IWorkspaceRef, ITaggableV2
Represents an AWS IoT SiteWise workspace that provides logical isolation for tasks and pipelines.

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.iotsitewise.*;
 CfnWorkspace cfnWorkspace = CfnWorkspace.Builder.create(this, "MyCfnWorkspace")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .encryptionType("encryptionType")
                 .build())
         .workspaceName("workspaceName")
         // the properties below are optional
         .kmsKeyId("kmsKeyId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .workspaceDescription("workspaceDescription")
         .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::IoTSiteWise::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.

    • 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.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time the workspace was created.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The current state of the workspace.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The time the workspace was last updated.

    • getAttrWorkspaceArn

      @Stability(Stable) @NotNull public String getAttrWorkspaceArn()
      The ARN of the workspace.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getCfnPropertyNames

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

    • getWorkspaceRef

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

    • getEncryptionConfiguration

      @Stability(Stable) @NotNull public Object getEncryptionConfiguration()
      The encryption configuration for the workspace.

      Returns union: either IResolvable or CfnWorkspace.EncryptionConfigurationProperty

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@NotNull IResolvable value)
      The encryption configuration for the workspace.

    • setEncryptionConfiguration

      @Stability(Stable) public void setEncryptionConfiguration(@NotNull CfnWorkspace.EncryptionConfigurationProperty value)
      The encryption configuration for the workspace.

    • getWorkspaceName

      @Stability(Stable) @NotNull public String getWorkspaceName()
      The name of the workspace.

    • setWorkspaceName

      @Stability(Stable) public void setWorkspaceName(@NotNull String value)
      The name of the workspace.

    • getKmsKeyId

      @Stability(Stable) @Nullable public String getKmsKeyId()
      The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION.

    • setKmsKeyId

      @Stability(Stable) public void setKmsKeyId(@Nullable String value)
      The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getWorkspaceDescription

      @Stability(Stable) @Nullable public String getWorkspaceDescription()
      A description of the workspace.

    • setWorkspaceDescription

      @Stability(Stable) public void setWorkspaceDescription(@Nullable String value)
      A description of the workspace.