interface SignalInformationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.IoTFleetWise.CfnCampaign.SignalInformationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsiotfleetwise#CfnCampaign_SignalInformationProperty`
Java	`software.amazon.awscdk.services.iotfleetwise.CfnCampaign.SignalInformationProperty`
Python	`aws_cdk.aws_iotfleetwise.CfnCampaign.SignalInformationProperty`
TypeScript	`aws-cdk-lib` » `aws_iotfleetwise` » `CfnCampaign` » `SignalInformationProperty`

Information about a signal.

Example

// 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

Name	Type	Description
name	`string`	The name of the signal.
dataPartitionId?	`string`	The ID of the data partition this signal is associated with.
maxSampleCount?	`number`	The maximum number of samples to collect.
minimumSamplingIntervalMs?	`number`	The minimum duration of time (in milliseconds) between two triggering events to collect data.

name

Type: string

The name of the signal.

dataPartitionId?

Type: string (optional)

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

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 .

maxSampleCount?

Type: number (optional)

The maximum number of samples to collect.

minimumSamplingIntervalMs?

Type: number (optional)

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.