Class: AWSCDK::IoTSiteWise::CfnAsset::AssetPropertyProperty

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

Overview

Contains asset property information.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(_alias: nil, external_id: nil, id: nil, logical_id: nil, notification_state: nil, unit: nil) ⇒ AssetPropertyProperty

Returns a new instance of AssetPropertyProperty.

Parameters:

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

    The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ).

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

    The external ID of the property.

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

    The ID of the asset property.

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

    The LogicalID of the asset property.

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

    The MQTT notification state (enabled or disabled) for this asset property.

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

    The unit (such as Newtons or RPM ) of the asset property.



705
706
707
708
709
710
711
712
713
714
715
716
717
718
 
# File 'io_t_site_wise/cfn_asset.rb', line 705

def initialize(_alias: nil, external_id: nil, id: nil, logical_id: nil, notification_state: nil, unit: nil)
  @_alias = _alias
  Jsii::Type.check_type(@_alias, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "alias") unless @_alias.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?
  @notification_state = notification_state
  Jsii::Type.check_type(@notification_state, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "notificationState") unless @notification_state.nil?
  @unit = unit
  Jsii::Type.check_type(@unit, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "unit") unless @unit.nil?
end

Instance Attribute Details

#_alias ⇒ String? (readonly)

The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature ).

For more information, see Mapping industrial data streams to asset properties in the AWS IoT SiteWise User Guide .

Returns:

  • (String, nil)

See Also:



726
727
728
 
# File 'io_t_site_wise/cfn_asset.rb', line 726

def _alias
  @_alias
end

#external_id ⇒ String? (readonly)

The external ID of the property.

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

Returns:

  • (String, nil)

See Also:



733
734
735
 
# File 'io_t_site_wise/cfn_asset.rb', line 733

def external_id
  @external_id
end

#id ⇒ String? (readonly)

The ID of the asset property.

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

Returns:

  • (String, nil)

See Also:



740
741
742
 
# File 'io_t_site_wise/cfn_asset.rb', line 740

def id
  @id
end

#logical_id ⇒ String? (readonly)

The LogicalID of the asset property.

Returns:

  • (String, nil)

See Also:



745
746
747
 
# File 'io_t_site_wise/cfn_asset.rb', line 745

def logical_id
  @logical_id
end

#notification_state ⇒ String? (readonly)

The MQTT notification state (enabled or disabled) for this asset property.

When the notification state is enabled, AWS IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the AWS IoT SiteWise User Guide .

If you omit this parameter, the notification state is set to DISABLED .

Returns:

  • (String, nil)

See Also:



754
755
756
 
# File 'io_t_site_wise/cfn_asset.rb', line 754

def notification_state
  @notification_state
end

#unit ⇒ String? (readonly)

The unit (such as Newtons or RPM ) of the asset property.

Returns:

  • (String, nil)

See Also:



759
760
761
 
# File 'io_t_site_wise/cfn_asset.rb', line 759

def unit
  @unit
end

Class Method Details

.jsii_properties ⇒ Object 



761
762
763
764
765
766
767
768
769
770
 
# File 'io_t_site_wise/cfn_asset.rb', line 761

def self.jsii_properties
  {
    :_alias => "alias",
    :external_id => "externalId",
    :id => "id",
    :logical_id => "logicalId",
    :notification_state => "notificationState",
    :unit => "unit",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'io_t_site_wise/cfn_asset.rb', line 772

def to_jsii
  result = {}
  result.merge!({
    "alias" => @_alias,
    "externalId" => @external_id,
    "id" => @id,
    "logicalId" => @logical_id,
    "notificationState" => @notification_state,
    "unit" => @unit,
  })
  result.compact
end