CfnAssetModelProps

class aws_cdk.aws_iotsitewise.CfnAssetModelProps(*, asset_model_name, asset_model_composite_models=None, asset_model_description=None, asset_model_hierarchies=None, asset_model_properties=None, tags=None)

Bases: object

Properties for defining a CfnAssetModel.

Parameters
  • asset_model_name (str) – A unique, friendly name for the asset model. The maximum length is 256 characters with the pattern [^\ u0000-\ u001F\ u007F]+ .

  • asset_model_composite_models (Union[IResolvable, Sequence[Union[IResolvable, AssetModelCompositeModelProperty]], None]) – The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. You can use composite asset models to define alarms on this asset model.

  • asset_model_description (Optional[str]) – A description for the asset model.

  • asset_model_hierarchies (Union[IResolvable, Sequence[Union[IResolvable, AssetModelHierarchyProperty]], 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 Defining relationships between assets 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]], None]) –

    The property definitions of the asset model. For more information, see Defining data 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 .

  • 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-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.
import aws_cdk.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
        composite_model_properties=[iotsitewise.CfnAssetModel.AssetModelPropertyProperty(
            data_type="dataType",
            logical_id="logicalId",
            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(
                            property_logical_id="propertyLogicalId",

                            # the properties below are optional
                            hierarchy_logical_id="hierarchyLogicalId"
                        )
                    )],
                    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(
                            property_logical_id="propertyLogicalId",

                            # the properties below are optional
                            hierarchy_logical_id="hierarchyLogicalId"
                        )
                    )]
                )
            ),

            # the properties below are optional
            data_type_spec="dataTypeSpec",
            unit="unit"
        )],
        description="description"
    )],
    asset_model_description="assetModelDescription",
    asset_model_hierarchies=[iotsitewise.CfnAssetModel.AssetModelHierarchyProperty(
        child_asset_model_id="childAssetModelId",
        logical_id="logicalId",
        name="name"
    )],
    asset_model_properties=[iotsitewise.CfnAssetModel.AssetModelPropertyProperty(
        data_type="dataType",
        logical_id="logicalId",
        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(
                        property_logical_id="propertyLogicalId",

                        # the properties below are optional
                        hierarchy_logical_id="hierarchyLogicalId"
                    )
                )],
                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(
                        property_logical_id="propertyLogicalId",

                        # the properties below are optional
                        hierarchy_logical_id="hierarchyLogicalId"
                    )
                )]
            )
        ),

        # the properties below are optional
        data_type_spec="dataTypeSpec",
        unit="unit"
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

asset_model_composite_models

The composite asset models that are part of this asset model.

Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. You can use composite asset models to define alarms on this asset model.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, AssetModelCompositeModelProperty]], None]

asset_model_description

A description for the asset model.

Link

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

Return type

Optional[str]

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 Defining relationships between assets 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 .

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, AssetModelHierarchyProperty]], None]

asset_model_name

A unique, friendly name for the asset model.

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

Link

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

Return type

str

asset_model_properties

The property definitions of the asset model.

For more information, see Defining data 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 .

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, AssetModelPropertyProperty]], 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-assetmodel.html#cfn-iotsitewise-assetmodel-tags

Return type

Optional[List[CfnTag]]