Interface CfnAssetModelPropsMixin.IAssetModelHierarchyProperty

Describes an asset hierarchy that contains a hierarchy's name, ID, and child asset model ID that specifies the type of asset that can be in this hierarchy.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.IoTSiteWise

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnAssetModelPropsMixin.IAssetModelHierarchyProperty

Syntax (vb)

Public Interface CfnAssetModelPropsMixin.IAssetModelHierarchyProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.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.CfnPropertyMixins.AWS.IoTSiteWise;

             var assetModelHierarchyProperty = new AssetModelHierarchyProperty {
                 ChildAssetModelId = "childAssetModelId",
                 ExternalId = "externalId",
                 Id = "id",
                 LogicalId = "logicalId",
                 Name = "name"
             };

Synopsis

Properties

ChildAssetModelId	The ID of the asset model, in UUID format.
ExternalId	The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel . However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
Id	The ID of the asset model hierarchy. This ID is a hierarchyId .
LogicalId	The LogicalID of the asset model hierarchy. This ID is a hierarchyLogicalId .
Name	The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

Properties

ChildAssetModelId

The ID of the asset model, in UUID format.

string? ChildAssetModelId { get; }

Property Value

string

Remarks

All assets in this hierarchy must be instances of the childAssetModelId asset model. AWS IoT SiteWise will always return the actual asset model ID for this value. However, when you are specifying this value as part of a call to UpdateAssetModel , you may provide either the asset model ID or else externalId: followed by the asset model's external ID. 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-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-childassetmodelid

ExternalId

The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation. You can assign an external ID by specifying this value as part of a call to UpdateAssetModel . However, you can't change the external ID if one is already assigned. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

string? ExternalId { 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-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-externalid

Id

The ID of the asset model hierarchy. This ID is a hierarchyId .

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

LogicalId

The LogicalID of the asset model hierarchy. This ID is a hierarchyLogicalId .

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-assetmodelhierarchy.html#cfn-iotsitewise-assetmodel-assetmodelhierarchy-logicalid

Name

The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

string? Name { get; }

Property Value

string

Remarks

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