CfnAssetModelProps
- class aws_cdk.aws_iotsitewise.CfnAssetModelProps(*, asset_model_name, asset_model_composite_models=None, asset_model_description=None, asset_model_external_id=None, asset_model_hierarchies=None, asset_model_properties=None, asset_model_type=None, tags=None)
Bases:
object
Properties for defining a
CfnAssetModel
.- Parameters:
asset_model_name (
str
) – A unique name for the asset model.asset_model_composite_models (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AssetModelCompositeModelProperty
,Dict
[str
,Any
]]],None
]) – The composite models that are part of this asset model. It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. .. epigraph:: When creating custom composite models, you need to use CreateAssetModelCompositeModel . For more information, see Creating custom composite models (Components) in the AWS IoT SiteWise User Guide .asset_model_description (
Optional
[str
]) – A description for the asset model.asset_model_external_id (
Optional
[str
]) – The external ID of the asset model. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .asset_model_hierarchies (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AssetModelHierarchyProperty
,Dict
[str
,Any
]]],None
]) – The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide . You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .asset_model_properties (
Union
[IResolvable
,Sequence
[Union
[IResolvable
,AssetModelPropertyProperty
,Dict
[str
,Any
]]],None
]) –The property definitions of the asset model. For more information, see Asset properties in the AWS IoT SiteWise User Guide . You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
asset_model_type (
Optional
[str
]) – The type of asset model. - ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model. - COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.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:
- 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_model_props = iotsitewise.CfnAssetModelProps( asset_model_name="assetModelName", # the properties below are optional asset_model_composite_models=[iotsitewise.CfnAssetModel.AssetModelCompositeModelProperty( name="name", type="type", # the properties below are optional composed_asset_model_id="composedAssetModelId", composite_model_properties=[iotsitewise.CfnAssetModel.AssetModelPropertyProperty( data_type="dataType", name="name", type=iotsitewise.CfnAssetModel.PropertyTypeProperty( type_name="typeName", # the properties below are optional attribute=iotsitewise.CfnAssetModel.AttributeProperty( default_value="defaultValue" ), metric=iotsitewise.CfnAssetModel.MetricProperty( expression="expression", variables=[iotsitewise.CfnAssetModel.ExpressionVariableProperty( name="name", value=iotsitewise.CfnAssetModel.VariableValueProperty( hierarchy_external_id="hierarchyExternalId", hierarchy_id="hierarchyId", hierarchy_logical_id="hierarchyLogicalId", property_external_id="propertyExternalId", property_id="propertyId", property_logical_id="propertyLogicalId", property_path=[iotsitewise.CfnAssetModel.PropertyPathDefinitionProperty( name="name" )] ) )], window=iotsitewise.CfnAssetModel.MetricWindowProperty( tumbling=iotsitewise.CfnAssetModel.TumblingWindowProperty( interval="interval", # the properties below are optional offset="offset" ) ) ), transform=iotsitewise.CfnAssetModel.TransformProperty( expression="expression", variables=[iotsitewise.CfnAssetModel.ExpressionVariableProperty( name="name", value=iotsitewise.CfnAssetModel.VariableValueProperty( hierarchy_external_id="hierarchyExternalId", hierarchy_id="hierarchyId", hierarchy_logical_id="hierarchyLogicalId", property_external_id="propertyExternalId", property_id="propertyId", property_logical_id="propertyLogicalId", property_path=[iotsitewise.CfnAssetModel.PropertyPathDefinitionProperty( name="name" )] ) )] ) ), # the properties below are optional data_type_spec="dataTypeSpec", external_id="externalId", id="id", logical_id="logicalId", unit="unit" )], description="description", external_id="externalId", id="id", parent_asset_model_composite_model_external_id="parentAssetModelCompositeModelExternalId", path=["path"] )], asset_model_description="assetModelDescription", asset_model_external_id="assetModelExternalId", asset_model_hierarchies=[iotsitewise.CfnAssetModel.AssetModelHierarchyProperty( child_asset_model_id="childAssetModelId", name="name", # the properties below are optional external_id="externalId", id="id", logical_id="logicalId" )], asset_model_properties=[iotsitewise.CfnAssetModel.AssetModelPropertyProperty( data_type="dataType", name="name", type=iotsitewise.CfnAssetModel.PropertyTypeProperty( type_name="typeName", # the properties below are optional attribute=iotsitewise.CfnAssetModel.AttributeProperty( default_value="defaultValue" ), metric=iotsitewise.CfnAssetModel.MetricProperty( expression="expression", variables=[iotsitewise.CfnAssetModel.ExpressionVariableProperty( name="name", value=iotsitewise.CfnAssetModel.VariableValueProperty( hierarchy_external_id="hierarchyExternalId", hierarchy_id="hierarchyId", hierarchy_logical_id="hierarchyLogicalId", property_external_id="propertyExternalId", property_id="propertyId", property_logical_id="propertyLogicalId", property_path=[iotsitewise.CfnAssetModel.PropertyPathDefinitionProperty( name="name" )] ) )], window=iotsitewise.CfnAssetModel.MetricWindowProperty( tumbling=iotsitewise.CfnAssetModel.TumblingWindowProperty( interval="interval", # the properties below are optional offset="offset" ) ) ), transform=iotsitewise.CfnAssetModel.TransformProperty( expression="expression", variables=[iotsitewise.CfnAssetModel.ExpressionVariableProperty( name="name", value=iotsitewise.CfnAssetModel.VariableValueProperty( hierarchy_external_id="hierarchyExternalId", hierarchy_id="hierarchyId", hierarchy_logical_id="hierarchyLogicalId", property_external_id="propertyExternalId", property_id="propertyId", property_logical_id="propertyLogicalId", property_path=[iotsitewise.CfnAssetModel.PropertyPathDefinitionProperty( name="name" )] ) )] ) ), # the properties below are optional data_type_spec="dataTypeSpec", external_id="externalId", id="id", logical_id="logicalId", unit="unit" )], asset_model_type="assetModelType", tags=[CfnTag( key="key", value="value" )] )
Attributes
- asset_model_composite_models
The composite models that are part of this asset model.
It groups properties (such as attributes, measurements, transforms, and metrics) and child composite models that model parts of your industrial equipment. Each composite model has a type that defines the properties that the composite model supports. Use composite models to define alarms on this asset model. .. epigraph:
When creating custom composite models, you need to use `CreateAssetModelCompositeModel <https://docs.aws.amazon.com/iot-sitewise/latest/APIReference/API_CreateAssetModelCompositeModel.html>`_ . For more information, see `Creating custom composite models (Components) <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-custom-composite-models.html>`_ in the *AWS IoT SiteWise User Guide* .
- asset_model_description
A description for the asset model.
- asset_model_external_id
The external ID of the asset model.
For more information, see Using external IDs in the AWS IoT SiteWise User Guide .
- asset_model_hierarchies
The hierarchy definitions of the asset model.
Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .
You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
- asset_model_name
A unique name for the asset model.
- asset_model_properties
The property definitions of the asset model.
For more information, see Asset properties in the AWS IoT SiteWise User Guide .
You can specify up to 200 properties per asset model. For more information, see Quotas in the AWS IoT SiteWise User Guide .
- asset_model_type
The type of asset model.
ASSET_MODEL – (default) An asset model that you can use to create assets. Can’t be included as a component in another asset model.
COMPONENT_MODEL – A reusable component that you can include in the composite models of other asset models. You can’t create assets directly from this type of asset model.
- 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 .