interface AssetPropertyProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.IoTSiteWise.CfnAsset.AssetPropertyProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAsset_AssetPropertyProperty |
![]() | software.amazon.awscdk.services.iotsitewise.CfnAsset.AssetPropertyProperty |
![]() | aws_cdk.aws_iotsitewise.CfnAsset.AssetPropertyProperty |
![]() | aws-cdk-lib » aws_iotsitewise » CfnAsset » AssetPropertyProperty |
Contains asset property information.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const assetPropertyProperty: iotsitewise.CfnAsset.AssetPropertyProperty = {
alias: 'alias',
externalId: 'externalId',
id: 'id',
logicalId: 'logicalId',
notificationState: 'notificationState',
unit: 'unit',
};
Properties
Name | Type | Description |
---|---|---|
alias? | string | The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ). |
external | string | The external ID of the property. |
id? | string | The ID of the asset property. |
logical | string | The LogicalID of the asset property. |
notification | string | The MQTT notification state (enabled or disabled) for this asset property. |
unit? | string | The unit (such as Newtons or RPM ) of the asset property. |
alias?
Type:
string
(optional)
The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature
).
For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .
externalId?
Type:
string
(optional)
The external ID of the property.
For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
id?
Type:
string
(optional)
The ID of the asset property.
This is a return value and can't be set.
logicalId?
Type:
string
(optional)
The LogicalID
of the asset property.
notificationState?
Type:
string
(optional)
The MQTT notification state (enabled or disabled) for this asset property.
When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide .
If you omit this parameter, the notification state is set to DISABLED
.
unit?
Type:
string
(optional)
The unit (such as Newtons
or RPM
) of the asset property.