java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
All Implemented Interfaces:
IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)", date="2024-06-13T18:49:20.394Z") @Stability(Stable) public class CfnEntity extends CfnResource implements IInspectable, ITaggable
Use the AWS::IoTTwinMaker::Entity resource to declare an 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()))
                         .propertyGroups(Map.of(
                                 "propertyGroupsKey", PropertyGroupProperty.builder()
                                         .groupType("groupType")
                                         .propertyNames(List.of("propertyNames"))
                                         .build()))
                         .status(StatusProperty.builder()
                                 .error(error)
                                 .state("state")
                                 .build())
                         .build()))
         .compositeComponents(Map.of(
                 "compositeComponentsKey", CompositeComponentProperty.builder()
                         .componentName("componentName")
                         .componentPath("componentPath")
                         .componentTypeId("componentTypeId")
                         .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()))
                         .propertyGroups(Map.of(
                                 "propertyGroupsKey", PropertyGroupProperty.builder()
                                         .groupType("groupType")
                                         .propertyNames(List.of("propertyNames"))
                                         .build()))
                         .status(StatusProperty.builder()
                                 .error(error)
                                 .state("state")
                                 .build())
                         .build()))
         .description("description")
         .entityId("entityId")
         .parentEntityId("parentEntityId")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:
  • 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

    • CfnEntity

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

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

      @Stability(Stable) public CfnEntity(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnEntityProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). 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 entity ARN.
    • getAttrCreationDateTime

      @Stability(Stable) @NotNull public String getAttrCreationDateTime()
      The date and time the entity was created.
    • getAttrHasChildEntities

      @Stability(Stable) @NotNull public IResolvable getAttrHasChildEntities()
      A boolean value that specifies whether the entity has child entities or not.
    • getAttrStatus

      @Stability(Stable) @NotNull public IResolvable getAttrStatus()
    • getAttrStatusError

      @Stability(Stable) @NotNull public IResolvable getAttrStatusError()
    • getAttrStatusErrorCode

      @Stability(Stable) @NotNull public String getAttrStatusErrorCode()
    • getAttrStatusErrorMessage

      @Stability(Stable) @NotNull public String getAttrStatusErrorMessage()
    • getAttrStatusState

      @Stability(Stable) @NotNull public String getAttrStatusState()
    • getAttrUpdateDateTime

      @Stability(Stable) @NotNull public String getAttrUpdateDateTime()
      The date and time when the component type was last updated.
    • getCfnProperties

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

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable
    • getEntityName

      @Stability(Stable) @NotNull public String getEntityName()
      The entity name.
    • setEntityName

      @Stability(Stable) public void setEntityName(@NotNull String value)
      The entity name.
    • getWorkspaceId

      @Stability(Stable) @NotNull public String getWorkspaceId()
      The ID of the workspace that contains the entity.
    • setWorkspaceId

      @Stability(Stable) public void setWorkspaceId(@NotNull String value)
      The ID of the workspace that contains the entity.
    • getComponents

      @Stability(Stable) @Nullable public Object getComponents()
      An object that maps strings to the components in the entity.
    • setComponents

      @Stability(Stable) public void setComponents(@Nullable IResolvable value)
      An object that maps strings to the components in the entity.
    • setComponents

      @Stability(Stable) public void setComponents(@Nullable Map<String,Object> value)
      An object that maps strings to the components in the entity.
    • getCompositeComponents

      @Stability(Stable) @Nullable public Object getCompositeComponents()
      Maps string to compositeComponent updates in the request.
    • setCompositeComponents

      @Stability(Stable) public void setCompositeComponents(@Nullable IResolvable value)
      Maps string to compositeComponent updates in the request.
    • setCompositeComponents

      @Stability(Stable) public void setCompositeComponents(@Nullable Map<String,Object> value)
      Maps string to compositeComponent updates in the request.
    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the entity.
    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the entity.
    • getEntityId

      @Stability(Stable) @Nullable public String getEntityId()
      The ID of the entity.
    • setEntityId

      @Stability(Stable) public void setEntityId(@Nullable String value)
      The ID of the entity.
    • getParentEntityId

      @Stability(Stable) @Nullable public String getParentEntityId()
      The ID of the parent entity.
    • setParentEntityId

      @Stability(Stable) public void setParentEntityId(@Nullable String value)
      The ID of the parent entity.
    • getTagsRaw

      @Stability(Stable) @Nullable public Map<String,String> getTagsRaw()
      Metadata that you can use to manage the entity.
    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable Map<String,String> value)
      Metadata that you can use to manage the entity.