View a markdown version of this page

AWS::IoTSiteWise::Workspace - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::IoTSiteWise::Workspace

Creates a workspace in AWS IoT SiteWise. You must specify an encryption configuration when you create a workspace.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::IoTSiteWise::Workspace",
  "Properties" : {
      "EncryptionConfiguration" : EncryptionConfiguration,
      "KmsKeyId" : String,
      "Tags" : [ Tag, ... ],
      "WorkspaceDescription" : String,
      "WorkspaceName" : String
    }
}

YAML

Type: AWS::IoTSiteWise::Workspace
Properties:
  EncryptionConfiguration: 
    EncryptionConfiguration
  KmsKeyId: String
  Tags: 
    - Tag
  WorkspaceDescription: String
  WorkspaceName: String

Properties

EncryptionConfiguration

Specifies the encryption configuration to apply to the workspace, including whether to use the default AWS IoT SiteWise key or a customer managed AWS KMS key.

Required: Yes

Type: EncryptionConfiguration

Update requires: Replacement

KmsKeyId

The customer managed AWS KMS key used when EncryptionConfiguration.EncryptionType is KMS_BASED_ENCRYPTION.

  • Accepted formats – Key ID, key ARN, or key alias.

  • When required – Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION.

  • Immutability – After a workspace's customer managed key configuration becomes active, the key can't be changed.

Required: No

Type: String

Pattern: ^arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/.+$

Minimum: 1

Maximum: 2048

Update requires: Replacement

Tags

A list of key-value pairs that contain metadata for the workspace. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

WorkspaceDescription

A description for the workspace.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Update requires: No interruption

WorkspaceName

The name of the workspace to create.

Required: Yes

Type: String

Pattern: ^[a-zA-Z0-9_-]+$

Minimum: 1

Maximum: 128

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the WorkspaceArn.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

CreatedAt

The date the workspace was created, in Unix epoch time.

Status

The current state of the workspace.

UpdatedAt

The date the workspace was last updated, in Unix epoch time.

WorkspaceArn

The ARN of the workspace.