interface ComponentProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoTTwinMaker.CfnEntity.ComponentProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiottwinmaker#CfnEntity_ComponentProperty`
Java	`software.amazon.awscdk.services.iottwinmaker.CfnEntity.ComponentProperty`
Python	`aws_cdk.aws_iottwinmaker.CfnEntity.ComponentProperty`
TypeScript	`aws-cdk-lib` » `aws_iottwinmaker` » `CfnEntity` » `ComponentProperty`

The entity component.

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 componentProperty: iottwinmaker.CfnEntity.ComponentProperty = {
  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',
  },
};

Properties

Name	Type	Description
componentName?	`string`	The name of the component.
componentTypeId?	`string`	The ID of the component type.
definedIn?	`string`	The name of the property definition set in the request.
description?	`string`	The description of the component.
properties?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `PropertyProperty` `}`	An object that maps strings to the properties to set in the component type.
propertyGroups?	`IResolvable` `\| { [string]:` `IResolvable` `\|` `PropertyGroupProperty` `}`	An object that maps strings to the property groups in the component type.
status?	`IResolvable` `\|` `StatusProperty`	The status of the component.

componentName?

Type: string (optional)

The name of the component.

componentTypeId?

Type: string (optional)

The ID of the component type.

definedIn?

Type: string (optional)

The name of the property definition set in the request.

description?

Type: string (optional)

The description of the component.

properties?

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

An object that maps strings to the properties to set in the component type.

Each string in the mapping must be unique to this object.

propertyGroups?

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

An object that maps strings to the property groups in the component type.

Each string in the mapping must be unique to this object.

status?

Type: IResolvable | StatusProperty (optional)

The status of the component.