Class CfnAsset.AssetPropertyProperty

Contains asset property information.

Inheritance

object

CfnAsset.AssetPropertyProperty

Implements

CfnAsset.IAssetPropertyProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAsset.AssetPropertyProperty : CfnAsset.IAssetPropertyProperty

Syntax (vb)

Public Class CfnAsset.AssetPropertyProperty Implements CfnAsset.IAssetPropertyProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var assetPropertyProperty = new AssetPropertyProperty {
                 Alias = "alias",
                 ExternalId = "externalId",
                 Id = "id",
                 LogicalId = "logicalId",
                 NotificationState = "notificationState",
                 Unit = "unit"
             };

Synopsis

Constructors

AssetPropertyProperty()

Contains asset property information.

Properties

Alias	The alias that identifies the property, such as an OPC-UA server data stream path (for example, `/company/windfarm/3/turbine/7/temperature` ).
ExternalId	The external ID of the property.
Id	The ID of the asset property.
LogicalId	The `LogicalID` of the asset property.
NotificationState	The MQTT notification state (enabled or disabled) for this asset property.
Unit	The unit (such as `Newtons` or `RPM` ) of the asset property.

Constructors

AssetPropertyProperty()

Contains asset property information.

public AssetPropertyProperty()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTSiteWise;

             var assetPropertyProperty = new AssetPropertyProperty {
                 Alias = "alias",
                 ExternalId = "externalId",
                 Id = "id",
                 LogicalId = "logicalId",
                 NotificationState = "notificationState",
                 Unit = "unit"
             };

Properties

Alias

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ).

public string? Alias { get; set; }

Property Value

string

Remarks

For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

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

ExternalId

The external ID of the property.

public string? ExternalId { get; set; }

Property Value

string

Remarks

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

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

Id

The ID of the asset property.

public string? Id { get; set; }

Property Value

string

Remarks

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

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

LogicalId

The LogicalID of the asset property.

public string? LogicalId { get; set; }

Property Value

string

Remarks

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

NotificationState

The MQTT notification state (enabled or disabled) for this asset property.

public string? NotificationState { get; set; }

Property Value

string

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assetproperty.html#cfn-iotsitewise-asset-assetproperty-notificationstate

Unit

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

public string? Unit { get; set; }