interface PropertyDefinitionProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTTwinMaker.CfnComponentType.PropertyDefinitionProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiottwinmaker#CfnComponentType_PropertyDefinitionProperty |
![]() | software.amazon.awscdk.services.iottwinmaker.CfnComponentType.PropertyDefinitionProperty |
![]() | aws_cdk.aws_iottwinmaker.CfnComponentType.PropertyDefinitionProperty |
![]() | aws-cdk-lib » 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 { 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. |
data | IResolvable | Data | An object that specifies the data type of a property. |
default | IResolvable | Data | A boolean value that specifies whether the property ID comes from an external data store. |
is | boolean | IResolvable | A Boolean value that specifies whether the property ID comes from an external data source. |
is | boolean | IResolvable | A boolean value that specifies whether the property is required in an entity. |
is | boolean | IResolvable | A boolean value that specifies whether the property is stored externally. |
is | 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.
dataType?
Type:
IResolvable
|
Data
(optional)
An object that specifies the data type of a property.
defaultValue?
Type:
IResolvable
|
Data
(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 source.
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.