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

The AWS::IoTSiteWise::Workspace resource Property description not available. for IoTSiteWise.

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

Property description not available.

Required: Yes

Type: EncryptionConfiguration

Update requires: Replacement

KmsKeyId

The customer managed AWS KMS key used when encryptionType is KMS_BASED_ENCRYPTION. Accepts a key ID, key ARN, or key alias. Required for KMS_BASED_ENCRYPTION; must be omitted for SITEWISE_DEFAULT_ENCRYPTION. 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

Property description not available.

Required: No

Type: Array of Tag

Maximum: 50

Update requires: No interruption

WorkspaceDescription

Property description not available.

Required: No

Type: String

Minimum: 0

Maximum: 2048

Update requires: No interruption

WorkspaceName

Property description not available.

Required: Yes

Type: String

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

Minimum: 1

Maximum: 128

Update requires: Replacement

Return values

Ref

Fn::GetAtt

CreatedAt

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

Status

The status of the workspace.

UpdatedAt

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

WorkspaceArn

Property description not available.