Skip to content
v2.275.0

CfnSceneProps Struct ​

Properties for defining a CfnScene.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iottwinmaker as iottwinmaker } from 'aws-cdk-lib';
const cfnSceneProps: iottwinmaker.CfnSceneProps = {
  contentLocation: 'contentLocation',
  sceneId: 'sceneId',
  workspaceId: 'workspaceId',

  // the properties below are optional
  capabilities: ['capabilities'],
  description: 'description',
  sceneMetadata: {
    sceneMetadataKey: 'sceneMetadata',
  },
  tags: {
    tagsKey: 'tags',
  },
};

Properties ​

capabilitiesoptionalstring[]capabilitiesoptionaltyping.List[str]capabilitiesoptionalList<String>Capabilitiesoptionalstring[]Capabilitiesoptional*[]*string#
A list of capabilities that the scene uses to render.
contentLocationstringcontent_locationstrcontentLocationStringContentLocationstringContentLocation*stringrequired#
The relative path that specifies the location of the content definition file.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of this scene.
sceneIdstringscene_idstrsceneIdStringSceneIdstringSceneId*stringrequired#
The ID of the scene.
sceneMetadataoptionalIResolvable | { [key: string]: string }scene_metadataoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]sceneMetadataoptionalIResolvableSceneMetadataoptionalIResolvableSceneMetadataoptionalinterface{}#
The scene metadata.
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#
The ComponentType tags.
workspaceIdstringworkspace_idstrworkspaceIdStringWorkspaceIdstringWorkspaceId*stringrequired#
The ID of the workspace.