Package software.amazon.awscdk.services.iottwinmaker

Interface CfnSceneProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSceneProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-08-02T00:29:12.370Z")
@Stability(Stable)
public interface CfnSceneProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnScene.

Example:

 // 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSceneProps.Builder	A builder for CfnSceneProps
static final class	CfnSceneProps.Jsii$Proxy	An implementation for CfnSceneProps

Method Summary

Modifier and Type	Method	Description
static CfnSceneProps.Builder	builder()
default List<String>	getCapabilities()	A list of capabilities that the scene uses to render.
String	getContentLocation()	The relative path that specifies the location of the content definition file.
default String	getDescription()	The description of this scene.
String	getSceneId()	The ID of the scene.
default Object	getSceneMetadata()	The scene metadata.
default Map<String,String>	getTags()	The ComponentType tags.
String	getWorkspaceId()	The ID of the scene.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getContentLocation

@Stability(Stable)
@NotNull
String getContentLocation()

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

See Also:

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

getSceneId

@Stability(Stable)
@NotNull
String getSceneId()

The ID of the scene.

See Also:

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

getWorkspaceId

@Stability(Stable)
@NotNull
String getWorkspaceId()

The ID of the scene.

See Also:

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

getCapabilities

@Stability(Stable)
@Nullable
default List<String> getCapabilities()

A list of capabilities that the scene uses to render.

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of this scene.

See Also:

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

getSceneMetadata

@Stability(Stable)
@Nullable
default Object getSceneMetadata()

The scene metadata.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

The ComponentType tags.

See Also:

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

builder

@Stability(Stable)
static CfnSceneProps.Builder builder()

Returns:

a CfnSceneProps.Builder of CfnSceneProps