aws-cdk-lib.aws_iottwinmaker.CfnEntity.DefinitionProperty

interface DefinitionProperty

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

The entity definition.

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 dataTypeProperty_: iottwinmaker.CfnEntity.DataTypeProperty;
declare const dataValueProperty_: iottwinmaker.CfnEntity.DataValueProperty;
declare const relationshipValue: any;
const definitionProperty: iottwinmaker.CfnEntity.DefinitionProperty = {
  configuration: {
    configurationKey: 'configuration',
  },
  dataType: {
    allowedValues: [{
      booleanValue: false,
      doubleValue: 123,
      expression: 'expression',
      integerValue: 123,
      listValue: [dataValueProperty_],
      longValue: 123,
      mapValue: {
        mapValueKey: dataValueProperty_,
      },
      relationshipValue: relationshipValue,
      stringValue: 'stringValue',
    }],
    nestedType: dataTypeProperty_,
    relationship: {
      relationshipType: 'relationshipType',
      targetComponentTypeId: 'targetComponentTypeId',
    },
    type: 'type',
    unitOfMeasure: 'unitOfMeasure',
  },
  defaultValue: {
    booleanValue: false,
    doubleValue: 123,
    expression: 'expression',
    integerValue: 123,
    listValue: [dataValueProperty_],
    longValue: 123,
    mapValue: {
      mapValueKey: dataValueProperty_,
    },
    relationshipValue: relationshipValue,
    stringValue: 'stringValue',
  },
  isExternalId: false,
  isFinal: false,
  isImported: false,
  isInherited: false,
  isRequiredInEntity: false,
  isStoredExternally: false,
  isTimeSeries: false,
};

Properties

NameTypeDescription
configuration?IResolvable | { [string]: string }The configuration.
dataType?IResolvable | DataTypePropertyThe data type.
defaultValue?IResolvable | DataValuePropertyThe default value.
isExternalId?boolean | IResolvableDisplays if the entity has a external Id.
isFinal?boolean | IResolvableDisplays if the entity is final.
isImported?boolean | IResolvableDisplays if the entity is imported.
isInherited?boolean | IResolvableDisplays if the entity is inherited.
isRequiredInEntity?boolean | IResolvableDisplays if the entity is a required entity.
isStoredExternally?boolean | IResolvableDisplays if the entity is tored externally.
isTimeSeries?boolean | IResolvableDisplays if the entity.

configuration?

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

The configuration.


dataType?

Type: IResolvable | DataTypeProperty (optional)

The data type.


defaultValue?

Type: IResolvable | DataValueProperty (optional)

The default value.


isExternalId?

Type: boolean | IResolvable (optional)

Displays if the entity has a external Id.


isFinal?

Type: boolean | IResolvable (optional)

Displays if the entity is final.


isImported?

Type: boolean | IResolvable (optional)

Displays if the entity is imported.


isInherited?

Type: boolean | IResolvable (optional)

Displays if the entity is inherited.


isRequiredInEntity?

Type: boolean | IResolvable (optional)

Displays if the entity is a required entity.


isStoredExternally?

Type: boolean | IResolvable (optional)

Displays if the entity is tored externally.


isTimeSeries?

Type: boolean | IResolvable (optional)

Displays if the entity.