AWS::IoTTwinMaker::Scene
Use the AWS::IoTTwinMaker::Scene
resource to declare a scene.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::IoTTwinMaker::Scene", "Properties" : { "Capabilities" :
[ String, ... ]
, "ContentLocation" :String
, "Description" :String
, "SceneId" :String
, "SceneMetadata" :{
, "Tags" :Key
:Value
, ...}{
, "WorkspaceId" :Key
:Value
, ...}String
} }
YAML
Type: AWS::IoTTwinMaker::Scene Properties: Capabilities:
- String
ContentLocation:String
Description:String
SceneId:String
SceneMetadata:Tags:
Key
:Value
WorkspaceId:
Key
:Value
String
Properties
Capabilities
-
A list of capabilities that the scene uses to render.
Required: No
Type: Array of String
Minimum:
0 | 0
Maximum:
256 | 50
Update requires: No interruption
ContentLocation
-
The relative path that specifies the location of the content definition file.
Required: Yes
Type: String
Pattern:
[sS]3://[A-Za-z0-9._/-]+
Minimum:
0
Maximum:
256
Update requires: No interruption
Description
-
The description of this scene.
Required: No
Type: String
Minimum:
0
Maximum:
512
Update requires: No interruption
SceneId
-
The ID of the scene.
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
SceneMetadata
-
The scene metadata.
Required: No
Type: Object of String
Pattern:
[a-zA-Z_\-0-9]+
Minimum:
0
Maximum:
2048
Update requires: No interruption
-
The ComponentType tags.
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 scene 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 scene ARN.
CreationDateTime
-
The date and time when the scene was created.
UpdateDateTime
-
The scene the update time.