software.amazon.awscdk.services.iottwinmaker

Interface CfnEntityProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnEntityProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.073Z")
 @Stability(value=Stable)
public interface CfnEntityProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnEntity`.

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;
 CfnEntityProps cfnEntityProps = CfnEntityProps.builder()
         .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	Interface and Description
static class	CfnEntityProps.Builder A builder for CfnEntityProps
static class	CfnEntityProps.Jsii$Proxy An implementation for CfnEntityProps

Method Summary

Modifier and Type	Method and Description
static CfnEntityProps.Builder	builder()
default Object	getComponents() An object that maps strings to the components in the entity.
default String	getDescription() The description of the entity.
default String	getEntityId() The entity ID.
String	getEntityName() The entity name.
default String	getParentEntityId() The ID of the parent entity.
default Map<String,String>	getTags() Metadata that you can use to manage the entity.
String	getWorkspaceId() The ID of the workspace.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEntityName

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

The entity name.

getWorkspaceId

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

The ID of the workspace.

getComponents

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

An object that maps strings to the components in the entity.

Each string in the mapping must be unique to this object.

For information on the component object see the component API reference.

getDescription

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

The description of the entity.

getEntityId

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

The entity ID.

getParentEntityId

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

The ID of the parent entity.

getTags

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

Metadata that you can use to manage the entity.

builder

@Stability(value=Stable)
static CfnEntityProps.Builder builder()

Returns:

a CfnEntityProps.Builder of CfnEntityProps