AWS::IoTTwinMaker::Scene

Use the AWS::IoTTwinMaker::Scene resource to declare a scene.

Syntax

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

JSON

{
  "Type" : "AWS::IoTTwinMaker::Scene",
  "Properties" : {
      "Capabilities" : [ String, ... ],
      "ContentLocation" : String,
      "Description" : String,
      "SceneId" : String,
      "SceneMetadata" : {Key: Value, ...},
      "Tags" : {Key: Value, ...},
      "WorkspaceId" : String
    }
}

YAML

Type: AWS::IoTTwinMaker::Scene
Properties: 
  Capabilities: 
    - String
  ContentLocation: String
  Description: String
  SceneId: String
  SceneMetadata: 
    Key: Value
  Tags: 
    Key: Value
  WorkspaceId: String

Properties

Capabilities

A list of capabilities that the scene uses to render.

Required: No

Type: List of String

Update requires: No interruption

ContentLocation

The relative path that specifies the location of the content definition file.

Required: Yes

Type: String

Update requires: No interruption

Description

The description of this scene.

Required: No

Type: String

Update requires: No interruption

SceneId

The scene ID.

Required: Yes

Type: String

Update requires: Replacement

SceneMetadata

The scene metadata.

Required: No

Type: Map of String

Update requires: No interruption

Tags

The ComponentType tags.

Required: No

Type: Map of String

Update requires: No interruption

WorkspaceId

The ID of the workspace.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Reffunction, Refreturns the workspace Id and the sence Id.

For more information about using the Reffunction, see Ref.

Fn::GetAtt

The Fn::GetAttintrinsic 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::GetAttintrinsic function, see Fn::GetAtt.

Arn

The scene ARN.

CreationDateTime

The date and time when the scene was created.

GeneratedSceneMetadata

The generated scene metadata.

UpdateDateTime

The scene the update time.