Interface CfnAssetModel.IPropertyTypeProperty

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

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IPropertyTypeProperty

Syntax (vb)

Public Interface IPropertyTypeProperty

Remarks

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

Synopsis

Properties

Attribute	Specifies an asset attribute property.
Metric	Specifies an asset metric property.
Transform	Specifies an asset transform property.
TypeName	The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .

Properties

Attribute

Specifies an asset attribute property.

virtual object Attribute { get; }

Property Value

System.Object

Remarks

An attribute generally contains static information, such as the serial number of an IIoT wind turbine.

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

Metric

Specifies an asset metric property.

virtual object Metric { get; }

Property Value

System.Object

Remarks

A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.

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

Transform

Specifies an asset transform property.

virtual object Transform { get; }

Property Value

System.Object

Remarks

A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

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

TypeName

The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .

string TypeName { get; }

Property Value

System.String

Remarks

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