Package software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModel.AssetModelHierarchyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModel.AssetModelHierarchyProperty.Jsii$Proxy

Enclosing class:

CfnAssetModel

@Stability(Stable)
public static interface CfnAssetModel.AssetModelHierarchyProperty
extends software.amazon.jsii.JsiiSerializable

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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 AssetModelHierarchyProperty assetModelHierarchyProperty = AssetModelHierarchyProperty.builder()
         .childAssetModelId("childAssetModelId")
         .name("name")
         // the properties below are optional
         .externalId("externalId")
         .id("id")
         .logicalId("logicalId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-assetmodel-assetmodelhierarchy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssetModel.AssetModelHierarchyProperty.Builder	A builder for CfnAssetModel.AssetModelHierarchyProperty
static final class	CfnAssetModel.AssetModelHierarchyProperty.Jsii$Proxy	An implementation for CfnAssetModel.AssetModelHierarchyProperty

Method Summary

Modifier and Type	Method	Description
static CfnAssetModel.AssetModelHierarchyProperty.Builder	builder()
String	getChildAssetModelId()	The ID of the asset model, in UUID format.
default String	getExternalId()	The external ID (if any) provided in the CreateAssetModel or UpdateAssetModel operation.
default String	getId()	The ID of the asset model hierarchy.
default String	getLogicalId()	The LogicalID of the asset model hierarchy.
String	getName()	The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChildAssetModelId

@Stability(Stable)
@NotNull
String getChildAssetModelId()

The ID of the asset model, in UUID format.

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 Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

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

See Also:

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

getExternalId

@Stability(Stable)
@Nullable
default String getExternalId()

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 .

One of ExternalId or LogicalId must be specified.

See Also:

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

getId

@Stability(Stable)
@Nullable
default String getId()

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

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

• If you are callling UpdateAssetModel to create a new hierarchy: You can specify its ID here, if desired. AWS IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
• If you are calling UpdateAssetModel to modify an existing hierarchy: This can be either the actual ID in UUID format, or else externalId: followed by the external ID, if it has one. For more information, see Referencing objects with external IDs in the AWS IoT SiteWise User Guide .

See Also:

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

getLogicalId

@Stability(Stable)
@Nullable
default String getLogicalId()

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

One of ExternalId or LogicalId must be specified.

See Also:

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

builder

@Stability(Stable)
static CfnAssetModel.AssetModelHierarchyProperty.Builder builder()

Returns:

a CfnAssetModel.AssetModelHierarchyProperty.Builder of CfnAssetModel.AssetModelHierarchyProperty