Class: AWSCDK::IoTFleetWise::CfnSignalCatalog::BranchProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::IoTFleetWise::CfnSignalCatalog::BranchProperty

Defined in:

io_t_fleet_wise/cfn_signal_catalog.rb

Overview

A group of signals that are defined in a hierarchical structure.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html

Instance Attribute Summary

• #description ⇒ String^? readonly

  A brief description of the branch.

• #fully_qualified_name ⇒ String readonly

  The fully qualified name of the branch.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(fully_qualified_name:, description: nil) ⇒ BranchProperty constructor

  A new instance of BranchProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(fully_qualified_name:, description: nil) ⇒ BranchProperty

Returns a new instance of BranchProperty.

Parameters:

• fully_qualified_name (String) —

  The fully qualified name of the branch.

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

  A brief description of the branch.

# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 853

def initialize(fully_qualified_name:, description: nil)
  @fully_qualified_name = fully_qualified_name
  Jsii::Type.check_type(@fully_qualified_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fullyQualifiedName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
end

Instance Attribute Details

#description ⇒ String^? (readonly)

A brief description of the branch.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-description

# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 871

def description
  @description
end

#fully_qualified_name ⇒ String (readonly)

The fully qualified name of the branch.

For example, the fully qualified name of a branch might be Vehicle.Body.Engine .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-signalcatalog-branch.html#cfn-iotfleetwise-signalcatalog-branch-fullyqualifiedname

# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 866

def fully_qualified_name
  @fully_qualified_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 873

def self.jsii_properties
  {
    :fully_qualified_name => "fullyQualifiedName",
    :description => "description",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'io_t_fleet_wise/cfn_signal_catalog.rb', line 880

def to_jsii
  result = {}
  result.merge!({
    "fullyQualifiedName" => @fully_qualified_name,
    "description" => @description,
  })
  result.compact
end