Class: AWSCDK::IoTSiteWise::CfnAsset::AssetHierarchyProperty

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

Overview

Describes an asset hierarchy that contains a hierarchy's name and ID.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(child_asset_id:, external_id: nil, id: nil, logical_id: nil) ⇒ AssetHierarchyProperty

Returns a new instance of AssetHierarchyProperty.

Parameters:

  • child_asset_id (String) —

    The Id of the child asset.

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

    The external ID of the hierarchy, if it has one.

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

    The ID of the hierarchy. This ID is a hierarchyId .

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

    The ID of the hierarchy.



634
635
636
637
638
639
640
641
642
643
 
# File 'io_t_site_wise/cfn_asset.rb', line 634

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

Instance Attribute Details

#child_asset_id ⇒ String (readonly)

The Id of the child asset.

Returns:

  • (String)

See Also:



649
650
651
 
# File 'io_t_site_wise/cfn_asset.rb', line 649

def child_asset_id
  @child_asset_id
end

#external_id ⇒ String? (readonly)

The external ID of the hierarchy, if it has one.

When you update an asset hierarchy, you may assign an external ID if it doesn't already have one. You can't change the external ID of an asset hierarchy that already has one. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

Returns:

  • (String, nil)

See Also:



656
657
658
 
# File 'io_t_site_wise/cfn_asset.rb', line 656

def external_id
  @external_id
end

#id ⇒ String? (readonly)

The ID of the hierarchy. This ID is a hierarchyId .

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

Returns:

  • (String, nil)

See Also:



663
664
665
 
# File 'io_t_site_wise/cfn_asset.rb', line 663

def id
  @id
end

#logical_id ⇒ String? (readonly)

The ID of the hierarchy.

This ID is a hierarchy_id .

Returns:

  • (String, nil)

See Also:



670
671
672
 
# File 'io_t_site_wise/cfn_asset.rb', line 670

def logical_id
  @logical_id
end

Class Method Details

.jsii_properties ⇒ Object 



672
673
674
675
676
677
678
679
 
# File 'io_t_site_wise/cfn_asset.rb', line 672

def self.jsii_properties
  {
    :child_asset_id => "childAssetId",
    :external_id => "externalId",
    :id => "id",
    :logical_id => "logicalId",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



681
682
683
684
685
686
687
688
689
690
 
# File 'io_t_site_wise/cfn_asset.rb', line 681

def to_jsii
  result = {}
  result.merge!({
    "childAssetId" => @child_asset_id,
    "externalId" => @external_id,
    "id" => @id,
    "logicalId" => @logical_id,
  })
  result.compact
end