Package software.amazon.awscdk.services.iottwinmaker

Class CfnScene

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.iottwinmaker.CfnScene
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.968Z") @Stability(Stable) public class CfnScene extends CfnResource implements IInspectable
A CloudFormation AWS::IoTTwinMaker::Scene.

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

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.*;
 CfnScene cfnScene = CfnScene.Builder.create(this, "MyCfnScene")
         .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();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnScene

      protected CfnScene(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnScene

      protected CfnScene(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnScene

      @Stability(Stable) public CfnScene(@NotNull Construct scope, @NotNull String id, @NotNull CfnSceneProps props)
      Create a new AWS::IoTTwinMaker::Scene.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The scene ARN.

    • getAttrCreationDateTime

      @Stability(Stable) @NotNull public String getAttrCreationDateTime()
      The date and time when the scene was created.

    • getAttrGeneratedSceneMetadata

      @Stability(Stable) @NotNull public IResolvable getAttrGeneratedSceneMetadata()
      The generated scene metadata.

    • getAttrUpdateDateTime

      @Stability(Stable) @NotNull public String getAttrUpdateDateTime()
      The scene the update time.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      The ComponentType tags.

    • getContentLocation

      @Stability(Stable) @NotNull public String getContentLocation()
      The relative path that specifies the location of the content definition file.

    • setContentLocation

      @Stability(Stable) public void setContentLocation(@NotNull String value)
      The relative path that specifies the location of the content definition file.

    • getSceneId

      @Stability(Stable) @NotNull public String getSceneId()
      The scene ID.

    • setSceneId

      @Stability(Stable) public void setSceneId(@NotNull String value)
      The scene ID.

    • getWorkspaceId

      @Stability(Stable) @NotNull public String getWorkspaceId()
      The ID of the workspace.

    • setWorkspaceId

      @Stability(Stable) public void setWorkspaceId(@NotNull String value)
      The ID of the workspace.

    • getCapabilities

      @Stability(Stable) @Nullable public List<String> getCapabilities()
      A list of capabilities that the scene uses to render.

    • setCapabilities

      @Stability(Stable) public void setCapabilities(@Nullable List<String> value)
      A list of capabilities that the scene uses to render.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of this scene.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of this scene.

    • getSceneMetadata

      @Stability(Stable) @Nullable public Object getSceneMetadata()
      The scene metadata.

    • setSceneMetadata

      @Stability(Stable) public void setSceneMetadata(@Nullable IResolvable value)
      The scene metadata.

    • setSceneMetadata

      @Stability(Stable) public void setSceneMetadata(@Nullable Map<String,String> value)
      The scene metadata.