Interface CfnAssetModel.IAssetModelPropertyProperty

Contains information about an asset model property.

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAssetModel.IAssetModelPropertyProperty

Syntax (vb)

Public Interface CfnAssetModel.IAssetModelPropertyProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.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 assetModelPropertyProperty = 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"
             };

Synopsis

Properties

DataType	The data type of the asset model property.
DataTypeSpec	The data type of the structure for this property.
ExternalId	The external ID of the asset property.
Id	The ID of the property.
LogicalId	The LogicalID of the asset model property.
Name	The name of the asset model property.
Type	Contains a property type, which can be one of attribute , measurement , metric , or transform .
Unit	The unit of the asset model property, such as Newtons or RPM .

Properties

DataType

The data type of the asset model property.

string DataType { get; }

Property Value

string

Remarks

If you specify STRUCT , you must also specify dataTypeSpec to identify the type of the structure for this property.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatype

DataTypeSpec

The data type of the structure for this property.

string? DataTypeSpec { get; }

Property Value

string

Remarks

This parameter exists on properties that have the STRUCT data type.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-datatypespec

ExternalId

The external ID of the asset property.

string? ExternalId { get; }

Property Value

string

Remarks

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

One of <code>ExternalId</code> or <code>LogicalId</code> must be specified.

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

Id

The ID of the property.

string? Id { get; }

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-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-id

LogicalId

The LogicalID of the asset model property.

string? LogicalId { get; }

Property Value

string

Remarks

One of <code>ExternalId</code> or <code>LogicalId</code> must be specified.

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

Name

The name of the asset model property.

string Name { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-name

Type

Contains a property type, which can be one of attribute , measurement , metric , or transform .

object Type { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-type

Type union: either IResolvable or CfnAssetModel.IPropertyTypeProperty

Unit

The unit of the asset model property, such as Newtons or RPM .

string? Unit { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelproperty.html#cfn-iotsitewise-assetmodel-assetmodelproperty-unit