Package 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.104.0 (build e79254c)",
           date="2024-11-15T10:25:00.994Z")
@Stability(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()))
                         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnEntityProps.Builder	A builder for CfnEntityProps
static final class	CfnEntityProps.Jsii$Proxy	An implementation for CfnEntityProps

Method Summary

Modifier and Type	Method	Description
static CfnEntityProps.Builder	builder()
default Object	getComponents()	An object that maps strings to the components in the entity.
default Object	getCompositeComponents()	Maps string to compositeComponent updates in the request.
default String	getDescription()	The description of the entity.
default String	getEntityId()	The ID of the entity.
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 that contains the entity.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEntityName

@Stability(Stable)
@NotNull
String getEntityName()

The entity name.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-entityname

getWorkspaceId

@Stability(Stable)
@NotNull
String getWorkspaceId()

The ID of the workspace that contains the entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-workspaceid

getComponents

@Stability(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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-components

getCompositeComponents

@Stability(Stable)
@Nullable
default Object getCompositeComponents()

Maps string to compositeComponent updates in the request.

Each key of the map represents the componentPath of the compositeComponent .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-compositecomponents

getDescription

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

The description of the entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-description

getEntityId

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

The ID of the entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-entityid

getParentEntityId

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

The ID of the parent entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-parententityid

getTags

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

Metadata that you can use to manage the entity.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iottwinmaker-entity.html#cfn-iottwinmaker-entity-tags

builder

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

Returns:

a CfnEntityProps.Builder of CfnEntityProps