Interface ICfnAssetProps
Properties for defining a CfnAsset
.
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAssetProps
Syntax (vb)
Public Interface ICfnAssetProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.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 cfnAssetProps = new CfnAssetProps {
AssetModelId = "assetModelId",
AssetName = "assetName",
// the properties below are optional
AssetDescription = "assetDescription",
AssetExternalId = "assetExternalId",
AssetHierarchies = new [] { new AssetHierarchyProperty {
ChildAssetId = "childAssetId",
// the properties below are optional
ExternalId = "externalId",
Id = "id",
LogicalId = "logicalId"
} },
AssetProperties = new [] { new AssetPropertyProperty {
Alias = "alias",
ExternalId = "externalId",
Id = "id",
LogicalId = "logicalId",
NotificationState = "notificationState",
Unit = "unit"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
AssetDescription | The ID of the asset, in UUID format. |
AssetExternalId | The external ID of the asset model composite model. |
AssetHierarchies | A list of asset hierarchies that each contain a |
AssetModelId | The ID of the asset model from which to create the asset. |
AssetName | A friendly name for the asset. |
AssetProperties | The list of asset properties for the asset. |
Tags | A list of key-value pairs that contain metadata for the asset. |
Properties
AssetDescription
The ID of the asset, in UUID format.
virtual string AssetDescription { get; }
Property Value
System.String
Remarks
AssetExternalId
The external ID of the asset model composite model.
virtual string AssetExternalId { get; }
Property Value
System.String
Remarks
For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
AssetHierarchies
A list of asset hierarchies that each contain a hierarchyId
.
virtual object AssetHierarchies { get; }
Property Value
System.Object
Remarks
A hierarchy specifies allowed parent/child asset relationships.
AssetModelId
The ID of the asset model from which to create the asset.
string AssetModelId { get; }
Property Value
System.String
Remarks
This can be either the actual ID in UUID format, or else externalId:
followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide .
AssetName
A friendly name for the asset.
string AssetName { get; }
Property Value
System.String
Remarks
AssetProperties
The list of asset properties for the asset.
virtual object AssetProperties { get; }
Property Value
System.Object
Remarks
This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels
object.
Tags
A list of key-value pairs that contain metadata for the asset.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .