Class: Aws::IoTSiteWise::Types::AssetModelPropertyDefinition
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoTSiteWise::Types::AssetModelPropertyDefinition
- Defined in:
- gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb
Overview
Contains an asset model property definition. This property definition is applied to all assets created from the asset model.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#data_type ⇒ String
The data type of the property definition.
-
#data_type_spec ⇒ String
The data type of the structure for this property.
-
#external_id ⇒ String
An external ID to assign to the property definition.
-
#id ⇒ String
The ID to assign to the asset model property, if desired.
-
#name ⇒ String
The name of the property definition.
-
#type ⇒ Types::PropertyType
The property definition type (see
PropertyType
). -
#unit ⇒ String
The unit of the property definition, such as
Newtons
orRPM
.
Instance Attribute Details
#data_type ⇒ String
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.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |
#data_type_spec ⇒ String
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.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |
#external_id ⇒ String
An external ID to assign to the property definition. The external ID must be unique among property definitions within this asset model. For more information, see Using external IDs in the IoT SiteWise User Guide.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
The ID to assign to the asset model property, if desired. IoT SiteWise automatically generates a unique ID for you, so this parameter is never required. However, if you prefer to supply your own ID instead, you can specify it here in UUID format. If you specify your own ID, it must be globally unique.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the property definition.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |
#type ⇒ Types::PropertyType
The property definition type (see PropertyType
). You can only
specify one type in a property definition.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |
#unit ⇒ String
The unit of the property definition, such as Newtons
or RPM
.
830 831 832 833 834 835 836 837 838 839 840 |
# File 'gems/aws-sdk-iotsitewise/lib/aws-sdk-iotsitewise/types.rb', line 830 class AssetModelPropertyDefinition < Struct.new( :id, :external_id, :name, :data_type, :data_type_spec, :unit, :type) SENSITIVE = [] include Aws::Structure end |