CfnAssetProps

class aws_cdk.aws_iotsitewise.CfnAssetProps(*, asset_model_id, asset_name, asset_description=None, asset_external_id=None, asset_hierarchies=None, asset_properties=None, tags=None)

Bases: object

Properties for defining a CfnAsset.

Parameters:

  • asset_model_id (str) – The ID of the asset model from which to create the asset. 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 .

  • asset_name (str) – A friendly name for the asset.

  • asset_description (Optional[str]) – The ID of the asset, in UUID format.

  • asset_external_id (Optional[str]) – The external ID of the asset model composite model. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

  • asset_hierarchies (Union[IResolvable, Sequence[Union[IResolvable, AssetHierarchyProperty, Dict[str, Any]]], None]) – A list of asset hierarchies that each contain a hierarchyId . A hierarchy specifies allowed parent/child asset relationships.

  • asset_properties (Union[IResolvable, Sequence[Union[IResolvable, AssetPropertyProperty, Dict[str, Any]]], None]) – 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 (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_iotsitewise as iotsitewise

cfn_asset_props = iotsitewise.CfnAssetProps(
    asset_model_id="assetModelId",
    asset_name="assetName",

    # the properties below are optional
    asset_description="assetDescription",
    asset_external_id="assetExternalId",
    asset_hierarchies=[iotsitewise.CfnAsset.AssetHierarchyProperty(
        child_asset_id="childAssetId",

        # the properties below are optional
        external_id="externalId",
        id="id",
        logical_id="logicalId"
    )],
    asset_properties=[iotsitewise.CfnAsset.AssetPropertyProperty(
        alias="alias",
        external_id="externalId",
        id="id",
        logical_id="logicalId",
        notification_state="notificationState",
        unit="unit"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

asset_description

The ID of the asset, in UUID format.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetdescription

asset_external_id

The external ID of the asset model composite model.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetexternalid

asset_hierarchies

A list of asset hierarchies that each contain a hierarchyId .

A hierarchy specifies allowed parent/child asset relationships.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assethierarchies

asset_model_id

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

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:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetmodelid

asset_name

A friendly name for the asset.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetname

asset_properties

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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetproperties

tags

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 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-tags