aws-cdk-lib.aws_iotsitewise.CfnAssetProps

interface CfnAssetProps

LanguageType name
.NETAmazon.CDK.AWS.IoTSiteWise.CfnAssetProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsiotsitewise#CfnAssetProps
Javasoftware.amazon.awscdk.services.iotsitewise.CfnAssetProps
Pythonaws_cdk.aws_iotsitewise.CfnAssetProps
TypeScript aws-cdk-lib » aws_iotsitewise » CfnAssetProps

Properties for defining a CfnAsset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotsitewise as iotsitewise } from 'aws-cdk-lib';
const cfnAssetProps: iotsitewise.CfnAssetProps = {
  assetModelId: 'assetModelId',
  assetName: 'assetName',

  // the properties below are optional
  assetDescription: 'assetDescription',
  assetHierarchies: [{
    childAssetId: 'childAssetId',
    logicalId: 'logicalId',
  }],
  assetProperties: [{
    logicalId: 'logicalId',

    // the properties below are optional
    alias: 'alias',
    notificationState: 'notificationState',
    unit: 'unit',
  }],
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

NameTypeDescription
assetModelIdstringThe ID of the asset model from which to create the asset.
assetNamestringA unique, friendly name for the asset.
assetDescription?stringA description for the asset.
assetHierarchies?IResolvable | IResolvable | AssetHierarchyProperty[]A list of asset hierarchies that each contain a hierarchyLogicalId .
assetProperties?IResolvable | IResolvable | AssetPropertyProperty[]The list of asset properties for the asset.
tags?CfnTag[]A list of key-value pairs that contain metadata for the asset.

assetModelId

Type: string

The ID of the asset model from which to create the asset.


assetName

Type: string

A unique, friendly name for the asset.

The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .


assetDescription?

Type: string (optional)

A description for the asset.


assetHierarchies?

Type: IResolvable | IResolvable | AssetHierarchyProperty[] (optional)

A list of asset hierarchies that each contain a hierarchyLogicalId .

A hierarchy specifies allowed parent/child asset relationships.


assetProperties?

Type: IResolvable | IResolvable | AssetPropertyProperty[] (optional)

The list of asset properties for the asset.

This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object.


tags?

Type: CfnTag[] (optional)

A list of key-value pairs that contain metadata for the asset.

For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide .