aws-cdk-lib.aws_iottwinmaker.CfnEntityProps

interface CfnEntityProps

LanguageType name
.NETAmazon.CDK.AWS.IoTTwinMaker.CfnEntityProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiottwinmaker#CfnEntityProps
Javasoftware.amazon.awscdk.services.iottwinmaker.CfnEntityProps
Pythonaws_cdk.aws_iottwinmaker.CfnEntityProps
TypeScript aws-cdk-lib » aws_iottwinmaker » CfnEntityProps

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 { 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',
      },
    },
  },
  description: 'description',
  entityId: 'entityId',
  parentEntityId: 'parentEntityId',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

NameTypeDescription
entityNamestringThe entity name.
workspaceIdstringThe ID of the workspace.
components?IResolvable | { [string]: IResolvable | ComponentProperty }An object that maps strings to the components in the entity.
description?stringThe description of the entity.
entityId?stringThe entity ID.
parentEntityId?stringThe ID of the parent entity.
tags?{ [string]: string }Metadata that you can use to manage the entity.

entityName

Type: string

The entity name.


workspaceId

Type: string

The ID of the workspace.


components?

Type: IResolvable | { [string]: IResolvable | ComponentProperty } (optional)

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.


description?

Type: string (optional)

The description of the entity.


entityId?

Type: string (optional)

The entity ID.


parentEntityId?

Type: string (optional)

The ID of the parent entity.


tags?

Type: { [string]: string } (optional)

Metadata that you can use to manage the entity.