Package software.amazon.awscdk.services.iotsitewise

Interface CfnWorkspaceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWorkspaceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)",
           date="2026-09-10T17:51:47.414Z")
@Stability(Stable)
public interface CfnWorkspaceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWorkspace.

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.*;
 CfnWorkspaceProps cfnWorkspaceProps = CfnWorkspaceProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-workspace.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWorkspaceProps.Builder	A builder for CfnWorkspaceProps
static final class	CfnWorkspaceProps.Jsii$Proxy	An implementation for CfnWorkspaceProps

Method Summary

Modifier and Type	Method	Description
static CfnWorkspaceProps.Builder	builder()
Object	getEncryptionConfiguration()	The encryption configuration for the workspace.
default String	getKmsKeyId()	The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getWorkspaceDescription()	A description of the workspace.
String	getWorkspaceName()	The name of the workspace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEncryptionConfiguration

@Stability(Stable)
@NotNull
Object getEncryptionConfiguration()

The encryption configuration for the workspace.

Returns union: either IResolvable or CfnWorkspace.EncryptionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-workspace.html#cfn-iotsitewise-workspace-encryptionconfiguration

getWorkspaceName

@Stability(Stable)
@NotNull
String getWorkspaceName()

The name of the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-workspace.html#cfn-iotsitewise-workspace-workspacename

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The ARN of the AWS KMS key used for KMS_BASED_ENCRYPTION.

Required when EncryptionConfiguration.EncryptionType is KMS_BASED_ENCRYPTION.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-workspace.html#cfn-iotsitewise-workspace-kmskeyid

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

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

getWorkspaceDescription

@Stability(Stable)
@Nullable
default String getWorkspaceDescription()

A description of the workspace.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-workspace.html#cfn-iotsitewise-workspace-workspacedescription

builder

@Stability(Stable)
static CfnWorkspaceProps.Builder builder()

Returns:

a CfnWorkspaceProps.Builder of CfnWorkspaceProps