Class: AWSCDK::IoTSiteWise::CfnAssetModel::AssetModelPropertyProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
io_t_site_wise/cfn_asset_model.rb

Overview

Contains information about an asset model property.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_type:, name:, type:, data_type_spec: nil, external_id: nil, id: nil, logical_id: nil, unit: nil) ⇒ AssetModelPropertyProperty

Returns a new instance of AssetModelPropertyProperty.

Parameters:

  • data_type (String) —

    The data type of the asset model property.

  • name (String) —

    The name of the asset model property.

  • type (AWSCDK::IResolvable, AWSCDK::IoTSiteWise::CfnAssetModel::PropertyTypeProperty) —

    Contains a property type, which can be one of attribute , measurement , metric , or transform .

  • data_type_spec (String, nil) (defaults to: nil) —

    The data type of the structure for this property.

  • external_id (String, nil) (defaults to: nil) —

    The external ID of the asset property.

  • id (String, nil) (defaults to: nil) —

    The ID of the property.

  • logical_id (String, nil) (defaults to: nil) —

    The LogicalID of the asset model property.

  • unit (String, nil) (defaults to: nil) —

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



885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 885

def initialize(data_type:, name:, type:, data_type_spec: nil, external_id: nil, id: nil, logical_id: nil, unit: nil)
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType")
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @type = type.is_a?(Hash) ? ::AWSCDK::IoTSiteWise::CfnAssetModel::PropertyTypeProperty.new(**type.transform_keys(&:to_sym)) : type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19pb3RzaXRld2lzZS5DZm5Bc3NldE1vZGVsLlByb3BlcnR5VHlwZVByb3BlcnR5In1dfX0=")), "type")
  @data_type_spec = data_type_spec
  Jsii::Type.check_type(@data_type_spec, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataTypeSpec") unless @data_type_spec.nil?
  @external_id = external_id
  Jsii::Type.check_type(@external_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "externalId") unless @external_id.nil?
  @id = id
  Jsii::Type.check_type(@id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id") unless @id.nil?
  @logical_id = logical_id
  Jsii::Type.check_type(@logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logicalId") unless @logical_id.nil?
  @unit = unit
  Jsii::Type.check_type(@unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unit") unless @unit.nil?
end

Instance Attribute Details

#data_type ⇒ String (readonly)

The data type of the asset model property.

If you specify STRUCT , you must also specify data_type_spec to identify the type of the structure for this property.

Returns:

  • (String)

See Also:



910
911
912
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 910

def data_type
  @data_type
end

#data_type_spec ⇒ String? (readonly)

The data type of the structure for this property.

This parameter exists on properties that have the STRUCT data type.

Returns:

  • (String, nil)

See Also:



927
928
929
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 927

def data_type_spec
  @data_type_spec
end

#external_id ⇒ String? (readonly)

The external ID of the asset property.

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

One of ExternalId or LogicalId must be specified.

Returns:

  • (String, nil)

See Also:



936
937
938
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 936

def external_id
  @external_id
end

#id ⇒ String? (readonly)

The ID of the property.

This is a return value and can't be set.

Returns:

  • (String, nil)

See Also:



943
944
945
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 943

def id
  @id
end

#logical_id ⇒ String? (readonly)

The LogicalID of the asset model property.

One of ExternalId or LogicalId must be specified.

Returns:

  • (String, nil)

See Also:



950
951
952
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 950

def logical_id
  @logical_id
end

#name ⇒ String (readonly)

The name of the asset model property.

Returns:

  • (String)

See Also:



915
916
917
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 915

def name
  @name
end

#type ⇒ AWSCDK::IResolvable, AWSCDK::IoTSiteWise::CfnAssetModel::PropertyTypeProperty (readonly)

Contains a property type, which can be one of attribute , measurement , metric , or transform .

Returns:

See Also:



920
921
922
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 920

def type
  @type
end

#unit ⇒ String? (readonly)

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

Returns:

  • (String, nil)

See Also:



955
956
957
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 955

def unit
  @unit
end

Class Method Details

.jsii_properties ⇒ Object 



957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 957

def self.jsii_properties
  {
    :data_type => "dataType",
    :name => "name",
    :type => "type",
    :data_type_spec => "dataTypeSpec",
    :external_id => "externalId",
    :id => "id",
    :logical_id => "logicalId",
    :unit => "unit",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



970
971
972
973
974
975
976
977
978
979
980
981
982
983
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 970

def to_jsii
  result = {}
  result.merge!({
    "dataType" => @data_type,
    "name" => @name,
    "type" => @type,
    "dataTypeSpec" => @data_type_spec,
    "externalId" => @external_id,
    "id" => @id,
    "logicalId" => @logical_id,
    "unit" => @unit,
  })
  result.compact
end