CfnAssetMixinProps
- class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAssetMixinProps(*, asset_description=None, asset_external_id=None, asset_hierarchies=None, asset_model_id=None, asset_name=None, asset_properties=None, tags=None)
Bases:
objectProperties for CfnAssetPropsMixin.
- Parameters:
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 ahierarchyId. A hierarchy specifies allowed parent/child asset relationships.asset_model_id (
Optional[str]) – The ID of the asset model from which to create the asset. This can be either the actual ID in UUID format, or elseexternalId: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 (
Optional[str]) – A friendly name for the asset.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 theassetCompositeModelsobject.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.mixins_preview.aws_iotsitewise import mixins as iotsitewise_mixins cfn_asset_mixin_props = iotsitewise_mixins.CfnAssetMixinProps( asset_description="assetDescription", asset_external_id="assetExternalId", asset_hierarchies=[iotsitewise_mixins.CfnAssetPropsMixin.AssetHierarchyProperty( child_asset_id="childAssetId", external_id="externalId", id="id", logical_id="logicalId" )], asset_model_id="assetModelId", asset_name="assetName", asset_properties=[iotsitewise_mixins.CfnAssetPropsMixin.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.
- 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 .
- asset_hierarchies
A list of asset hierarchies that each contain a
hierarchyId.A hierarchy specifies allowed parent/child asset relationships.
- 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 .
- asset_name
A friendly name for the asset.
- 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
assetCompositeModelsobject.
- 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 .