software.amazon.awscdk.services.iottwinmaker

Class CfnEntity

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.CfnEntity

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:32.795Z")
 @Stability(value=Stable)
public class CfnEntity
extends CfnResource
implements IInspectable

A CloudFormation `AWS::IoTTwinMaker::Entity`.

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.*;
 DataValueProperty dataValueProperty_;
 Object definition;
 Object error;
 Object relationshipValue;
 CfnEntity cfnEntity = CfnEntity.Builder.create(this, "MyCfnEntity")
         .entityName("entityName")
         .workspaceId("workspaceId")
         // the properties below are optional
         .components(Map.of(
                 "componentsKey", ComponentProperty.builder()
                         .componentName("componentName")
                         .componentTypeId("componentTypeId")
                         .definedIn("definedIn")
                         .description("description")
                         .properties(Map.of(
                                 "propertiesKey", PropertyProperty.builder()
                                         .definition(definition)
                                         .value(DataValueProperty.builder()
                                                 .booleanValue(false)
                                                 .doubleValue(123)
                                                 .expression("expression")
                                                 .integerValue(123)
                                                 .listValue(List.of(dataValueProperty_))
                                                 .longValue(123)
                                                 .mapValue(Map.of(
                                                         "mapValueKey", dataValueProperty_))
                                                 .relationshipValue(relationshipValue)
                                                 .stringValue("stringValue")
                                                 .build())
                                         .build()))
                         .status(StatusProperty.builder()
                                 .error(error)
                                 .state("state")
                                 .build())
                         .build()))
         .description("description")
         .entityId("entityId")
         .parentEntityId("parentEntityId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEntity.Builder A fluent builder for CfnEntity.
static interface	CfnEntity.ComponentProperty Example:
static interface	CfnEntity.DataValueProperty Example:
static interface	CfnEntity.PropertyProperty Example:
static interface	CfnEntity.StatusProperty Example:

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

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
	CfnEntity(Construct scope, String id, CfnEntityProps props) Create a new `AWS::IoTTwinMaker::Entity`.
protected	CfnEntity(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEntity(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrCreationDateTime()
IResolvable	getAttrHasChildEntities()
String	getAttrUpdateDateTime()
protected Map<String,Object>	getCfnProperties()
Object	getComponents() `AWS::IoTTwinMaker::Entity.Components`.
String	getDescription() `AWS::IoTTwinMaker::Entity.Description`.
String	getEntityId() `AWS::IoTTwinMaker::Entity.EntityId`.
String	getEntityName() `AWS::IoTTwinMaker::Entity.EntityName`.
String	getParentEntityId() `AWS::IoTTwinMaker::Entity.ParentEntityId`.
TagManager	getTags() `AWS::IoTTwinMaker::Entity.Tags`.
String	getWorkspaceId() `AWS::IoTTwinMaker::Entity.WorkspaceId`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComponents(IResolvable value) `AWS::IoTTwinMaker::Entity.Components`.
void	setComponents(Map<String,Object> value) `AWS::IoTTwinMaker::Entity.Components`.
void	setDescription(String value) `AWS::IoTTwinMaker::Entity.Description`.
void	setEntityId(String value) `AWS::IoTTwinMaker::Entity.EntityId`.
void	setEntityName(String value) `AWS::IoTTwinMaker::Entity.EntityName`.
void	setParentEntityId(String value) `AWS::IoTTwinMaker::Entity.ParentEntityId`.
void	setWorkspaceId(String value) `AWS::IoTTwinMaker::Entity.WorkspaceId`.

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

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

CfnEntity

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

CfnEntity

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

CfnEntity

@Stability(value=Stable)
public CfnEntity(@NotNull
                                          Construct scope,
                                          @NotNull
                                          String id,
                                          @NotNull
                                          CfnEntityProps props)

Create a new `AWS::IoTTwinMaker::Entity`.

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

getAttrCreationDateTime

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

getAttrHasChildEntities

@Stability(value=Stable)
 @NotNull
public IResolvable getAttrHasChildEntities()

getAttrUpdateDateTime

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::IoTTwinMaker::Entity.Tags`.

getEntityName

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

`AWS::IoTTwinMaker::Entity.EntityName`.

setEntityName

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

`AWS::IoTTwinMaker::Entity.EntityName`.

getWorkspaceId

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

`AWS::IoTTwinMaker::Entity.WorkspaceId`.

setWorkspaceId

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

`AWS::IoTTwinMaker::Entity.WorkspaceId`.

getComponents

@Stability(value=Stable)
 @Nullable
public Object getComponents()

`AWS::IoTTwinMaker::Entity.Components`.

setComponents

@Stability(value=Stable)
public void setComponents(@Nullable
                                                   IResolvable value)

`AWS::IoTTwinMaker::Entity.Components`.

setComponents

@Stability(value=Stable)
public void setComponents(@Nullable
                                                   Map<String,Object> value)

`AWS::IoTTwinMaker::Entity.Components`.

getDescription

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

`AWS::IoTTwinMaker::Entity.Description`.

setDescription

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

`AWS::IoTTwinMaker::Entity.Description`.

getEntityId

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

`AWS::IoTTwinMaker::Entity.EntityId`.

setEntityId

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

`AWS::IoTTwinMaker::Entity.EntityId`.

getParentEntityId

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

`AWS::IoTTwinMaker::Entity.ParentEntityId`.

setParentEntityId

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

`AWS::IoTTwinMaker::Entity.ParentEntityId`.