Skip to content
v2.274.0

SignalInformationProperty Struct ​

Information about a signal.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_iotfleetwise as iotfleetwise } from 'aws-cdk-lib';
const signalInformationProperty: iotfleetwise.CfnCampaign.SignalInformationProperty = {
  name: 'name',

  // the properties below are optional
  dataPartitionId: 'dataPartitionId',
  maxSampleCount: 123,
  minimumSamplingIntervalMs: 123,
};

Properties ​

dataPartitionIdoptionalstringdata_partition_idoptionalstrdataPartitionIdoptionalStringDataPartitionIdoptionalstringDataPartitionIdoptional*string#
The ID of the data partition this signal is associated with.
notes

The ID must match one of the IDs provided in dataPartitions . 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 signalsToCollect . > 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 .

maxSampleCountoptionalnumbermax_sample_countoptionalint | floatmaxSampleCountoptionalNumberMaxSampleCountoptionaldoubleMaxSampleCountoptional*float64#
The maximum number of samples to collect.
minimumSamplingIntervalMsoptionalnumberminimum_sampling_interval_msoptionalint | floatminimumSamplingIntervalMsoptionalNumberMinimumSamplingIntervalMsoptionaldoubleMinimumSamplingIntervalMsoptional*float64#
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.

namestringnamestrnameStringNamestringName*stringrequired#
The name of the signal.