interface CfnEntityMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IoTTwinMaker.Mixins.CfnEntityMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiottwinmaker/mixins#CfnEntityMixinProps
Java	software.amazon.awscdk.mixins.preview.services.iottwinmaker.mixins.CfnEntityMixinProps
Python	aws_cdk.mixins_preview.aws_iottwinmaker.mixins.CfnEntityMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_iottwinmaker » mixins » CfnEntityMixinProps

Properties for CfnEntityPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iottwinmaker_mixins } from '@aws-cdk/mixins-preview/aws-iottwinmaker';

declare const dataValueProperty_: iottwinmaker_mixins.CfnEntityPropsMixin.DataValueProperty;
declare const definition: any;
declare const error: any;
declare const relationshipValue: any;
const cfnEntityMixinProps: iottwinmaker_mixins.CfnEntityMixinProps = {
  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',
  entityName: 'entityName',
  parentEntityId: 'parentEntityId',
  tags: {
    tagsKey: 'tags',
  },
  workspaceId: 'workspaceId',
};

Properties

Name	Type	Description
components?	IResolvable | { [string]: IResolvable | ComponentProperty }	An object that maps strings to the components in the entity.
compositeComponents?	IResolvable | { [string]: IResolvable | CompositeComponentProperty }	Maps string to compositeComponent updates in the request.
description?	string	The description of the entity.
entityId?	string	The ID of the entity.
entityName?	string	The entity name.
parentEntityId?	string	The ID of the parent entity.
tags?	{ [string]: string }	Metadata that you can use to manage the entity.
workspaceId?	string	The ID of the workspace that contains the entity.

---

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.

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

---

compositeComponents?

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

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

---

description?

Type: string (optional)

The description of the entity.

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

---

entityId?

Type: string (optional)

The ID of the entity.

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

---

entityName?

Type: string (optional)

The entity name.

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

---

parentEntityId?

Type: string (optional)

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

---

tags?

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

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

---

workspaceId?

Type: string (optional)

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