CfnAssetModelMixinProps

class aws_cdk.mixins_preview.aws_iotsitewise.mixins.CfnAssetModelMixinProps(*, asset_model_composite_models=None, asset_model_description=None, asset_model_external_id=None, asset_model_hierarchies=None, asset_model_name=None, asset_model_properties=None, asset_model_type=None, enforced_asset_model_interface_relationships=None, tags=None)

Bases: object

Properties for CfnAssetModelPropsMixin.

Parameters:

  • 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_name (Optional[str]) – A unique name for the asset model.

  • 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. - INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

  • enforced_asset_model_interface_relationships (Union[IResolvable, Sequence[Union[IResolvable, EnforcedAssetModelInterfaceRelationshipProperty, Dict[str, Any]]], None]) – a list of asset model and interface relationships.

  • 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-assetmodel.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_model_mixin_props = iotsitewise_mixins.CfnAssetModelMixinProps(
    asset_model_composite_models=[iotsitewise_mixins.CfnAssetModelPropsMixin.AssetModelCompositeModelProperty(
        composed_asset_model_id="composedAssetModelId",
        composite_model_properties=[iotsitewise_mixins.CfnAssetModelPropsMixin.AssetModelPropertyProperty(
            data_type="dataType",
            data_type_spec="dataTypeSpec",
            external_id="externalId",
            id="id",
            logical_id="logicalId",
            name="name",
            type=iotsitewise_mixins.CfnAssetModelPropsMixin.PropertyTypeProperty(
                attribute=iotsitewise_mixins.CfnAssetModelPropsMixin.AttributeProperty(
                    default_value="defaultValue"
                ),
                metric=iotsitewise_mixins.CfnAssetModelPropsMixin.MetricProperty(
                    expression="expression",
                    variables=[iotsitewise_mixins.CfnAssetModelPropsMixin.ExpressionVariableProperty(
                        name="name",
                        value=iotsitewise_mixins.CfnAssetModelPropsMixin.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_mixins.CfnAssetModelPropsMixin.PropertyPathDefinitionProperty(
                                name="name"
                            )]
                        )
                    )],
                    window=iotsitewise_mixins.CfnAssetModelPropsMixin.MetricWindowProperty(
                        tumbling=iotsitewise_mixins.CfnAssetModelPropsMixin.TumblingWindowProperty(
                            interval="interval",
                            offset="offset"
                        )
                    )
                ),
                transform=iotsitewise_mixins.CfnAssetModelPropsMixin.TransformProperty(
                    expression="expression",
                    variables=[iotsitewise_mixins.CfnAssetModelPropsMixin.ExpressionVariableProperty(
                        name="name",
                        value=iotsitewise_mixins.CfnAssetModelPropsMixin.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_mixins.CfnAssetModelPropsMixin.PropertyPathDefinitionProperty(
                                name="name"
                            )]
                        )
                    )]
                ),
                type_name="typeName"
            ),
            unit="unit"
        )],
        description="description",
        external_id="externalId",
        id="id",
        name="name",
        parent_asset_model_composite_model_external_id="parentAssetModelCompositeModelExternalId",
        path=["path"],
        type="type"
    )],
    asset_model_description="assetModelDescription",
    asset_model_external_id="assetModelExternalId",
    asset_model_hierarchies=[iotsitewise_mixins.CfnAssetModelPropsMixin.AssetModelHierarchyProperty(
        child_asset_model_id="childAssetModelId",
        external_id="externalId",
        id="id",
        logical_id="logicalId",
        name="name"
    )],
    asset_model_name="assetModelName",
    asset_model_properties=[iotsitewise_mixins.CfnAssetModelPropsMixin.AssetModelPropertyProperty(
        data_type="dataType",
        data_type_spec="dataTypeSpec",
        external_id="externalId",
        id="id",
        logical_id="logicalId",
        name="name",
        type=iotsitewise_mixins.CfnAssetModelPropsMixin.PropertyTypeProperty(
            attribute=iotsitewise_mixins.CfnAssetModelPropsMixin.AttributeProperty(
                default_value="defaultValue"
            ),
            metric=iotsitewise_mixins.CfnAssetModelPropsMixin.MetricProperty(
                expression="expression",
                variables=[iotsitewise_mixins.CfnAssetModelPropsMixin.ExpressionVariableProperty(
                    name="name",
                    value=iotsitewise_mixins.CfnAssetModelPropsMixin.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_mixins.CfnAssetModelPropsMixin.PropertyPathDefinitionProperty(
                            name="name"
                        )]
                    )
                )],
                window=iotsitewise_mixins.CfnAssetModelPropsMixin.MetricWindowProperty(
                    tumbling=iotsitewise_mixins.CfnAssetModelPropsMixin.TumblingWindowProperty(
                        interval="interval",
                        offset="offset"
                    )
                )
            ),
            transform=iotsitewise_mixins.CfnAssetModelPropsMixin.TransformProperty(
                expression="expression",
                variables=[iotsitewise_mixins.CfnAssetModelPropsMixin.ExpressionVariableProperty(
                    name="name",
                    value=iotsitewise_mixins.CfnAssetModelPropsMixin.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_mixins.CfnAssetModelPropsMixin.PropertyPathDefinitionProperty(
                            name="name"
                        )]
                    )
                )]
            ),
            type_name="typeName"
        ),
        unit="unit"
    )],
    asset_model_type="assetModelType",
    enforced_asset_model_interface_relationships=[iotsitewise_mixins.CfnAssetModelPropsMixin.EnforcedAssetModelInterfaceRelationshipProperty(
        interface_asset_model_id="interfaceAssetModelId",
        property_mappings=[iotsitewise_mixins.CfnAssetModelPropsMixin.EnforcedAssetModelInterfacePropertyMappingProperty(
            asset_model_property_external_id="assetModelPropertyExternalId",
            asset_model_property_logical_id="assetModelPropertyLogicalId",
            interface_asset_model_property_external_id="interfaceAssetModelPropertyExternalId"
        )]
    )],
    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* .
See:

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

asset_model_description

A description for the asset model.

See:

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

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 .

See:

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

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 .

See:

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

asset_model_name

A unique name for the asset model.

See:

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

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 .

See:

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

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.

  • INTERFACE – An interface is a type of model that defines a standard structure that can be applied to different asset models.

See:

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

enforced_asset_model_interface_relationships

a list of asset model and interface relationships.

See:

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

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-assetmodel.html#cfn-iotsitewise-assetmodel-tags