Interface CfnAssetModel.IAssetModelCompositeModelProperty

Contains information about a composite model in an asset model.

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAssetModel.IAssetModelCompositeModelProperty

Syntax (vb)

Public Interface CfnAssetModel.IAssetModelCompositeModelProperty

Remarks

This object contains the asset property definitions that you define in the composite model.

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

Synopsis

Properties

ComposedAssetModelId	The ID of a component model which is reused to create this composite model.
CompositeModelProperties	The asset property definitions for this composite model.
Description	The description of the composite model.
ExternalId	The external ID of a composite model on this asset model.
Id	The ID of the asset model composite model.
Name	The name of the composite model.
ParentAssetModelCompositeModelExternalId	The external ID of the parent composite model.
Path	The structured path to the property from the root of the asset using property names.
Type	The type of the composite model.

Properties

ComposedAssetModelId

The ID of a component model which is reused to create this composite model.

string? ComposedAssetModelId { get; }

Property Value

string

Remarks

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

CompositeModelProperties

The asset property definitions for this composite model.

object? CompositeModelProperties { get; }

Property Value

object

Remarks

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

Description

The description of the composite model.

string? Description { get; }

Property Value

string

Remarks

If the composite model is a <code>component-model-based</code> composite model, the description is inherited from the <code>COMPONENT_MODEL</code> asset model and cannot be changed.

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

ExternalId

The external ID of a composite model on this asset model.

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>Path</code> must be specified.

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

Id

The ID of the asset model composite model.

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

Name

The name of the composite model.

string Name { get; }

Property Value

string

Remarks

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

ParentAssetModelCompositeModelExternalId

The external ID of the parent composite model.

string? ParentAssetModelCompositeModelExternalId { get; }

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-properties-iotsitewise-assetmodel-assetmodelcompositemodel.html#cfn-iotsitewise-assetmodel-assetmodelcompositemodel-parentassetmodelcompositemodelexternalid

Path

The structured path to the property from the root of the asset using property names.

string[]? Path { get; }

Property Value

string[]

Remarks

Path is used as the ID if the asset model is a derived composite model.

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

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

Type

The type of the composite model.

string Type { get; }

Property Value

string

Remarks

For alarm composite models, this type is AWS/ALARM .

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