CfnSceneProps

class aws_cdk.aws_iottwinmaker.CfnSceneProps(*, content_location, scene_id, workspace_id, capabilities=None, description=None, scene_metadata=None, tags=None)

Bases: object

Properties for defining a CfnScene.

Parameters:
  • content_location (str) – The relative path that specifies the location of the content definition file.

  • scene_id (str) – The scene ID.

  • workspace_id (str) – The ID of the workspace.

  • capabilities (Optional[Sequence[str]]) – A list of capabilities that the scene uses to render.

  • description (Optional[str]) – The description of this scene.

  • scene_metadata (Union[IResolvable, Mapping[str, str], None]) – The scene metadata.

  • tags (Optional[Mapping[str, str]]) – The ComponentType tags.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.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"
    }
)

Attributes

capabilities

A list of capabilities that the scene uses to render.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-capabilities

content_location

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-contentlocation

description

The description of this scene.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-description

scene_id

The scene ID.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-sceneid

scene_metadata

The scene metadata.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-scenemetadata

tags

The ComponentType tags.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-tags

workspace_id

The ID of the workspace.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-scene.html#cfn-iottwinmaker-scene-workspaceid