Package software.amazon.awscdk.services.iotsitewise

Interface CfnAssetModelProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAssetModelProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:18.271Z")
@Stability(Stable)
public interface CfnAssetModelProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAssetModel.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotsitewise.*;
 CfnAssetModelProps cfnAssetModelProps = CfnAssetModelProps.builder()
         .assetModelName("assetModelName")
         // the properties below are optional
         .assetModelCompositeModels(List.of(AssetModelCompositeModelProperty.builder()
                 .name("name")
                 .type("type")
                 // the properties below are optional
                 .composedAssetModelId("composedAssetModelId")
                 .compositeModelProperties(List.of(AssetModelPropertyProperty.builder()
                         .dataType("dataType")
                         .name("name")
                         .type(PropertyTypeProperty.builder()
                                 .typeName("typeName")
                                 // the properties below are optional
                                 .attribute(AttributeProperty.builder()
                                         .defaultValue("defaultValue")
                                         .build())
                                 .metric(MetricProperty.builder()
                                         .expression("expression")
                                         .variables(List.of(ExpressionVariableProperty.builder()
                                                 .name("name")
                                                 .value(VariableValueProperty.builder()
                                                         .hierarchyExternalId("hierarchyExternalId")
                                                         .hierarchyId("hierarchyId")
                                                         .hierarchyLogicalId("hierarchyLogicalId")
                                                         .propertyExternalId("propertyExternalId")
                                                         .propertyId("propertyId")
                                                         .propertyLogicalId("propertyLogicalId")
                                                         .propertyPath(List.of(PropertyPathDefinitionProperty.builder()
                                                                 .name("name")
                                                                 .build()))
                                                         .build())
                                                 .build()))
                                         .window(MetricWindowProperty.builder()
                                                 .tumbling(TumblingWindowProperty.builder()
                                                         .interval("interval")
                                                         // the properties below are optional
                                                         .offset("offset")
                                                         .build())
                                                 .build())
                                         .build())
                                 .transform(TransformProperty.builder()
                                         .expression("expression")
                                         .variables(List.of(ExpressionVariableProperty.builder()
                                                 .name("name")
                                                 .value(VariableValueProperty.builder()
                                                         .hierarchyExternalId("hierarchyExternalId")
                                                         .hierarchyId("hierarchyId")
                                                         .hierarchyLogicalId("hierarchyLogicalId")
                                                         .propertyExternalId("propertyExternalId")
                                                         .propertyId("propertyId")
                                                         .propertyLogicalId("propertyLogicalId")
                                                         .propertyPath(List.of(PropertyPathDefinitionProperty.builder()
                                                                 .name("name")
                                                                 .build()))
                                                         .build())
                                                 .build()))
                                         .build())
                                 .build())
                         // the properties below are optional
                         .dataTypeSpec("dataTypeSpec")
                         .externalId("externalId")
                         .id("id")
                         .logicalId("logicalId")
                         .unit("unit")
                         .build()))
                 .description("description")
                 .externalId("externalId")
                 .id("id")
                 .parentAssetModelCompositeModelExternalId("parentAssetModelCompositeModelExternalId")
                 .path(List.of("path"))
                 .build()))
         .assetModelDescription("assetModelDescription")
         .assetModelExternalId("assetModelExternalId")
         .assetModelHierarchies(List.of(AssetModelHierarchyProperty.builder()
                 .childAssetModelId("childAssetModelId")
                 .name("name")
                 // the properties below are optional
                 .externalId("externalId")
                 .id("id")
                 .logicalId("logicalId")
                 .build()))
         .assetModelProperties(List.of(AssetModelPropertyProperty.builder()
                 .dataType("dataType")
                 .name("name")
                 .type(PropertyTypeProperty.builder()
                         .typeName("typeName")
                         // the properties below are optional
                         .attribute(AttributeProperty.builder()
                                 .defaultValue("defaultValue")
                                 .build())
                         .metric(MetricProperty.builder()
                                 .expression("expression")
                                 .variables(List.of(ExpressionVariableProperty.builder()
                                         .name("name")
                                         .value(VariableValueProperty.builder()
                                                 .hierarchyExternalId("hierarchyExternalId")
                                                 .hierarchyId("hierarchyId")
                                                 .hierarchyLogicalId("hierarchyLogicalId")
                                                 .propertyExternalId("propertyExternalId")
                                                 .propertyId("propertyId")
                                                 .propertyLogicalId("propertyLogicalId")
                                                 .propertyPath(List.of(PropertyPathDefinitionProperty.builder()
                                                         .name("name")
                                                         .build()))
                                                 .build())
                                         .build()))
                                 .window(MetricWindowProperty.builder()
                                         .tumbling(TumblingWindowProperty.builder()
                                                 .interval("interval")
                                                 // the properties below are optional
                                                 .offset("offset")
                                                 .build())
                                         .build())
                                 .build())
                         .transform(TransformProperty.builder()
                                 .expression("expression")
                                 .variables(List.of(ExpressionVariableProperty.builder()
                                         .name("name")
                                         .value(VariableValueProperty.builder()
                                                 .hierarchyExternalId("hierarchyExternalId")
                                                 .hierarchyId("hierarchyId")
                                                 .hierarchyLogicalId("hierarchyLogicalId")
                                                 .propertyExternalId("propertyExternalId")
                                                 .propertyId("propertyId")
                                                 .propertyLogicalId("propertyLogicalId")
                                                 .propertyPath(List.of(PropertyPathDefinitionProperty.builder()
                                                         .name("name")
                                                         .build()))
                                                 .build())
                                         .build()))
                                 .build())
                         .build())
                 // the properties below are optional
                 .dataTypeSpec("dataTypeSpec")
                 .externalId("externalId")
                 .id("id")
                 .logicalId("logicalId")
                 .unit("unit")
                 .build()))
         .assetModelType("assetModelType")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAssetModelProps.Builder	A builder for CfnAssetModelProps
static final class	CfnAssetModelProps.Jsii$Proxy	An implementation for CfnAssetModelProps

Method Summary

Modifier and Type	Method	Description
static CfnAssetModelProps.Builder	builder()
default Object	getAssetModelCompositeModels()	The composite models that are part of this asset model.
default String	getAssetModelDescription()	A description for the asset model.
default String	getAssetModelExternalId()	The external ID of the asset model.
default Object	getAssetModelHierarchies()	The hierarchy definitions of the asset model.
String	getAssetModelName()	A unique name for the asset model.
default Object	getAssetModelProperties()	The property definitions of the asset model.
default String	getAssetModelType()	The type of asset model.
default List<CfnTag>	getTags()	A list of key-value pairs that contain metadata for the asset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssetModelName

@Stability(Stable)
@NotNull
String getAssetModelName()

A unique name for the asset model.

See Also:

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

getAssetModelCompositeModels

@Stability(Stable)
@Nullable
default Object getAssetModelCompositeModels()

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.

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 .

See Also:

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

getAssetModelDescription

@Stability(Stable)
@Nullable
default String getAssetModelDescription()

A description for the asset model.

See Also:

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

getAssetModelExternalId

@Stability(Stable)
@Nullable
default String getAssetModelExternalId()

The external ID of the asset model.

For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

See Also:

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

getAssetModelHierarchies

@Stability(Stable)
@Nullable
default Object getAssetModelHierarchies()

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 Also:

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

getAssetModelProperties

@Stability(Stable)
@Nullable
default Object getAssetModelProperties()

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 Also:

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

getAssetModelType

@Stability(Stable)
@Nullable
default String getAssetModelType()

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.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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 Also:

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

builder

@Stability(Stable)
static CfnAssetModelProps.Builder builder()

Returns:

a CfnAssetModelProps.Builder of CfnAssetModelProps