Class: AWSCDK::IoTFleetWise::CfnCampaign::ConditionBasedCollectionSchemeProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::IoTFleetWise::CfnCampaign::ConditionBasedCollectionSchemeProperty

Defined in:

io_t_fleet_wise/cfn_campaign.rb

Overview

Information about a collection scheme that uses a simple logical expression to recognize what data to collect.

See Also:

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

Instance Attribute Summary

• #condition_language_version ⇒ Numeric^? readonly

  Specifies the version of the conditional expression language.

• #expression ⇒ String readonly

  The logical expression used to recognize what data to collect.

• #minimum_trigger_interval_ms ⇒ Numeric^? readonly

  The minimum duration of time between two triggering events to collect data, in milliseconds.

• #trigger_mode ⇒ String^? readonly

  Whether to collect data for all triggering events ( ALWAYS ).

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(expression:, condition_language_version: nil, minimum_trigger_interval_ms: nil, trigger_mode: nil) ⇒ ConditionBasedCollectionSchemeProperty constructor

  A new instance of ConditionBasedCollectionSchemeProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(expression:, condition_language_version: nil, minimum_trigger_interval_ms: nil, trigger_mode: nil) ⇒ ConditionBasedCollectionSchemeProperty

Returns a new instance of ConditionBasedCollectionSchemeProperty.

Parameters:

• expression (String) —

  The logical expression used to recognize what data to collect.

• condition_language_version (Numeric, nil) (defaults to: nil) —

  Specifies the version of the conditional expression language.

• minimum_trigger_interval_ms (Numeric, nil) (defaults to: nil) —

  The minimum duration of time between two triggering events to collect data, in milliseconds.

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

  Whether to collect data for all triggering events ( ALWAYS ).

# File 'io_t_fleet_wise/cfn_campaign.rb', line 860

def initialize(expression:, condition_language_version: nil, minimum_trigger_interval_ms: nil, trigger_mode: nil)
  @expression = expression
  Jsii::Type.check_type(@expression, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "expression")
  @condition_language_version = condition_language_version
  Jsii::Type.check_type(@condition_language_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "conditionLanguageVersion") unless @condition_language_version.nil?
  @minimum_trigger_interval_ms = minimum_trigger_interval_ms
  Jsii::Type.check_type(@minimum_trigger_interval_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimumTriggerIntervalMs") unless @minimum_trigger_interval_ms.nil?
  @trigger_mode = trigger_mode
  Jsii::Type.check_type(@trigger_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "triggerMode") unless @trigger_mode.nil?
end

Instance Attribute Details

#condition_language_version ⇒ Numeric^? (readonly)

Specifies the version of the conditional expression language.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-conditionlanguageversion

# File 'io_t_fleet_wise/cfn_campaign.rb', line 882

def condition_language_version
  @condition_language_version
end

#expression ⇒ String (readonly)

The logical expression used to recognize what data to collect.

For example, $variable.Vehicle.OutsideAirTemperature >= 105.0 .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-expression

# File 'io_t_fleet_wise/cfn_campaign.rb', line 877

def expression
  @expression
end

#minimum_trigger_interval_ms ⇒ Numeric^? (readonly)

The minimum duration of time between two triggering events to collect data, in milliseconds.

If a signal changes often, you might want to collect data at a slower rate.

Returns:

• (Numeric, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-minimumtriggerintervalms

# File 'io_t_fleet_wise/cfn_campaign.rb', line 889

def minimum_trigger_interval_ms
  @minimum_trigger_interval_ms
end

#trigger_mode ⇒ String^? (readonly)

Whether to collect data for all triggering events ( ALWAYS ).

Specify ( RISING_EDGE ), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotfleetwise-campaign-conditionbasedcollectionscheme.html#cfn-iotfleetwise-campaign-conditionbasedcollectionscheme-triggermode

# File 'io_t_fleet_wise/cfn_campaign.rb', line 896

def trigger_mode
  @trigger_mode
end

Class Method Details

.jsii_properties ⇒ Object

# File 'io_t_fleet_wise/cfn_campaign.rb', line 898

def self.jsii_properties
  {
    :expression => "expression",
    :condition_language_version => "conditionLanguageVersion",
    :minimum_trigger_interval_ms => "minimumTriggerIntervalMs",
    :trigger_mode => "triggerMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'io_t_fleet_wise/cfn_campaign.rb', line 907

def to_jsii
  result = {}
  result.merge!({
    "expression" => @expression,
    "conditionLanguageVersion" => @condition_language_version,
    "minimumTriggerIntervalMs" => @minimum_trigger_interval_ms,
    "triggerMode" => @trigger_mode,
  })
  result.compact
end