Class: AWSCDK::IoTFleetWise::CfnCampaign::SignalInformationProperty

Inherits:

Jsii::Struct

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

Defined in:

io_t_fleet_wise/cfn_campaign.rb

Overview

Information about a signal.

See Also:

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

Instance Attribute Summary

• #data_partition_id ⇒ String^? readonly

  The ID of the data partition this signal is associated with.

• #max_sample_count ⇒ Numeric^? readonly

  The maximum number of samples to collect.

• #minimum_sampling_interval_ms ⇒ Numeric^? readonly

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

• #name ⇒ String readonly

  The name of the signal.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name:, data_partition_id: nil, max_sample_count: nil, minimum_sampling_interval_ms: nil) ⇒ SignalInformationProperty constructor

  A new instance of SignalInformationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name:, data_partition_id: nil, max_sample_count: nil, minimum_sampling_interval_ms: nil) ⇒ SignalInformationProperty

Returns a new instance of SignalInformationProperty.

Parameters:

• name (String) —

  The name of the signal.

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

  The ID of the data partition this signal is associated with.

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

  The maximum number of samples to collect.

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

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

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

def initialize(name:, data_partition_id: nil, max_sample_count: nil, minimum_sampling_interval_ms: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @data_partition_id = data_partition_id
  Jsii::Type.check_type(@data_partition_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataPartitionId") unless @data_partition_id.nil?
  @max_sample_count = max_sample_count
  Jsii::Type.check_type(@max_sample_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxSampleCount") unless @max_sample_count.nil?
  @minimum_sampling_interval_ms = minimum_sampling_interval_ms
  Jsii::Type.check_type(@minimum_sampling_interval_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "minimumSamplingIntervalMs") unless @minimum_sampling_interval_ms.nil?
end

Instance Attribute Details

#data_partition_id ⇒ String^? (readonly)

The ID of the data partition this signal is associated with.

The ID must match one of the IDs provided in data_partitions . This is accomplished either by specifying a particular data partition ID or by using default for an established default partition. You can establish a default partition in the DataPartition data type.

If you upload a signal as a condition for a campaign's data partition, the same signal must be included in signals_to_collect . > Access to certain AWS IoT FleetWise features is currently gated. For more information, see AWS Region and feature availability in the AWS IoT FleetWise Developer Guide .

Returns:

• (String, nil)

See Also:

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

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

def data_partition_id
  @data_partition_id
end

#max_sample_count ⇒ Numeric^? (readonly)

The maximum number of samples to collect.

Returns:

• (Numeric, nil)

See Also:

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

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

def max_sample_count
  @max_sample_count
end

#minimum_sampling_interval_ms ⇒ Numeric^? (readonly)

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

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-signalinformation.html#cfn-iotfleetwise-campaign-signalinformation-minimumsamplingintervalms

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

def minimum_sampling_interval_ms
  @minimum_sampling_interval_ms
end

#name ⇒ String (readonly)

The name of the signal.

Returns:

• (String)

See Also:

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

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

def name
  @name
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :name => "name",
    :data_partition_id => "dataPartitionId",
    :max_sample_count => "maxSampleCount",
    :minimum_sampling_interval_ms => "minimumSamplingIntervalMs",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "dataPartitionId" => @data_partition_id,
    "maxSampleCount" => @max_sample_count,
    "minimumSamplingIntervalMs" => @minimum_sampling_interval_ms,
  })
  result.compact
end