# CfnEntityProps

Properties for defining a `CfnEntity`.

Used as props by: [CfnEntity](/cdk/api/v2/docs/aws-cdk-lib.aws_iottwinmaker.CfnEntity.html)

- Source: Generated at build time
- Type last changed: v2.112.0 · 1 Dec 2023

## Example

TypeScript:

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iottwinmaker as iottwinmaker } from 'aws-cdk-lib';

declare const dataValueProperty_: iottwinmaker.CfnEntity.DataValueProperty;
declare const definition: any;
declare const error: any;
declare const relationshipValue: any;
const cfnEntityProps: iottwinmaker.CfnEntityProps = {
  entityName: 'entityName',
  workspaceId: 'workspaceId',

  // the properties below are optional
  components: {
    componentsKey: {
      componentName: 'componentName',
      componentTypeId: 'componentTypeId',
      definedIn: 'definedIn',
      description: 'description',
      properties: {
        propertiesKey: {
          definition: definition,
          value: {
            booleanValue: false,
            doubleValue: 123,
            expression: 'expression',
            integerValue: 123,
            listValue: [dataValueProperty_],
            longValue: 123,
            mapValue: {
              mapValueKey: dataValueProperty_,
            },
            relationshipValue: relationshipValue,
            stringValue: 'stringValue',
          },
        },
      },
      propertyGroups: {
        propertyGroupsKey: {
          groupType: 'groupType',
          propertyNames: ['propertyNames'],
        },
      },
      status: {
        error: error,
        state: 'state',
      },
    },
  },
  compositeComponents: {
    compositeComponentsKey: {
      componentName: 'componentName',
      componentPath: 'componentPath',
      componentTypeId: 'componentTypeId',
      description: 'description',
      properties: {
        propertiesKey: {
          definition: definition,
          value: {
            booleanValue: false,
            doubleValue: 123,
            expression: 'expression',
            integerValue: 123,
            listValue: [dataValueProperty_],
            longValue: 123,
            mapValue: {
              mapValueKey: dataValueProperty_,
            },
            relationshipValue: relationshipValue,
            stringValue: 'stringValue',
          },
        },
      },
      propertyGroups: {
        propertyGroupsKey: {
          groupType: 'groupType',
          propertyNames: ['propertyNames'],
        },
      },
      status: {
        error: error,
        state: 'state',
      },
    },
  },
  description: 'description',
  entityId: 'entityId',
  parentEntityId: 'parentEntityId',
  tags: {
    tagsKey: 'tags',
  },
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iottwinmaker as iottwinmaker

# data_value_property_: iottwinmaker.CfnEntity.DataValueProperty
# definition: Any
# error: Any
# relationship_value: Any

cfn_entity_props = iottwinmaker.CfnEntityProps(
    entity_name="entityName",
    workspace_id="workspaceId",

    # the properties below are optional
    components={
        "components_key": iottwinmaker.CfnEntity.ComponentProperty(
            component_name="componentName",
            component_type_id="componentTypeId",
            defined_in="definedIn",
            description="description",
            properties={
                "properties_key": iottwinmaker.CfnEntity.PropertyProperty(
                    definition=definition,
                    value=iottwinmaker.CfnEntity.DataValueProperty(
                        boolean_value=False,
                        double_value=123,
                        expression="expression",
                        integer_value=123,
                        list_value=[data_value_property_],
                        long_value=123,
                        map_value={
                            "map_value_key": data_value_property_
                        },
                        relationship_value=relationship_value,
                        string_value="stringValue"
                    )
                )
            },
            property_groups={
                "property_groups_key": iottwinmaker.CfnEntity.PropertyGroupProperty(
                    group_type="groupType",
                    property_names=["propertyNames"]
                )
            },
            status=iottwinmaker.CfnEntity.StatusProperty(
                error=error,
                state="state"
            )
        )
    },
    composite_components={
        "composite_components_key": iottwinmaker.CfnEntity.CompositeComponentProperty(
            component_name="componentName",
            component_path="componentPath",
            component_type_id="componentTypeId",
            description="description",
            properties={
                "properties_key": iottwinmaker.CfnEntity.PropertyProperty(
                    definition=definition,
                    value=iottwinmaker.CfnEntity.DataValueProperty(
                        boolean_value=False,
                        double_value=123,
                        expression="expression",
                        integer_value=123,
                        list_value=[data_value_property_],
                        long_value=123,
                        map_value={
                            "map_value_key": data_value_property_
                        },
                        relationship_value=relationship_value,
                        string_value="stringValue"
                    )
                )
            },
            property_groups={
                "property_groups_key": iottwinmaker.CfnEntity.PropertyGroupProperty(
                    group_type="groupType",
                    property_names=["propertyNames"]
                )
            },
            status=iottwinmaker.CfnEntity.StatusProperty(
                error=error,
                state="state"
            )
        )
    },
    description="description",
    entity_id="entityId",
    parent_entity_id="parentEntityId",
    tags={
        "tags_key": "tags"
    }
)
```

Java:

```java
// 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTTwinMaker;

DataValueProperty dataValueProperty_;
var definition;
var error;
var relationshipValue;

var cfnEntityProps = new CfnEntityProps {
    EntityName = "entityName",
    WorkspaceId = "workspaceId",

    // the properties below are optional
    Components = new Dictionary<string, object> {
        { "componentsKey", new ComponentProperty {
            ComponentName = "componentName",
            ComponentTypeId = "componentTypeId",
            DefinedIn = "definedIn",
            Description = "description",
            Properties = new Dictionary<string, object> {
                { "propertiesKey", new PropertyProperty {
                    Definition = definition,
                    Value = new DataValueProperty {
                        BooleanValue = false,
                        DoubleValue = 123,
                        Expression = "expression",
                        IntegerValue = 123,
                        ListValue = new [] { dataValueProperty_ },
                        LongValue = 123,
                        MapValue = new Dictionary<string, object> {
                            { "mapValueKey", dataValueProperty_ }
                        },
                        RelationshipValue = relationshipValue,
                        StringValue = "stringValue"
                    }
                } }
            },
            PropertyGroups = new Dictionary<string, object> {
                { "propertyGroupsKey", new PropertyGroupProperty {
                    GroupType = "groupType",
                    PropertyNames = new [] { "propertyNames" }
                } }
            },
            Status = new StatusProperty {
                Error = error,
                State = "state"
            }
        } }
    },
    CompositeComponents = new Dictionary<string, object> {
        { "compositeComponentsKey", new CompositeComponentProperty {
            ComponentName = "componentName",
            ComponentPath = "componentPath",
            ComponentTypeId = "componentTypeId",
            Description = "description",
            Properties = new Dictionary<string, object> {
                { "propertiesKey", new PropertyProperty {
                    Definition = definition,
                    Value = new DataValueProperty {
                        BooleanValue = false,
                        DoubleValue = 123,
                        Expression = "expression",
                        IntegerValue = 123,
                        ListValue = new [] { dataValueProperty_ },
                        LongValue = 123,
                        MapValue = new Dictionary<string, object> {
                            { "mapValueKey", dataValueProperty_ }
                        },
                        RelationshipValue = relationshipValue,
                        StringValue = "stringValue"
                    }
                } }
            },
            PropertyGroups = new Dictionary<string, object> {
                { "propertyGroupsKey", new PropertyGroupProperty {
                    GroupType = "groupType",
                    PropertyNames = new [] { "propertyNames" }
                } }
            },
            Status = new StatusProperty {
                Error = error,
                State = "state"
            }
        } }
    },
    Description = "description",
    EntityId = "entityId",
    ParentEntityId = "parentEntityId",
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var dataValueProperty_ DataValueProperty
var definition interface{}
var error interface{}
var relationshipValue interface{}

cfnEntityProps := &CfnEntityProps{
	EntityName: jsii.String("entityName"),
	WorkspaceId: jsii.String("workspaceId"),

	// the properties below are optional
	Components: map[string]interface{}{
		"componentsKey": &ComponentProperty{
			"componentName": jsii.String("componentName"),
			"componentTypeId": jsii.String("componentTypeId"),
			"definedIn": jsii.String("definedIn"),
			"description": jsii.String("description"),
			"properties": map[string]interface{}{
				"propertiesKey": &PropertyProperty{
					"definition": definition,
					"value": &DataValueProperty{
						"booleanValue": jsii.Boolean(false),
						"doubleValue": jsii.Number(123),
						"expression": jsii.String("expression"),
						"integerValue": jsii.Number(123),
						"listValue": []interface{}{
							dataValueProperty_,
						},
						"longValue": jsii.Number(123),
						"mapValue": map[string]interface{}{
							"mapValueKey": dataValueProperty_,
						},
						"relationshipValue": relationshipValue,
						"stringValue": jsii.String("stringValue"),
					},
				},
			},
			"propertyGroups": map[string]interface{}{
				"propertyGroupsKey": &PropertyGroupProperty{
					"groupType": jsii.String("groupType"),
					"propertyNames": []*string{
						jsii.String("propertyNames"),
					},
				},
			},
			"status": &StatusProperty{
				"error": error,
				"state": jsii.String("state"),
			},
		},
	},
	CompositeComponents: map[string]interface{}{
		"compositeComponentsKey": &CompositeComponentProperty{
			"componentName": jsii.String("componentName"),
			"componentPath": jsii.String("componentPath"),
			"componentTypeId": jsii.String("componentTypeId"),
			"description": jsii.String("description"),
			"properties": map[string]interface{}{
				"propertiesKey": &PropertyProperty{
					"definition": definition,
					"value": &DataValueProperty{
						"booleanValue": jsii.Boolean(false),
						"doubleValue": jsii.Number(123),
						"expression": jsii.String("expression"),
						"integerValue": jsii.Number(123),
						"listValue": []interface{}{
							dataValueProperty_,
						},
						"longValue": jsii.Number(123),
						"mapValue": map[string]interface{}{
							"mapValueKey": dataValueProperty_,
						},
						"relationshipValue": relationshipValue,
						"stringValue": jsii.String("stringValue"),
					},
				},
			},
			"propertyGroups": map[string]interface{}{
				"propertyGroupsKey": &PropertyGroupProperty{
					"groupType": jsii.String("groupType"),
					"propertyNames": []*string{
						jsii.String("propertyNames"),
					},
				},
			},
			"status": &StatusProperty{
				"error": error,
				"state": jsii.String("state"),
			},
		},
	},
	Description: jsii.String("description"),
	EntityId: jsii.String("entityId"),
	ParentEntityId: jsii.String("parentEntityId"),
	Tags: map[string]*string{
		"tagsKey": jsii.String("tags"),
	},
}
```

## Properties

- `components`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEntity.ComponentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_iottwinmaker.CfnEntity.ComponentProperty.html) } — 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](https://docs.aws.amazon.com//iot-twinmaker/latest/apireference/API_ComponentResponse.html) API reference.

- `compositeComponents`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | { [key: string]: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnEntity.CompositeComponentProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_iottwinmaker.CfnEntity.CompositeComponentProperty.html) } — Maps string to `compositeComponent` updates in the request.

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

- `description`: string — The description of the entity.

- `entityId`: string — The ID of the entity.

- `entityName`: string (required) — The entity name.

- `parentEntityId`: string — The ID of the parent entity.

- `tags`: { [key: string]: string } — Metadata that you can use to manage the entity.

- `workspaceId`: string (required) — The ID of the workspace that contains the entity.
