Interface CfnCampaign.ISignalInformationProperty

Information about a signal.

Namespace: Amazon.CDK.AWS.IoTFleetWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ISignalInformationProperty
Syntax (vb)
Public Interface ISignalInformationProperty
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IoTFleetWise;

var signalInformationProperty = new SignalInformationProperty {
    Name = "name",

    // the properties below are optional
    DataPartitionId = "dataPartitionId",
    MaxSampleCount = 123,
    MinimumSamplingIntervalMs = 123
};

Synopsis

Properties

DataPartitionId

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

The maximum number of samples to collect.
MinimumSamplingIntervalMs

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

The name of the signal.

Properties

DataPartitionId

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

virtual string DataPartitionId { get; }
Property Value

System.String

Remarks

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 .

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

MaxSampleCount

The maximum number of samples to collect.

virtual Nullable<double> MaxSampleCount { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

MinimumSamplingIntervalMs

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

virtual Nullable<double> MinimumSamplingIntervalMs { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

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

Name

The name of the signal.

string Name { get; }
Property Value

System.String

Remarks

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