interface PropertyDefinitionProperty

Language	Type name
.NET	Amazon.CDK.AWS.IoTTwinMaker.CfnComponentType.PropertyDefinitionProperty
Java	software.amazon.awscdk.services.iottwinmaker.CfnComponentType.PropertyDefinitionProperty
Python	aws_cdk.aws_iottwinmaker.CfnComponentType.PropertyDefinitionProperty
TypeScript	@aws-cdk/aws-iottwinmaker » CfnComponentType » PropertyDefinitionProperty

PropertyDefinition is an object that maps strings to the property definitions in the component type.

Example

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

declare const dataTypeProperty_: iottwinmaker.CfnComponentType.DataTypeProperty;
declare const dataValueProperty_: iottwinmaker.CfnComponentType.DataValueProperty;
declare const relationshipValue: any;
const propertyDefinitionProperty: iottwinmaker.CfnComponentType.PropertyDefinitionProperty = {
  configurations: {
    configurationsKey: 'configurations',
  },
  dataType: {
    type: 'type',

    // the properties below are optional
    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',
    },
    unitOfMeasure: 'unitOfMeasure',
  },
  defaultValue: {
    booleanValue: false,
    doubleValue: 123,
    expression: 'expression',
    integerValue: 123,
    listValue: [dataValueProperty_],
    longValue: 123,
    mapValue: {
      mapValueKey: dataValueProperty_,
    },
    relationshipValue: relationshipValue,
    stringValue: 'stringValue',
  },
  isExternalId: false,
  isRequiredInEntity: false,
  isStoredExternally: false,
  isTimeSeries: false,
};

Properties

Name	Type	Description
configurations?	IResolvable | { [string]: string }	A mapping that specifies configuration information about the property.
dataType?	IResolvable | DataTypeProperty	CfnComponentType.PropertyDefinitionProperty.DataType.
defaultValue?	IResolvable | DataValueProperty	A boolean value that specifies whether the property ID comes from an external data store.
isExternalId?	boolean | IResolvable	A boolean value that specifies whether the property ID comes from an external data store.
isRequiredInEntity?	boolean | IResolvable	A boolean value that specifies whether the property is required in an entity.
isStoredExternally?	boolean | IResolvable	A boolean value that specifies whether the property is stored externally.
isTimeSeries?	boolean | IResolvable	A boolean value that specifies whether the property consists of time series data.

---

configurations?

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

A mapping that specifies configuration information about the property.

---

dataType?

Type: IResolvable | DataTypeProperty (optional)

CfnComponentType.PropertyDefinitionProperty.DataType.

---

defaultValue?

Type: IResolvable | DataValueProperty (optional)

A boolean value that specifies whether the property ID comes from an external data store.

---

isExternalId?

Type: boolean | IResolvable (optional)

A boolean value that specifies whether the property ID comes from an external data store.

---

isRequiredInEntity?

Type: boolean | IResolvable (optional)

A boolean value that specifies whether the property is required in an entity.

---

isStoredExternally?

Type: boolean | IResolvable (optional)

A boolean value that specifies whether the property is stored externally.

---

isTimeSeries?

Type: boolean | IResolvable (optional)

A boolean value that specifies whether the property consists of time series data.