Class: AWSCDK::IoTSiteWise::CfnAssetModel::VariableValueProperty

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

Overview

Identifies a property value used in an expression.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(hierarchy_external_id: nil, hierarchy_id: nil, hierarchy_logical_id: nil, property_external_id: nil, property_id: nil, property_logical_id: nil, property_path: nil) ⇒ VariableValueProperty

Returns a new instance of VariableValueProperty.

Parameters:

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

    The external ID of the hierarchy being referenced.

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

    The ID of the hierarchy to query for the property ID.

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

    The LogicalID of the hierarchy to query for the PropertyLogicalID .

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

    The external ID of the property being referenced.

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

    The ID of the property to use as the variable.

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

    The LogicalID of the property that is being referenced.

  • property_path (AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::IoTSiteWise::CfnAssetModel::PropertyPathDefinitionProperty>, nil) (defaults to: nil) —

    The path of the property.



1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1502

def initialize(hierarchy_external_id: nil, hierarchy_id: nil, hierarchy_logical_id: nil, property_external_id: nil, property_id: nil, property_logical_id: nil, property_path: nil)
  @hierarchy_external_id = hierarchy_external_id
  Jsii::Type.check_type(@hierarchy_external_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hierarchyExternalId") unless @hierarchy_external_id.nil?
  @hierarchy_id = hierarchy_id
  Jsii::Type.check_type(@hierarchy_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hierarchyId") unless @hierarchy_id.nil?
  @hierarchy_logical_id = hierarchy_logical_id
  Jsii::Type.check_type(@hierarchy_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "hierarchyLogicalId") unless @hierarchy_logical_id.nil?
  @property_external_id = property_external_id
  Jsii::Type.check_type(@property_external_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyExternalId") unless @property_external_id.nil?
  @property_id = property_id
  Jsii::Type.check_type(@property_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyId") unless @property_id.nil?
  @property_logical_id = property_logical_id
  Jsii::Type.check_type(@property_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyLogicalId") unless @property_logical_id.nil?
  @property_path = property_path
  Jsii::Type.check_type(@property_path, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaW90c2l0ZXdpc2UuQ2ZuQXNzZXRNb2RlbC5Qcm9wZXJ0eVBhdGhEZWZpbml0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "propertyPath") unless @property_path.nil?
end

Instance Attribute Details

#hierarchy_external_id ⇒ String? (readonly)

The external ID of the hierarchy being referenced.

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

Returns:

  • (String, nil)

See Also:



1525
1526
1527
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1525

def hierarchy_external_id
  @hierarchy_external_id
end

#hierarchy_id ⇒ String? (readonly)

The ID of the hierarchy to query for the property ID.

You can use the hierarchy's name instead of the hierarchy's ID. If the hierarchy has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same property_id . For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the AWS IoT SiteWise User Guide .

Returns:

  • (String, nil)

See Also:



1534
1535
1536
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1534

def hierarchy_id
  @hierarchy_id
end

#hierarchy_logical_id ⇒ String? (readonly)

The LogicalID of the hierarchy to query for the PropertyLogicalID .

You use a hierarchy_logical_id instead of a model ID because you can have several hierarchies using the same model and therefore the same property. For example, you might have separately grouped assets that come from the same asset model. For more information, see Defining relationships between asset models (hierarchies) in the AWS IoT SiteWise User Guide .

Returns:

  • (String, nil)

See Also:



1541
1542
1543
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1541

def hierarchy_logical_id
  @hierarchy_logical_id
end

#property_external_id ⇒ String? (readonly)

The external ID of the property being referenced.

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

Returns:

  • (String, nil)

See Also:



1548
1549
1550
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1548

def property_external_id
  @property_external_id
end

#property_id ⇒ String? (readonly)

The ID of the property to use as the variable.

You can use the property name if it's from the same asset model. If the property has an external ID, you can specify externalId: followed by the external ID. For more information, see Using external IDs in the AWS IoT SiteWise User Guide .

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

Returns:

  • (String, nil)

See Also:



1557
1558
1559
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1557

def property_id
  @property_id
end

#property_logical_id ⇒ String? (readonly)

The LogicalID of the property that is being referenced.

Returns:

  • (String, nil)

See Also:



1562
1563
1564
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1562

def property_logical_id
  @property_logical_id
end

#property_path ⇒ AWSCDK::IResolvable, ... (readonly)

The path of the property.

Each step of the path is the name of the step. See the following example:

PropertyPath: Name: AssetModelName Name: Composite1 Name: NestedComposite

Returns:

See Also:



1571
1572
1573
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1571

def property_path
  @property_path
end

Class Method Details

.jsii_properties ⇒ Object 



1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1573

def self.jsii_properties
  {
    :hierarchy_external_id => "hierarchyExternalId",
    :hierarchy_id => "hierarchyId",
    :hierarchy_logical_id => "hierarchyLogicalId",
    :property_external_id => "propertyExternalId",
    :property_id => "propertyId",
    :property_logical_id => "propertyLogicalId",
    :property_path => "propertyPath",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
 
# File 'io_t_site_wise/cfn_asset_model.rb', line 1585

def to_jsii
  result = {}
  result.merge!({
    "hierarchyExternalId" => @hierarchy_external_id,
    "hierarchyId" => @hierarchy_id,
    "hierarchyLogicalId" => @hierarchy_logical_id,
    "propertyExternalId" => @property_external_id,
    "propertyId" => @property_id,
    "propertyLogicalId" => @property_logical_id,
    "propertyPath" => @property_path,
  })
  result.compact
end