1. Packages
  2. AWS Native
  3. API Docs
  4. iotsitewise
  5. AssetModel

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi

aws-native.iotsitewise.AssetModel

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi

    Resource schema for AWS::IoTSiteWise::AssetModel

    Create AssetModel Resource

    new AssetModel(name: string, args?: AssetModelArgs, opts?: CustomResourceOptions);
    @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_hierarchies: Optional[Sequence[AssetModelHierarchyArgs]] = None,
                   asset_model_name: Optional[str] = None,
                   asset_model_properties: Optional[Sequence[AssetModelPropertyArgs]] = None,
                   tags: Optional[Sequence[AssetModelTagArgs]] = None)
    @overload
    def AssetModel(resource_name: str,
                   args: Optional[AssetModelArgs] = None,
                   opts: Optional[ResourceOptions] = 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.
    
    
    name 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 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 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 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 String
    The unique name of the resource.
    args 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

    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.

    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.

    Tags List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelTag>

    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.

    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.

    Tags []AssetModelTagArgs

    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.

    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.

    tags List<AssetModelTag>

    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.

    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.

    tags AssetModelTag[]

    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_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.

    tags Sequence[AssetModelTagArgs]

    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.

    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.

    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

    AssetModelCompositeModel, AssetModelCompositeModelArgs

    Name string

    A unique, friendly name for the asset composite model.

    Type string

    The type of the composite model. For alarm composite models, this type is AWS/ALARM

    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.

    Name string

    A unique, friendly name for the asset composite model.

    Type string

    The type of the composite model. For alarm composite models, this type is AWS/ALARM

    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.

    name String

    A unique, friendly name for the asset composite model.

    type String

    The type of the composite model. For alarm composite models, this type is AWS/ALARM

    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.

    name string

    A unique, friendly name for the asset composite model.

    type string

    The type of the composite model. For alarm composite models, this type is AWS/ALARM

    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.

    name str

    A unique, friendly name for the asset composite model.

    type str

    The type of the composite model. For alarm composite models, this type is AWS/ALARM

    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.

    name String

    A unique, friendly name for the asset composite model.

    type String

    The type of the composite model. For alarm composite models, this type is AWS/ALARM

    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.

    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 string

    The friendly name of the variable to be used in the expression.

    Value Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelVariableValue

    The variable that identifies an asset property from which to use values.

    Name string

    The friendly name of the variable to be used in the expression.

    Value AssetModelVariableValue

    The variable that identifies an asset property from which to use values.

    name String

    The friendly name of the variable to be used in the expression.

    value AssetModelVariableValue

    The variable that identifies an asset property from which to use values.

    name string

    The friendly name of the variable to be used in the expression.

    value AssetModelVariableValue

    The variable that identifies an asset property from which to use values.

    name str

    The friendly name of the variable to be used in the expression.

    value AssetModelVariableValue

    The variable that identifies an asset property from which to use values.

    name String

    The friendly name of the variable to be used in the expression.

    value Property Map

    The variable that identifies an asset property from which to use values.

    AssetModelHierarchy, AssetModelHierarchyArgs

    ChildAssetModelId string

    The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

    LogicalId string

    Customer provided ID for hierarchy.

    Name string

    The name of the asset model hierarchy.

    ChildAssetModelId string

    The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

    LogicalId string

    Customer provided ID for hierarchy.

    Name string

    The name of the asset model hierarchy.

    childAssetModelId String

    The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

    logicalId String

    Customer provided ID for hierarchy.

    name String

    The name of the asset model hierarchy.

    childAssetModelId string

    The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

    logicalId string

    Customer provided ID for hierarchy.

    name string

    The name of the asset model hierarchy.

    child_asset_model_id str

    The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

    logical_id str

    Customer provided ID for hierarchy.

    name str

    The name of the asset model hierarchy.

    childAssetModelId String

    The ID of the asset model. All assets in this hierarchy must be instances of the child AssetModelId asset model.

    logicalId String

    Customer provided ID for hierarchy.

    name String

    The name of the asset model hierarchy.

    AssetModelMetric, AssetModelMetricArgs

    Expression string

    The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

    Variables List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelExpressionVariable>

    The list of variables used in the expression.

    Window Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelMetricWindow

    The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

    Expression string

    The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

    Variables []AssetModelExpressionVariable

    The list of variables used in the expression.

    Window AssetModelMetricWindow

    The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

    expression String

    The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

    variables List<AssetModelExpressionVariable>

    The list of variables used in the expression.

    window AssetModelMetricWindow

    The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

    expression string

    The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

    variables AssetModelExpressionVariable[]

    The list of variables used in the expression.

    window AssetModelMetricWindow

    The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

    expression str

    The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

    variables Sequence[AssetModelExpressionVariable]

    The list of variables used in the expression.

    window AssetModelMetricWindow

    The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

    expression String

    The mathematical expression that defines the metric aggregation function. You can specify up to 10 functions per expression.

    variables List<Property Map>

    The list of variables used in the expression.

    window Property Map

    The window (time interval) over which AWS IoT SiteWise computes the metric's aggregation expression

    AssetModelMetricWindow, AssetModelMetricWindowArgs

    AssetModelProperty, AssetModelPropertyArgs

    DataType Pulumi.AwsNative.IoTSiteWise.AssetModelDataType

    The data type of the asset model property.

    LogicalId string

    Customer provided ID for property.

    Name string

    The name of the asset model property.

    Type Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelPropertyType

    The property type

    DataTypeSpec Pulumi.AwsNative.IoTSiteWise.AssetModelDataTypeSpec

    The data type of the structure for this property.

    Unit string

    The unit of the asset model property, such as Newtons or RPM.

    DataType AssetModelDataType

    The data type of the asset model property.

    LogicalId string

    Customer provided ID for property.

    Name string

    The name of the asset model property.

    Type AssetModelPropertyType

    The property type

    DataTypeSpec AssetModelDataTypeSpec

    The data type of the structure for this property.

    Unit string

    The unit of the asset model property, such as Newtons or RPM.

    dataType AssetModelDataType

    The data type of the asset model property.

    logicalId String

    Customer provided ID for property.

    name String

    The name of the asset model property.

    type AssetModelPropertyType

    The property type

    dataTypeSpec AssetModelDataTypeSpec

    The data type of the structure for this property.

    unit String

    The unit of the asset model property, such as Newtons or RPM.

    dataType AssetModelDataType

    The data type of the asset model property.

    logicalId string

    Customer provided ID for property.

    name string

    The name of the asset model property.

    type AssetModelPropertyType

    The property type

    dataTypeSpec AssetModelDataTypeSpec

    The data type of the structure for this property.

    unit string

    The unit of the asset model property, such as Newtons or RPM.

    data_type AssetModelDataType

    The data type of the asset model property.

    logical_id str

    Customer provided ID for property.

    name str

    The name of the asset model property.

    type AssetModelPropertyType

    The property type

    data_type_spec AssetModelDataTypeSpec

    The data type of the structure for this property.

    unit str

    The unit of the asset model property, such as Newtons or RPM.

    dataType "STRING" | "INTEGER" | "DOUBLE" | "BOOLEAN" | "STRUCT"

    The data type of the asset model property.

    logicalId String

    Customer provided ID for property.

    name String

    The name of the asset model property.

    type Property Map

    The property type

    dataTypeSpec "AWS/ALARM_STATE"

    The data type of the structure for this property.

    unit String

    The unit of the asset model property, such as Newtons or RPM.

    AssetModelPropertyType, AssetModelPropertyTypeArgs

    AssetModelTag, AssetModelTagArgs

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    AssetModelTransform, AssetModelTransformArgs

    Expression string

    The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

    Variables List<Pulumi.AwsNative.IoTSiteWise.Inputs.AssetModelExpressionVariable>

    The list of variables used in the expression.

    Expression string

    The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

    Variables []AssetModelExpressionVariable

    The list of variables used in the expression.

    expression String

    The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

    variables List<AssetModelExpressionVariable>

    The list of variables used in the expression.

    expression string

    The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

    variables AssetModelExpressionVariable[]

    The list of variables used in the expression.

    expression str

    The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

    variables Sequence[AssetModelExpressionVariable]

    The list of variables used in the expression.

    expression String

    The mathematical expression that defines the transformation function. You can specify up to 10 functions per expression.

    variables List<Property Map>

    The list of variables used in the expression.

    AssetModelTumblingWindow, AssetModelTumblingWindowArgs

    Interval string
    Offset string
    Interval string
    Offset string
    interval String
    offset String
    interval string
    offset string
    interval String
    offset String

    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

    Package Details

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

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.90.0 published on Monday, Dec 4, 2023 by Pulumi