Class CfnAssetModelProps

Properties for defining a CfnAssetModel.

Inheritance

object

CfnAssetModelProps

Implements

ICfnAssetModelProps

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 CfnAssetModelProps : ICfnAssetModelProps

Syntax (vb)

Public Class CfnAssetModelProps Implements ICfnAssetModelProps

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.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 cfnAssetModelProps = new CfnAssetModelProps {
                 AssetModelName = "assetModelName",

                 // the properties below are optional
                 AssetModelCompositeModels = new [] { new AssetModelCompositeModelProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     ComposedAssetModelId = "composedAssetModelId",
                     CompositeModelProperties = new [] { new AssetModelPropertyProperty {
                         DataType = "dataType",
                         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 {
                                         HierarchyExternalId = "hierarchyExternalId",
                                         HierarchyId = "hierarchyId",
                                         HierarchyLogicalId = "hierarchyLogicalId",
                                         PropertyExternalId = "propertyExternalId",
                                         PropertyId = "propertyId",
                                         PropertyLogicalId = "propertyLogicalId",
                                         PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                             Name = "name"
                                         } }
                                     }
                                 } },
                                 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 {
                                         HierarchyExternalId = "hierarchyExternalId",
                                         HierarchyId = "hierarchyId",
                                         HierarchyLogicalId = "hierarchyLogicalId",
                                         PropertyExternalId = "propertyExternalId",
                                         PropertyId = "propertyId",
                                         PropertyLogicalId = "propertyLogicalId",
                                         PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                             Name = "name"
                                         } }
                                     }
                                 } }
                             }
                         },

                         // the properties below are optional
                         DataTypeSpec = "dataTypeSpec",
                         ExternalId = "externalId",
                         Id = "id",
                         LogicalId = "logicalId",
                         Unit = "unit"
                     } },
                     Description = "description",
                     ExternalId = "externalId",
                     Id = "id",
                     ParentAssetModelCompositeModelExternalId = "parentAssetModelCompositeModelExternalId",
                     Path = new [] { "path" }
                 } },
                 AssetModelDescription = "assetModelDescription",
                 AssetModelExternalId = "assetModelExternalId",
                 AssetModelHierarchies = new [] { new AssetModelHierarchyProperty {
                     ChildAssetModelId = "childAssetModelId",
                     Name = "name",

                     // the properties below are optional
                     ExternalId = "externalId",
                     Id = "id",
                     LogicalId = "logicalId"
                 } },
                 AssetModelProperties = new [] { new AssetModelPropertyProperty {
                     DataType = "dataType",
                     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 {
                                     HierarchyExternalId = "hierarchyExternalId",
                                     HierarchyId = "hierarchyId",
                                     HierarchyLogicalId = "hierarchyLogicalId",
                                     PropertyExternalId = "propertyExternalId",
                                     PropertyId = "propertyId",
                                     PropertyLogicalId = "propertyLogicalId",
                                     PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                         Name = "name"
                                     } }
                                 }
                             } },
                             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 {
                                     HierarchyExternalId = "hierarchyExternalId",
                                     HierarchyId = "hierarchyId",
                                     HierarchyLogicalId = "hierarchyLogicalId",
                                     PropertyExternalId = "propertyExternalId",
                                     PropertyId = "propertyId",
                                     PropertyLogicalId = "propertyLogicalId",
                                     PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                         Name = "name"
                                     } }
                                 }
                             } }
                         }
                     },

                     // the properties below are optional
                     DataTypeSpec = "dataTypeSpec",
                     ExternalId = "externalId",
                     Id = "id",
                     LogicalId = "logicalId",
                     Unit = "unit"
                 } },
                 AssetModelType = "assetModelType",
                 EnforcedAssetModelInterfaceRelationships = new [] { new EnforcedAssetModelInterfaceRelationshipProperty {
                     InterfaceAssetModelId = "interfaceAssetModelId",
                     PropertyMappings = new [] { new EnforcedAssetModelInterfacePropertyMappingProperty {
                         InterfaceAssetModelPropertyExternalId = "interfaceAssetModelPropertyExternalId",

                         // the properties below are optional
                         AssetModelPropertyExternalId = "assetModelPropertyExternalId",
                         AssetModelPropertyLogicalId = "assetModelPropertyLogicalId"
                     } }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnAssetModelProps()

Properties for defining a CfnAssetModel.

Properties

AssetModelCompositeModels	The composite models that are part of this asset model.
AssetModelDescription	A description for the asset model.
AssetModelExternalId	The external ID of the asset model.
AssetModelHierarchies	The hierarchy definitions of the asset model.
AssetModelName	A unique name for the asset model.
AssetModelProperties	The property definitions of the asset model.
AssetModelType	The type of asset model.
EnforcedAssetModelInterfaceRelationships	a list of asset model and interface relationships.
Tags	A list of key-value pairs that contain metadata for the asset.

Constructors

CfnAssetModelProps()

Properties for defining a CfnAssetModel.

public CfnAssetModelProps()

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.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 cfnAssetModelProps = new CfnAssetModelProps {
                 AssetModelName = "assetModelName",

                 // the properties below are optional
                 AssetModelCompositeModels = new [] { new AssetModelCompositeModelProperty {
                     Name = "name",
                     Type = "type",

                     // the properties below are optional
                     ComposedAssetModelId = "composedAssetModelId",
                     CompositeModelProperties = new [] { new AssetModelPropertyProperty {
                         DataType = "dataType",
                         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 {
                                         HierarchyExternalId = "hierarchyExternalId",
                                         HierarchyId = "hierarchyId",
                                         HierarchyLogicalId = "hierarchyLogicalId",
                                         PropertyExternalId = "propertyExternalId",
                                         PropertyId = "propertyId",
                                         PropertyLogicalId = "propertyLogicalId",
                                         PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                             Name = "name"
                                         } }
                                     }
                                 } },
                                 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 {
                                         HierarchyExternalId = "hierarchyExternalId",
                                         HierarchyId = "hierarchyId",
                                         HierarchyLogicalId = "hierarchyLogicalId",
                                         PropertyExternalId = "propertyExternalId",
                                         PropertyId = "propertyId",
                                         PropertyLogicalId = "propertyLogicalId",
                                         PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                             Name = "name"
                                         } }
                                     }
                                 } }
                             }
                         },

                         // the properties below are optional
                         DataTypeSpec = "dataTypeSpec",
                         ExternalId = "externalId",
                         Id = "id",
                         LogicalId = "logicalId",
                         Unit = "unit"
                     } },
                     Description = "description",
                     ExternalId = "externalId",
                     Id = "id",
                     ParentAssetModelCompositeModelExternalId = "parentAssetModelCompositeModelExternalId",
                     Path = new [] { "path" }
                 } },
                 AssetModelDescription = "assetModelDescription",
                 AssetModelExternalId = "assetModelExternalId",
                 AssetModelHierarchies = new [] { new AssetModelHierarchyProperty {
                     ChildAssetModelId = "childAssetModelId",
                     Name = "name",

                     // the properties below are optional
                     ExternalId = "externalId",
                     Id = "id",
                     LogicalId = "logicalId"
                 } },
                 AssetModelProperties = new [] { new AssetModelPropertyProperty {
                     DataType = "dataType",
                     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 {
                                     HierarchyExternalId = "hierarchyExternalId",
                                     HierarchyId = "hierarchyId",
                                     HierarchyLogicalId = "hierarchyLogicalId",
                                     PropertyExternalId = "propertyExternalId",
                                     PropertyId = "propertyId",
                                     PropertyLogicalId = "propertyLogicalId",
                                     PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                         Name = "name"
                                     } }
                                 }
                             } },
                             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 {
                                     HierarchyExternalId = "hierarchyExternalId",
                                     HierarchyId = "hierarchyId",
                                     HierarchyLogicalId = "hierarchyLogicalId",
                                     PropertyExternalId = "propertyExternalId",
                                     PropertyId = "propertyId",
                                     PropertyLogicalId = "propertyLogicalId",
                                     PropertyPath = new [] { new PropertyPathDefinitionProperty {
                                         Name = "name"
                                     } }
                                 }
                             } }
                         }
                     },

                     // the properties below are optional
                     DataTypeSpec = "dataTypeSpec",
                     ExternalId = "externalId",
                     Id = "id",
                     LogicalId = "logicalId",
                     Unit = "unit"
                 } },
                 AssetModelType = "assetModelType",
                 EnforcedAssetModelInterfaceRelationships = new [] { new EnforcedAssetModelInterfaceRelationshipProperty {
                     InterfaceAssetModelId = "interfaceAssetModelId",
                     PropertyMappings = new [] { new EnforcedAssetModelInterfacePropertyMappingProperty {
                         InterfaceAssetModelPropertyExternalId = "interfaceAssetModelPropertyExternalId",

                         // the properties below are optional
                         AssetModelPropertyExternalId = "assetModelPropertyExternalId",
                         AssetModelPropertyLogicalId = "assetModelPropertyLogicalId"
                     } }
                 } },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

AssetModelCompositeModels

The composite models that are part of this asset model.

public object? AssetModelCompositeModels { get; set; }

Property Value

object

Remarks

It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model.

When creating custom composite models, you need to use <a href="https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html">CreateAssetModelCompositeModel</a> . For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html">Creating custom composite models (Components)</a> in the <em>AWS IoT SiteWise User Guide</em> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodels

AssetModelDescription

A description for the asset model.

public string? AssetModelDescription { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeldescription

AssetModelExternalId

The external ID of the asset model.

public string? AssetModelExternalId { 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-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelexternalid

AssetModelHierarchies

The hierarchy definitions of the asset model.

public object? AssetModelHierarchies { get; set; }

Property Value

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 Asset hierarchies 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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelhierarchies

AssetModelName

A unique name for the asset model.

public string AssetModelName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelname

AssetModelProperties

The property definitions of the asset model.

public object? AssetModelProperties { get; set; }

Property Value

object

Remarks

For more information, see Asset 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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodelproperties

AssetModelType

The type of asset model.

public string? AssetModelType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-assetmodel.html#cfn-iotsitewise-assetmodel-assetmodeltype

EnforcedAssetModelInterfaceRelationships

a list of asset model and interface relationships.

public object? EnforcedAssetModelInterfaceRelationships { get; set; }