PropertyDefinitionProperty Struct
PropertyDefinition is an object that maps strings to the property definitions in the component type.
Example
ts
// 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
configurationsoptionalIResolvable | { [key: string]: string }configurationsoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]configurationsoptionalIResolvableConfigurationsoptionalIResolvableConfigurationsoptionalinterface{}#A mapping that specifies configuration information about the property.
dataTypeoptionalIResolvable | CfnComponentType.DataTypePropertydata_typeoptionaltyping.Union[IResolvable, DataTypeProperty]dataTypeoptionalIResolvableDataTypeoptionalIResolvableDataTypeoptionalinterface{}#An object that specifies the data type of a property.
defaultValueoptionalIResolvable | CfnComponentType.DataValuePropertydefault_valueoptionaltyping.Union[IResolvable, DataValueProperty]defaultValueoptionalIResolvableDefaultValueoptionalIResolvableDefaultValueoptionalinterface{}#A boolean value that specifies whether the property ID comes from an external data store.
isExternalIdoptionalboolean | IResolvableis_external_idoptionaltyping.Union[bool, IResolvable]isExternalIdoptionalBooleanIsExternalIdoptionalboolIsExternalIdoptionalinterface{}#A Boolean value that specifies whether the property ID comes from an external data source.
isRequiredInEntityoptionalboolean | IResolvableis_required_in_entityoptionaltyping.Union[bool, IResolvable]isRequiredInEntityoptionalBooleanIsRequiredInEntityoptionalboolIsRequiredInEntityoptionalinterface{}#A boolean value that specifies whether the property is required in an entity.
isStoredExternallyoptionalboolean | IResolvableis_stored_externallyoptionaltyping.Union[bool, IResolvable]isStoredExternallyoptionalBooleanIsStoredExternallyoptionalboolIsStoredExternallyoptionalinterface{}#A boolean value that specifies whether the property is stored externally.
isTimeSeriesoptionalboolean | IResolvableis_time_seriesoptionaltyping.Union[bool, IResolvable]isTimeSeriesoptionalBooleanIsTimeSeriesoptionalboolIsTimeSeriesoptionalinterface{}#A boolean value that specifies whether the property consists of time series data.