Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. iotsitewise
  5. AssetModel

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.iotsitewise.AssetModel

Explore with Pulumi AI

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native

Resource schema for AWS::IoTSiteWise::AssetModel

Create AssetModel Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new AssetModel(name: string, args?: AssetModelArgs, opts?: CustomResourceOptions);
@overload
def AssetModel(resource_name: str,
               args: Optional[AssetModelArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def AssetModel(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               asset_model_composite_models: Optional[Sequence[AssetModelCompositeModelArgs]] = None,
               asset_model_description: Optional[str] = None,
               asset_model_external_id: Optional[str] = None,
               asset_model_hierarchies: Optional[Sequence[AssetModelHierarchyArgs]] = None,
               asset_model_name: Optional[str] = None,
               asset_model_properties: Optional[Sequence[AssetModelPropertyArgs]] = None,
               asset_model_type: Optional[str] = None,
               tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewAssetModel(ctx *Context, name string, args *AssetModelArgs, opts ...ResourceOption) (*AssetModel, error)
public AssetModel(string name, AssetModelArgs? args = null, CustomResourceOptions? opts = null)
public AssetModel(String name, AssetModelArgs args)
public AssetModel(String name, AssetModelArgs args, CustomResourceOptions options)

type: aws-native:iotsitewise:AssetModel
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args AssetModelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args AssetModelArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args AssetModelArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args AssetModelArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. AssetModelArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AssetModel Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The AssetModel resource accepts the following input properties:

AssetModelCompositeModels List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelCompositeModel>
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
AssetModelDescription string
A description for the asset model.
AssetModelExternalId string
The external ID of the asset model.
AssetModelHierarchies List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelHierarchy>
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. You can specify up to 10 hierarchies per asset model.
AssetModelName string
A unique, friendly name for the asset model.
AssetModelProperties List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelProperty>
The property definitions of the asset model. You can specify up to 200 properties per asset model.
AssetModelType string
The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
Tags List<Pulumi.AwsNative.Inputs.Tag>
A list of key-value pairs that contain metadata for the asset model.
AssetModelCompositeModels []AssetModelCompositeModelArgs
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
AssetModelDescription string
A description for the asset model.
AssetModelExternalId string
The external ID of the asset model.
AssetModelHierarchies []AssetModelHierarchyArgs
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. You can specify up to 10 hierarchies per asset model.
AssetModelName string
A unique, friendly name for the asset model.
AssetModelProperties []AssetModelPropertyArgs
The property definitions of the asset model. You can specify up to 200 properties per asset model.
AssetModelType string
The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
Tags TagArgs
A list of key-value pairs that contain metadata for the asset model.
assetModelCompositeModels List<AssetModelCompositeModel>
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
assetModelDescription String
A description for the asset model.
assetModelExternalId String
The external ID of the asset model.
assetModelHierarchies List<AssetModelHierarchy>
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. You can specify up to 10 hierarchies per asset model.
assetModelName String
A unique, friendly name for the asset model.
assetModelProperties List<AssetModelProperty>
The property definitions of the asset model. You can specify up to 200 properties per asset model.
assetModelType String
The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
tags List<Tag>
A list of key-value pairs that contain metadata for the asset model.
assetModelCompositeModels AssetModelCompositeModel[]
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
assetModelDescription string
A description for the asset model.
assetModelExternalId string
The external ID of the asset model.
assetModelHierarchies AssetModelHierarchy[]
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. You can specify up to 10 hierarchies per asset model.
assetModelName string
A unique, friendly name for the asset model.
assetModelProperties AssetModelProperty[]
The property definitions of the asset model. You can specify up to 200 properties per asset model.
assetModelType string
The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
tags Tag[]
A list of key-value pairs that contain metadata for the asset model.
asset_model_composite_models Sequence[AssetModelCompositeModelArgs]
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
asset_model_description str
A description for the asset model.
asset_model_external_id str
The external ID of the asset model.
asset_model_hierarchies Sequence[AssetModelHierarchyArgs]
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. You can specify up to 10 hierarchies per asset model.
asset_model_name str
A unique, friendly name for the asset model.
asset_model_properties Sequence[AssetModelPropertyArgs]
The property definitions of the asset model. You can specify up to 200 properties per asset model.
asset_model_type str
The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
tags Sequence[TagArgs]
A list of key-value pairs that contain metadata for the asset model.
assetModelCompositeModels List<Property Map>
The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties.
assetModelDescription String
A description for the asset model.
assetModelExternalId String
The external ID of the asset model.
assetModelHierarchies List<Property Map>
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. You can specify up to 10 hierarchies per asset model.
assetModelName String
A unique, friendly name for the asset model.
assetModelProperties List<Property Map>
The property definitions of the asset model. You can specify up to 200 properties per asset model.
assetModelType String
The type of the asset model (ASSET_MODEL OR COMPONENT_MODEL)
tags List<Property Map>
A list of key-value pairs that contain metadata for the asset model.

Outputs

All input properties are implicitly available as output properties. Additionally, the AssetModel resource produces the following output properties:

AssetModelArn string
The ARN of the asset model, which has the following format.
AssetModelId string
The ID of the asset model.
Id string
The provider-assigned unique ID for this managed resource.
AssetModelArn string
The ARN of the asset model, which has the following format.
AssetModelId string
The ID of the asset model.
Id string
The provider-assigned unique ID for this managed resource.
assetModelArn String
The ARN of the asset model, which has the following format.
assetModelId String
The ID of the asset model.
id String
The provider-assigned unique ID for this managed resource.
assetModelArn string
The ARN of the asset model, which has the following format.
assetModelId string
The ID of the asset model.
id string
The provider-assigned unique ID for this managed resource.
asset_model_arn str
The ARN of the asset model, which has the following format.
asset_model_id str
The ID of the asset model.
id str
The provider-assigned unique ID for this managed resource.
assetModelArn String
The ARN of the asset model, which has the following format.
assetModelId String
The ID of the asset model.
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

AssetModelAttribute
, AssetModelAttributeArgs

DefaultValue string
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .
DefaultValue string
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .
defaultValue String
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .
defaultValue string
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .
default_value str
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .
defaultValue String
The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the AWS IoT SiteWise User Guide .

AssetModelCompositeModel
, AssetModelCompositeModelArgs

Name This property is required. string
A unique, friendly name for the asset composite model.
Type This property is required. string
The type of the composite model. For alarm composite models, this type is AWS/ALARM
ComposedAssetModelId string
The component model ID for which the composite model is composed of
CompositeModelProperties List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelProperty>
The property definitions of the asset model. You can specify up to 200 properties per asset model.
Description string
A description for the asset composite model.
ExternalId string
The External ID of the composite model
Id string
The Actual ID of the composite model
ParentAssetModelCompositeModelExternalId string
The parent composite model External ID
Path List<string>
The path of the composite model. This is only for derived composite models
Name This property is required. string
A unique, friendly name for the asset composite model.
Type This property is required. string
The type of the composite model. For alarm composite models, this type is AWS/ALARM
ComposedAssetModelId string
The component model ID for which the composite model is composed of
CompositeModelProperties []AssetModelProperty
The property definitions of the asset model. You can specify up to 200 properties per asset model.
Description string
A description for the asset composite model.
ExternalId string
The External ID of the composite model
Id string
The Actual ID of the composite model
ParentAssetModelCompositeModelExternalId string
The parent composite model External ID
Path []string
The path of the composite model. This is only for derived composite models
name This property is required. String
A unique, friendly name for the asset composite model.
type This property is required. String
The type of the composite model. For alarm composite models, this type is AWS/ALARM
composedAssetModelId String
The component model ID for which the composite model is composed of
compositeModelProperties List<AssetModelProperty>
The property definitions of the asset model. You can specify up to 200 properties per asset model.
description String
A description for the asset composite model.
externalId String
The External ID of the composite model
id String
The Actual ID of the composite model
parentAssetModelCompositeModelExternalId String
The parent composite model External ID
path List<String>
The path of the composite model. This is only for derived composite models
name This property is required. string
A unique, friendly name for the asset composite model.
type This property is required. string
The type of the composite model. For alarm composite models, this type is AWS/ALARM
composedAssetModelId string
The component model ID for which the composite model is composed of
compositeModelProperties AssetModelProperty[]
The property definitions of the asset model. You can specify up to 200 properties per asset model.
description string
A description for the asset composite model.
externalId string
The External ID of the composite model
id string
The Actual ID of the composite model
parentAssetModelCompositeModelExternalId string
The parent composite model External ID
path string[]
The path of the composite model. This is only for derived composite models
name This property is required. str
A unique, friendly name for the asset composite model.
type This property is required. str
The type of the composite model. For alarm composite models, this type is AWS/ALARM
composed_asset_model_id str
The component model ID for which the composite model is composed of
composite_model_properties Sequence[AssetModelProperty]
The property definitions of the asset model. You can specify up to 200 properties per asset model.
description str
A description for the asset composite model.
external_id str
The External ID of the composite model
id str
The Actual ID of the composite model
parent_asset_model_composite_model_external_id str
The parent composite model External ID
path Sequence[str]
The path of the composite model. This is only for derived composite models
name This property is required. String
A unique, friendly name for the asset composite model.
type This property is required. String
The type of the composite model. For alarm composite models, this type is AWS/ALARM
composedAssetModelId String
The component model ID for which the composite model is composed of
compositeModelProperties List<Property Map>
The property definitions of the asset model. You can specify up to 200 properties per asset model.
description String
A description for the asset composite model.
externalId String
The External ID of the composite model
id String
The Actual ID of the composite model
parentAssetModelCompositeModelExternalId String
The parent composite model External ID
path List<String>
The path of the composite model. This is only for derived composite models

AssetModelDataType
, AssetModelDataTypeArgs

String
STRING
Integer
INTEGER
Double
DOUBLE
Boolean
BOOLEAN
Struct
STRUCT
AssetModelDataTypeString
STRING
AssetModelDataTypeInteger
INTEGER
AssetModelDataTypeDouble
DOUBLE
AssetModelDataTypeBoolean
BOOLEAN
AssetModelDataTypeStruct
STRUCT
String
STRING
Integer
INTEGER
Double
DOUBLE
Boolean
BOOLEAN
Struct
STRUCT
String
STRING
Integer
INTEGER
Double
DOUBLE
Boolean
BOOLEAN
Struct
STRUCT
STRING
STRING
INTEGER
INTEGER
DOUBLE
DOUBLE
BOOLEAN
BOOLEAN
STRUCT
STRUCT
"STRING"
STRING
"INTEGER"
INTEGER
"DOUBLE"
DOUBLE
"BOOLEAN"
BOOLEAN
"STRUCT"
STRUCT

AssetModelDataTypeSpec
, AssetModelDataTypeSpecArgs

AwsalarmState
AWS/ALARM_STATE
AssetModelDataTypeSpecAwsalarmState
AWS/ALARM_STATE
AwsalarmState
AWS/ALARM_STATE
AwsalarmState
AWS/ALARM_STATE
AWSALARM_STATE
AWS/ALARM_STATE
"AWS/ALARM_STATE"
AWS/ALARM_STATE

AssetModelExpressionVariable
, AssetModelExpressionVariableArgs

Name This property is required. string
The friendly name of the variable to be used in the expression.
Value This property is required. Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelVariableValue
The variable that identifies an asset property from which to use values.
Name This property is required. string
The friendly name of the variable to be used in the expression.
Value This property is required. AssetModelVariableValue
The variable that identifies an asset property from which to use values.
name This property is required. String
The friendly name of the variable to be used in the expression.
value This property is required. AssetModelVariableValue
The variable that identifies an asset property from which to use values.
name This property is required. string
The friendly name of the variable to be used in the expression.
value This property is required. AssetModelVariableValue
The variable that identifies an asset property from which to use values.
name This property is required. str
The friendly name of the variable to be used in the expression.
value This property is required. AssetModelVariableValue
The variable that identifies an asset property from which to use values.
name This property is required. String
The friendly name of the variable to be used in the expression.
value This property is required. Property Map
The variable that identifies an asset property from which to use values.

AssetModelHierarchy
, AssetModelHierarchyArgs

ChildAssetModelId This property is required. string
The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
Name This property is required. string
The name of the asset model hierarchy.
ExternalId string
Customer provided external ID for hierarchy
Id string
Customer provided actual ID for hierarchy
LogicalId string
Customer provided logical ID for hierarchy.
ChildAssetModelId This property is required. string
The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
Name This property is required. string
The name of the asset model hierarchy.
ExternalId string
Customer provided external ID for hierarchy
Id string
Customer provided actual ID for hierarchy
LogicalId string
Customer provided logical ID for hierarchy.
childAssetModelId This property is required. String
The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name This property is required. String
The name of the asset model hierarchy.
externalId String
Customer provided external ID for hierarchy
id String
Customer provided actual ID for hierarchy
logicalId String
Customer provided logical ID for hierarchy.
childAssetModelId This property is required. string
The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name This property is required. string
The name of the asset model hierarchy.
externalId string
Customer provided external ID for hierarchy
id string
Customer provided actual ID for hierarchy
logicalId string
Customer provided logical ID for hierarchy.
child_asset_model_id This property is required. str
The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name This property is required. str
The name of the asset model hierarchy.
external_id str
Customer provided external ID for hierarchy
id str
Customer provided actual ID for hierarchy
logical_id str
Customer provided logical ID for hierarchy.
childAssetModelId This property is required. String
The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.
name This property is required. String
The name of the asset model hierarchy.
externalId String
Customer provided external ID for hierarchy
id String
Customer provided actual ID for hierarchy
logicalId String
Customer provided logical ID for hierarchy.

AssetModelMetric
, AssetModelMetricArgs

Expression This property is required. string
The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
Variables This property is required. List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelExpressionVariable>
The list of variables used in the expression.
Window This property is required. Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelMetricWindow
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression
Expression This property is required. string
The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
Variables This property is required. []AssetModelExpressionVariable
The list of variables used in the expression.
Window This property is required. AssetModelMetricWindow
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression
expression This property is required. String
The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables This property is required. List<AssetModelExpressionVariable>
The list of variables used in the expression.
window This property is required. AssetModelMetricWindow
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression
expression This property is required. string
The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables This property is required. AssetModelExpressionVariable[]
The list of variables used in the expression.
window This property is required. AssetModelMetricWindow
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression
expression This property is required. str
The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables This property is required. Sequence[AssetModelExpressionVariable]
The list of variables used in the expression.
window This property is required. AssetModelMetricWindow
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression
expression This property is required. String
The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.
variables This property is required. List<Property Map>
The list of variables used in the expression.
window This property is required. Property Map
The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

AssetModelMetricWindow
, AssetModelMetricWindowArgs

Tumbling AssetModelTumblingWindow
The tumbling time interval window.
tumbling AssetModelTumblingWindow
The tumbling time interval window.
tumbling AssetModelTumblingWindow
The tumbling time interval window.
tumbling AssetModelTumblingWindow
The tumbling time interval window.
tumbling Property Map
The tumbling time interval window.

AssetModelProperty
, AssetModelPropertyArgs

DataType This property is required. Pulumi.AwsNative.IoTSiteWise.AssetModelDataType
The data type of the asset model property.
Name This property is required. string
The name of the asset model property.
Type This property is required. Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelPropertyType
The property type
DataTypeSpec Pulumi.AwsNative.IoTSiteWise.AssetModelDataTypeSpec
The data type of the structure for this property.
ExternalId string
The External ID of the Asset Model Property
Id string
The ID of the Asset Model Property
LogicalId string
Customer provided Logical ID for property.
Unit string
The unit of the asset model property, such as Newtons or RPM.
DataType This property is required. AssetModelDataType
The data type of the asset model property.
Name This property is required. string
The name of the asset model property.
Type This property is required. AssetModelPropertyType
The property type
DataTypeSpec AssetModelDataTypeSpec
The data type of the structure for this property.
ExternalId string
The External ID of the Asset Model Property
Id string
The ID of the Asset Model Property
LogicalId string
Customer provided Logical ID for property.
Unit string
The unit of the asset model property, such as Newtons or RPM.
dataType This property is required. AssetModelDataType
The data type of the asset model property.
name This property is required. String
The name of the asset model property.
type This property is required. AssetModelPropertyType
The property type
dataTypeSpec AssetModelDataTypeSpec
The data type of the structure for this property.
externalId String
The External ID of the Asset Model Property
id String
The ID of the Asset Model Property
logicalId String
Customer provided Logical ID for property.
unit String
The unit of the asset model property, such as Newtons or RPM.
dataType This property is required. AssetModelDataType
The data type of the asset model property.
name This property is required. string
The name of the asset model property.
type This property is required. AssetModelPropertyType
The property type
dataTypeSpec AssetModelDataTypeSpec
The data type of the structure for this property.
externalId string
The External ID of the Asset Model Property
id string
The ID of the Asset Model Property
logicalId string
Customer provided Logical ID for property.
unit string
The unit of the asset model property, such as Newtons or RPM.
data_type This property is required. AssetModelDataType
The data type of the asset model property.
name This property is required. str
The name of the asset model property.
type This property is required. AssetModelPropertyType
The property type
data_type_spec AssetModelDataTypeSpec
The data type of the structure for this property.
external_id str
The External ID of the Asset Model Property
id str
The ID of the Asset Model Property
logical_id str
Customer provided Logical ID for property.
unit str
The unit of the asset model property, such as Newtons or RPM.
dataType This property is required. "STRING" | "INTEGER" | "DOUBLE" | "BOOLEAN" | "STRUCT"
The data type of the asset model property.
name This property is required. String
The name of the asset model property.
type This property is required. Property Map
The property type
dataTypeSpec "AWS/ALARM_STATE"
The data type of the structure for this property.
externalId String
The External ID of the Asset Model Property
id String
The ID of the Asset Model Property
logicalId String
Customer provided Logical ID for property.
unit String
The unit of the asset model property, such as Newtons or RPM.

AssetModelPropertyPathDefinition
, AssetModelPropertyPathDefinitionArgs

Name This property is required. string
The name of the property
Name This property is required. string
The name of the property
name This property is required. String
The name of the property
name This property is required. string
The name of the property
name This property is required. str
The name of the property
name This property is required. String
The name of the property

AssetModelPropertyType
, AssetModelPropertyTypeArgs

TypeName This property is required. Pulumi.AwsNative.IoTSiteWise.AssetModelTypeName
The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
Attribute Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelAttribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
Metric Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelMetric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
Transform Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelTransform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
TypeName This property is required. AssetModelTypeName
The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
Attribute AssetModelAttribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
Metric AssetModelMetric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
Transform AssetModelTransform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
typeName This property is required. AssetModelTypeName
The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute AssetModelAttribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric AssetModelMetric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform AssetModelTransform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
typeName This property is required. AssetModelTypeName
The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute AssetModelAttribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric AssetModelMetric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform AssetModelTransform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
type_name This property is required. AssetModelTypeName
The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute AssetModelAttribute
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric AssetModelMetric
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform AssetModelTransform
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.
typeName This property is required. "Measurement" | "Attribute" | "Transform" | "Metric"
The type of property type, which can be one of Attribute , Measurement , Metric , or Transform .
attribute Property Map
Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine.
metric Property Map
Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature.
transform Property Map
Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit.

AssetModelTransform
, AssetModelTransformArgs

Expression This property is required. string
The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
Variables This property is required. List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelExpressionVariable>
The list of variables used in the expression.
Expression This property is required. string
The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
Variables This property is required. []AssetModelExpressionVariable
The list of variables used in the expression.
expression This property is required. String
The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables This property is required. List<AssetModelExpressionVariable>
The list of variables used in the expression.
expression This property is required. string
The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables This property is required. AssetModelExpressionVariable[]
The list of variables used in the expression.
expression This property is required. str
The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables This property is required. Sequence[AssetModelExpressionVariable]
The list of variables used in the expression.
expression This property is required. String
The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.
variables This property is required. List<Property Map>
The list of variables used in the expression.

AssetModelTumblingWindow
, AssetModelTumblingWindowArgs

Interval This property is required. string

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

Offset string

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
Interval This property is required. string

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

Offset string

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
interval This property is required. String

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

offset String

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
interval This property is required. string

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

offset string

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
interval This property is required. str

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

offset str

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.
interval This property is required. String

The time interval for the tumbling window. The interval time must be between 1 minute and 1 week.

AWS IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on.

When AWS IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. AWS IoT SiteWise places the computed data point at the end of the interval.

offset String

The offset for the tumbling window. The offset parameter accepts the following:

  • The offset time.

For example, if you specify 18h for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The ISO 8601 format.

For example, if you specify PT18H for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric.
  • If you create the metric after 6 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day.
  • The 24-hour clock.

For example, if you specify 00:03:00 for offset , 5m for interval , and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC).

  • The offset time zone.

For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval , AWS IoT SiteWise aggregates data in one of the following ways:

  • If you create the metric before or at 6 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric.
  • If you create the metric after 6 PM (PST), you get the first aggregation result at 6 PM (PST) the next day.

AssetModelTypeName
, AssetModelTypeNameArgs

Measurement
Measurement
Attribute
Attribute
Transform
Transform
Metric
Metric
AssetModelTypeNameMeasurement
Measurement
AssetModelTypeNameAttribute
Attribute
AssetModelTypeNameTransform
Transform
AssetModelTypeNameMetric
Metric
Measurement
Measurement
Attribute
Attribute
Transform
Transform
Metric
Metric
Measurement
Measurement
Attribute
Attribute
Transform
Transform
Metric
Metric
MEASUREMENT
Measurement
ATTRIBUTE
Attribute
TRANSFORM
Transform
METRIC
Metric
"Measurement"
Measurement
"Attribute"
Attribute
"Transform"
Transform
"Metric"
Metric

AssetModelVariableValue
, AssetModelVariableValueArgs

HierarchyExternalId string
The External ID of the hierarchy that is trying to be referenced
HierarchyId string
The ID of the hierarchy that is trying to be referenced
HierarchyLogicalId string

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

PropertyExternalId string
The External ID of the property that is trying to be referenced
PropertyId string
The ID of the property that is trying to be referenced
PropertyLogicalId string
The LogicalID of the property that is being referenced.
PropertyPath List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelPropertyPathDefinition>
The path of the property that is trying to be referenced
HierarchyExternalId string
The External ID of the hierarchy that is trying to be referenced
HierarchyId string
The ID of the hierarchy that is trying to be referenced
HierarchyLogicalId string

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

PropertyExternalId string
The External ID of the property that is trying to be referenced
PropertyId string
The ID of the property that is trying to be referenced
PropertyLogicalId string
The LogicalID of the property that is being referenced.
PropertyPath []AssetModelPropertyPathDefinition
The path of the property that is trying to be referenced
hierarchyExternalId String
The External ID of the hierarchy that is trying to be referenced
hierarchyId String
The ID of the hierarchy that is trying to be referenced
hierarchyLogicalId String

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

propertyExternalId String
The External ID of the property that is trying to be referenced
propertyId String
The ID of the property that is trying to be referenced
propertyLogicalId String
The LogicalID of the property that is being referenced.
propertyPath List<AssetModelPropertyPathDefinition>
The path of the property that is trying to be referenced
hierarchyExternalId string
The External ID of the hierarchy that is trying to be referenced
hierarchyId string
The ID of the hierarchy that is trying to be referenced
hierarchyLogicalId string

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

propertyExternalId string
The External ID of the property that is trying to be referenced
propertyId string
The ID of the property that is trying to be referenced
propertyLogicalId string
The LogicalID of the property that is being referenced.
propertyPath AssetModelPropertyPathDefinition[]
The path of the property that is trying to be referenced
hierarchy_external_id str
The External ID of the hierarchy that is trying to be referenced
hierarchy_id str
The ID of the hierarchy that is trying to be referenced
hierarchy_logical_id str

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

property_external_id str
The External ID of the property that is trying to be referenced
property_id str
The ID of the property that is trying to be referenced
property_logical_id str
The LogicalID of the property that is being referenced.
property_path Sequence[AssetModelPropertyPathDefinition]
The path of the property that is trying to be referenced
hierarchyExternalId String
The External ID of the hierarchy that is trying to be referenced
hierarchyId String
The ID of the hierarchy that is trying to be referenced
hierarchyLogicalId String

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchyLogicalID instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

propertyExternalId String
The External ID of the property that is trying to be referenced
propertyId String
The ID of the property that is trying to be referenced
propertyLogicalId String
The LogicalID of the property that is being referenced.
propertyPath List<Property Map>
The path of the property that is trying to be referenced

Tag
, TagArgs

Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
Key This property is required. string
The key name of the tag
Value This property is required. string
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag
key This property is required. string
The key name of the tag
value This property is required. string
The value of the tag
key This property is required. str
The key name of the tag
value This property is required. str
The value of the tag
key This property is required. String
The key name of the tag
value This property is required. String
The value of the tag

Package Details

Repository
AWS Native pulumi/pulumi-aws-native
License
Apache-2.0

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.27.0 published on Monday, Apr 14, 2025 by Pulumi
pulumi/pulumi-aws-native