Package software.amazon.awscdk.services.iotsitewise

Interface CfnAsset.AssetHierarchyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAsset.AssetHierarchyProperty.Jsii$Proxy

Enclosing class:

CfnAsset

@Stability(Stable)
public static interface CfnAsset.AssetHierarchyProperty
extends software.amazon.jsii.JsiiSerializable

Describes an asset hierarchy that contains a hierarchy's name and ID.

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.*;
 AssetHierarchyProperty assetHierarchyProperty = AssetHierarchyProperty.builder()
         .childAssetId("childAssetId")
         // 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-asset-assethierarchy.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnAsset.AssetHierarchyProperty.Builder	builder()
String	getChildAssetId()	The Id of the child asset.
default String	getExternalId()	The external ID of the hierarchy, if it has one.
default String	getId()	The ID of the hierarchy.
default String	getLogicalId()	The ID of the hierarchy.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getChildAssetId

@Stability(Stable)
@NotNull
String getChildAssetId()

The Id of the child asset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-childassetid

getExternalId

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

The external ID of the hierarchy, if it has one.

When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. 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-asset-assethierarchy.html#cfn-iotsitewise-asset-assethierarchy-externalid

getId

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

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

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

See Also:

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

getLogicalId

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

The ID of the hierarchy.

This ID is a hierarchyId .

See Also:

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

builder

@Stability(Stable)
static CfnAsset.AssetHierarchyProperty.Builder builder()

Returns:

a CfnAsset.AssetHierarchyProperty.Builder of CfnAsset.AssetHierarchyProperty