software.amazon.awscdk.services.iottwinmaker

Class CfnScene

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.iottwinmaker.CfnScene

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.074Z")
 @Stability(value=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")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnScene.Builder A fluent builder for CfnScene.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnScene(software.constructs.Construct scope, String id, CfnSceneProps props) Create a new `AWS::IoTTwinMaker::Scene`.
protected	CfnScene(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnScene(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The scene ARN.
String	getAttrCreationDateTime() The date and time when the scene was created.
String	getAttrUpdateDateTime() The scene the update time.
List<String>	getCapabilities() A list of capabilities that the scene uses to render.
protected Map<String,Object>	getCfnProperties()
String	getContentLocation() The relative path that specifies the location of the content definition file.
String	getDescription() The description of this scene.
String	getSceneId() The scene ID.
TagManager	getTags() The ComponentType tags.
String	getWorkspaceId() The ID of the workspace.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCapabilities(List<String> value) A list of capabilities that the scene uses to render.
void	setContentLocation(String value) The relative path that specifies the location of the content definition file.
void	setDescription(String value) The description of this scene.
void	setSceneId(String value) The scene ID.
void	setWorkspaceId(String value) The ID of the workspace.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnScene

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

CfnScene

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

CfnScene

@Stability(value=Stable)
public CfnScene(@NotNull
                                         software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The scene ARN.

getAttrCreationDateTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreationDateTime()

The date and time when the scene was created.

getAttrUpdateDateTime

@Stability(value=Stable)
 @NotNull
public String getAttrUpdateDateTime()

The scene the update time.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

The ComponentType tags.

getContentLocation

@Stability(value=Stable)
 @NotNull
public String getContentLocation()

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

setContentLocation

@Stability(value=Stable)
public void setContentLocation(@NotNull
                                                        String value)

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

getSceneId

@Stability(value=Stable)
 @NotNull
public String getSceneId()

The scene ID.

setSceneId

@Stability(value=Stable)
public void setSceneId(@NotNull
                                                String value)

The scene ID.

getWorkspaceId

@Stability(value=Stable)
 @NotNull
public String getWorkspaceId()

The ID of the workspace.

setWorkspaceId

@Stability(value=Stable)
public void setWorkspaceId(@NotNull
                                                    String value)

The ID of the workspace.

getCapabilities

@Stability(value=Stable)
 @Nullable
public List<String> getCapabilities()

A list of capabilities that the scene uses to render.

setCapabilities

@Stability(value=Stable)
public void setCapabilities(@Nullable
                                                     List<String> value)

A list of capabilities that the scene uses to render.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of this scene.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of this scene.