CfnAssetProps¶

class aws_cdk.aws_iotsitewise.CfnAssetProps(*, asset_model_id, asset_name, asset_description=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.
asset_name (str) – A unique, friendly name for the asset. The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .
asset_description (Optional[str]) – AWS::IoTSiteWise::Asset.AssetDescription.
asset_hierarchies (Union[IResolvable, Sequence[Union[IResolvable, AssetHierarchyProperty]], None]) – A list of asset hierarchies that each contain a hierarchyLogicalId . A hierarchy specifies allowed parent/child asset relationships.
asset_properties (Union[IResolvable, Sequence[Union[IResolvable, AssetPropertyProperty]], 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[CfnTag]]) – 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 .

Link

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.
import aws_cdk.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_hierarchies=[iotsitewise.CfnAsset.AssetHierarchyProperty(
        child_asset_id="childAssetId",
        logical_id="logicalId"
    )],
    asset_properties=[iotsitewise.CfnAsset.AssetPropertyProperty(
        logical_id="logicalId",

        # the properties below are optional
        alias="alias",
        notification_state="notificationState"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

asset_description¶

AWS::IoTSiteWise::Asset.AssetDescription.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetdescription
Return type: Optional[str]

asset_hierarchies¶

A list of asset hierarchies that each contain a hierarchyLogicalId .

A hierarchy specifies allowed parent/child asset relationships.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assethierarchies
Return type: Union[IResolvable, List[Union[IResolvable, AssetHierarchyProperty]], None]

asset_model_id¶

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

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

asset_name¶

A unique, friendly name for the asset.

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

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

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-assetproperties
Return type: Union[IResolvable, List[Union[IResolvable, AssetPropertyProperty]], None]

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotsitewise-asset.html#cfn-iotsitewise-asset-tags
Return type: Optional[List[CfnTag]]