2.233.0

interface AssetPropertyProperty

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.IoTSiteWise.Mixins.CfnAssetPropsMixin.AssetPropertyProperty
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiotsitewise/mixins#CfnAssetPropsMixin_AssetPropertyProperty
Javasoftware.amazon.awscdk.mixins.preview.services.iotsitewise.mixins.CfnAssetPropsMixin.AssetPropertyProperty
Pythonaws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAssetPropsMixin.AssetPropertyProperty
TypeScript @aws-cdk/mixins-preview » aws_iotsitewise » mixins » CfnAssetPropsMixin » AssetPropertyProperty

Contains asset property information.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iotsitewise_mixins } from '@aws-cdk/mixins-preview/aws-iotsitewise';
const assetPropertyProperty: iotsitewise_mixins.CfnAssetPropsMixin.AssetPropertyProperty = {
  alias: 'alias',
  externalId: 'externalId',
  id: 'id',
  logicalId: 'logicalId',
  notificationState: 'notificationState',
  unit: 'unit',
};

Properties

NameTypeDescription
alias?stringThe alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ).
externalId?stringThe external ID of the property.
id?stringThe ID of the asset property.
logicalId?stringThe LogicalID of the asset property.
notificationState?stringThe MQTT notification state (enabled or disabled) for this asset property.
unit?stringThe 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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-alias

externalId?

Type: string (optional)

The external ID of the property.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-externalid

id?

Type: string (optional)

The ID of the asset property.

This is a return value and can't be set.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-id

logicalId?

Type: string (optional)

The LogicalID of the asset property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-logicalid

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 .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate

unit?

Type: string (optional)

The unit (such as Newtons or RPM ) of the asset property.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-unit

← PreviousNext →