interface PropertyDefinitionProperty

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

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html

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.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?	{ [string]: string } | IResolvable	A mapping that specifies configuration information about the property.
dataType?	IResolvable | DataTypeProperty	An object that specifies the data type of a property.
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 source.
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: { [string]: string } | IResolvable (optional)

A mapping that specifies configuration information about the property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-configurations

---

dataType?

Type: IResolvable | DataTypeProperty (optional)

An object that specifies the data type of a property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-datatype

---

defaultValue?

Type: IResolvable | DataValueProperty (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-defaultvalue

---

isExternalId?

Type: boolean | IResolvable (optional)

A Boolean value that specifies whether the property ID comes from an external data source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isexternalid

---

isRequiredInEntity?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isrequiredinentity

---

isStoredExternally?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-isstoredexternally

---

isTimeSeries?

Type: boolean | IResolvable (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iottwinmaker-componenttype-propertydefinition.html#cfn-iottwinmaker-componenttype-propertydefinition-istimeseries