Interface ICfnAssetModelProps
Properties for defining a CfnAssetModel
.
Namespace: Amazon.CDK.AWS.IoTSiteWise
Assembly: Amazon.CDK.AWS.IoTSiteWise.dll
Syntax (csharp)
public interface ICfnAssetModelProps
Syntax (vb)
Public Interface ICfnAssetModelProps
Remarks
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 cfnAssetModelProps = new CfnAssetModelProps {
AssetModelName = "assetModelName",
// the properties below are optional
AssetModelCompositeModels = new [] { new AssetModelCompositeModelProperty {
Name = "name",
Type = "type",
// the properties below are optional
CompositeModelProperties = new [] { new AssetModelPropertyProperty {
DataType = "dataType",
LogicalId = "logicalId",
Name = "name",
Type = new PropertyTypeProperty {
TypeName = "typeName",
// the properties below are optional
Attribute = new AttributeProperty {
DefaultValue = "defaultValue"
},
Metric = new MetricProperty {
Expression = "expression",
Variables = new [] { new ExpressionVariableProperty {
Name = "name",
Value = new VariableValueProperty {
PropertyLogicalId = "propertyLogicalId",
// the properties below are optional
HierarchyLogicalId = "hierarchyLogicalId"
}
} },
Window = new MetricWindowProperty {
Tumbling = new TumblingWindowProperty {
Interval = "interval",
// the properties below are optional
Offset = "offset"
}
}
},
Transform = new TransformProperty {
Expression = "expression",
Variables = new [] { new ExpressionVariableProperty {
Name = "name",
Value = new VariableValueProperty {
PropertyLogicalId = "propertyLogicalId",
// the properties below are optional
HierarchyLogicalId = "hierarchyLogicalId"
}
} }
}
},
// the properties below are optional
DataTypeSpec = "dataTypeSpec",
Unit = "unit"
} },
Description = "description"
} },
AssetModelDescription = "assetModelDescription",
AssetModelHierarchies = new [] { new AssetModelHierarchyProperty {
ChildAssetModelId = "childAssetModelId",
LogicalId = "logicalId",
Name = "name"
} },
AssetModelProperties = new [] { new AssetModelPropertyProperty {
DataType = "dataType",
LogicalId = "logicalId",
Name = "name",
Type = new PropertyTypeProperty {
TypeName = "typeName",
// the properties below are optional
Attribute = new AttributeProperty {
DefaultValue = "defaultValue"
},
Metric = new MetricProperty {
Expression = "expression",
Variables = new [] { new ExpressionVariableProperty {
Name = "name",
Value = new VariableValueProperty {
PropertyLogicalId = "propertyLogicalId",
// the properties below are optional
HierarchyLogicalId = "hierarchyLogicalId"
}
} },
Window = new MetricWindowProperty {
Tumbling = new TumblingWindowProperty {
Interval = "interval",
// the properties below are optional
Offset = "offset"
}
}
},
Transform = new TransformProperty {
Expression = "expression",
Variables = new [] { new ExpressionVariableProperty {
Name = "name",
Value = new VariableValueProperty {
PropertyLogicalId = "propertyLogicalId",
// the properties below are optional
HierarchyLogicalId = "hierarchyLogicalId"
}
} }
}
},
// the properties below are optional
DataTypeSpec = "dataTypeSpec",
Unit = "unit"
} },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
AssetModelCompositeModels | The composite asset models that are part of this asset model. |
AssetModelDescription | A description for the asset model. |
AssetModelHierarchies | The hierarchy definitions of the asset model. |
AssetModelName | A unique, friendly name for the asset model. |
AssetModelProperties | The property definitions of the asset model. |
Tags | A list of key-value pairs that contain metadata for the asset. |
Properties
AssetModelCompositeModels
The composite asset models that are part of this asset model.
virtual object AssetModelCompositeModels { get; }
Property Value
System.Object
Remarks
Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. You can use composite asset models to define alarms on this asset model.
AssetModelDescription
A description for the asset model.
virtual string AssetModelDescription { get; }
Property Value
System.String
Remarks
AssetModelHierarchies
The hierarchy definitions of the asset model.
virtual object AssetModelHierarchies { get; }
Property Value
System.Object
Remarks
Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Defining relationships between assets in the AWS IoT SiteWise User Guide .
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
AssetModelName
A unique, friendly name for the asset model.
string AssetModelName { get; }
Property Value
System.String
Remarks
The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+
.
AssetModelProperties
The property definitions of the asset model.
virtual object AssetModelProperties { get; }
Property Value
System.Object
Remarks
For more information, see Defining data properties in the AWS IoT SiteWise User Guide .
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
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 .