Interface CfnAssetModel.IVariableValueProperty

Identifies a property value used in an expression.

Namespace: Amazon.CDK.AWS.IoTSiteWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnAssetModel.IVariableValueProperty

Syntax (vb)

Public Interface CfnAssetModel.IVariableValueProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-variablevalue.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 variableValueProperty = new VariableValueProperty {
                 HierarchyExternalId = "hierarchyExternalId",
                 HierarchyId = "hierarchyId",
                 HierarchyLogicalId = "hierarchyLogicalId",
                 PropertyExternalId = "propertyExternalId",
                 PropertyId = "propertyId",
                 PropertyLogicalId = "propertyLogicalId",
                 PropertyPath = new [] { new PropertyPathDefinitionProperty {
                     Name = "name"
                 } }
             };

Synopsis

Properties

HierarchyExternalId	The external ID of the hierarchy being referenced.
HierarchyId	The ID of the hierarchy to query for the property ID.
HierarchyLogicalId	The LogicalID of the hierarchy to query for the PropertyLogicalID .
PropertyExternalId	The external ID of the property being referenced.
PropertyId	The ID of the property to use as the variable.
PropertyLogicalId	The LogicalID of the property that is being referenced.
PropertyPath	The path of the property.

Properties

HierarchyExternalId

The external ID of the hierarchy being referenced.

string? HierarchyExternalId { 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-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-hierarchyexternalid

HierarchyId

The ID of the hierarchy to query for the property ID.

string? HierarchyId { get; }

Property Value

string

Remarks

You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

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

HierarchyLogicalId

The LogicalID of the hierarchy to query for the PropertyLogicalID .

string? HierarchyLogicalId { get; }

Property Value

string

Remarks

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

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

PropertyExternalId

The external ID of the property being referenced.

string? PropertyExternalId { 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-variablevalue.html#cfn-iotsitewise-assetmodel-variablevalue-propertyexternalid

PropertyId

The ID of the property to use as the variable.

string? PropertyId { get; }

Property Value

string

Remarks

You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

This is a return value and can't be set.

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

PropertyLogicalId

The LogicalID of the property that is being referenced.

string? PropertyLogicalId { get; }

Property Value

string

Remarks

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

PropertyPath

The path of the property.

object? PropertyPath { get; }

Property Value

object

Remarks

Each step of the path is the name of the step. See the following example:

PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite

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

Type union: either IResolvable or (either IResolvable or CfnAssetModel.IPropertyPathDefinitionProperty)[]