AWS::IoTTwinMaker::Workspace
Use the AWS::IoTTwinMaker::Workspace
resource to declare a workspace.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoTTwinMaker::Workspace", "Properties" : { "Description" :
String
, "Role" :String
, "S3Location" :String
, "Tags" :{
, "WorkspaceId" :Key
:Value
, ...}String
} }
YAML
Type: AWS::IoTTwinMaker::Workspace Properties: Description:
String
Role:String
S3Location:String
Tags:WorkspaceId:
Key
:Value
String
Properties
Description
-
The description of the workspace.
Required: No
Type: String
Minimum:
0
Maximum:
512
Update requires: No interruption
Role
-
The ARN of the execution role associated with the workspace.
Required: Yes
Type: String
Pattern:
arn:((aws)|(aws-cn)|(aws-us-gov)):iam::[0-9]{12}:role/.*
Minimum:
20
Maximum:
2048
Update requires: No interruption
S3Location
-
The ARN of the S3 bucket where resources associated with the workspace are stored.
Required: Yes
Type: String
Update requires: No interruption
-
Metadata that you can use to manage the workspace.
Required: No
Type: Object of String
Pattern:
^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$
Minimum:
1
Maximum:
256
Update requires: No interruption
WorkspaceId
-
The ID of the workspace.
Required: Yes
Type: String
Pattern:
[a-zA-Z_0-9][a-zA-Z_\-0-9]*[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 workspace Id and the entity Id.
For more information about using the Ref
function, see Ref
.
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
.
Arn
-
The workspace ARN.
CreationDateTime
-
The date and time the workspace was created.
UpdateDateTime
-
The date and time the workspace was updated.