class Aws::IoTSiteWise::Types::AssetModelPropertyDefinition

Contains an asset model property definition. This property definition is applied to all assets created from the asset model.

@note When making an API call, you may pass AssetModelPropertyDefinition

data as a hash:

    {
      name: "Name", # required
      data_type: "STRING", # required, accepts STRING, INTEGER, DOUBLE, BOOLEAN, STRUCT
      data_type_spec: "Name",
      unit: "PropertyUnit",
      type: { # required
        attribute: {
          default_value: "DefaultValue",
        },
        measurement: {
          processing_config: {
            forwarding_config: { # required
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        transform: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro", # required
                hierarchy_id: "Macro",
              },
            },
          ],
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
            forwarding_config: {
              state: "DISABLED", # required, accepts DISABLED, ENABLED
            },
          },
        },
        metric: {
          expression: "Expression", # required
          variables: [ # required
            {
              name: "VariableName", # required
              value: { # required
                property_id: "Macro", # required
                hierarchy_id: "Macro",
              },
            },
          ],
          window: { # required
            tumbling: {
              interval: "Interval", # required
              offset: "Offset",
            },
          },
          processing_config: {
            compute_location: "EDGE", # required, accepts EDGE, CLOUD
          },
        },
      },
    }

@!attribute [rw] name

The name of the property definition.
@return [String]

@!attribute [rw] data_type

The data type of the property definition.

If you specify `STRUCT`, you must also specify `dataTypeSpec` to
identify the type of the structure for this property.
@return [String]

@!attribute [rw] data_type_spec

The data type of the structure for this property. This parameter is
required on properties that have the `STRUCT` data type.

The options for this parameter depend on the type of the composite
model in which you define this property. Use `AWS/ALARM_STATE` for
alarm state in alarm composite models.
@return [String]

@!attribute [rw] unit

The unit of the property definition, such as `Newtons` or `RPM`.
@return [String]

@!attribute [rw] type

The property definition type (see `PropertyType`). You can only
specify one type in a property definition.
@return [Types::PropertyType]

Constants

SENSITIVE