Skip to content
v2.278.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',
  },
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iottwinmaker as iottwinmaker

cfn_scene_props = iottwinmaker.CfnSceneProps(
    content_location="contentLocation",
    scene_id="sceneId",
    workspace_id="workspaceId",

    # the properties below are optional
    capabilities=["capabilities"],
    description="description",
    scene_metadata={
        "scene_metadata_key": "sceneMetadata"
    },
    tags={
        "tags_key": "tags"
    }
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.iottwinmaker.*;

CfnSceneProps cfnSceneProps = CfnSceneProps.builder()
        .contentLocation("contentLocation")
        .sceneId("sceneId")
        .workspaceId("workspaceId")

        // the properties below are optional
        .capabilities(List.of("capabilities"))
        .description("description")
        .sceneMetadata(Map.of(
                "sceneMetadataKey", "sceneMetadata"))
        .tags(Map.of(
                "tagsKey", "tags"))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTTwinMaker;

var cfnSceneProps = new CfnSceneProps {
    ContentLocation = "contentLocation",
    SceneId = "sceneId",
    WorkspaceId = "workspaceId",

    // the properties below are optional
    Capabilities = new [] { "capabilities" },
    Description = "description",
    SceneMetadata = new Dictionary<string, string> {
        { "sceneMetadataKey", "sceneMetadata" }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnSceneProps := &CfnSceneProps{
	ContentLocation: jsii.String("contentLocation"),
	SceneId: jsii.String("sceneId"),
	WorkspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	Capabilities: []*string{
		jsii.String("capabilities"),
	},
	Description: jsii.String("description"),
	SceneMetadata: map[string]*string{
		"sceneMetadataKey": jsii.String("sceneMetadata"),
	},
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}

Properties ​

capabilitiesoptionalstring[]capabilitiesoptionaltyping.List[str]capabilitiesoptionalList<String>Capabilitiesoptionalstring[]Capabilitiesoptional*[]*string #
A list of capabilities that the scene uses to render.
contentLocationstringcontent_locationstrcontentLocationStringContentLocationstringContentLocation*string required #
The relative path that specifies the location of the content definition file.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string #
The description of this scene.
sceneIdstringscene_idstrsceneIdStringSceneIdstringSceneId*string required #
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*string required #
The ID of the workspace.