Package software.amazon.awscdk.services.iotfleetwise

Interface CfnCampaign.SignalInformationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCampaign.SignalInformationProperty.Jsii$Proxy

Enclosing class:

CfnCampaign

@Stability(Stable)
public static interface CfnCampaign.SignalInformationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.iotfleetwise.*;
 SignalInformationProperty signalInformationProperty = SignalInformationProperty.builder()
         .name("name")
         // the properties below are optional
         .dataPartitionId("dataPartitionId")
         .maxSampleCount(123)
         .minimumSamplingIntervalMs(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCampaign.SignalInformationProperty.Builder	A builder for CfnCampaign.SignalInformationProperty
static final class	CfnCampaign.SignalInformationProperty.Jsii$Proxy	An implementation for CfnCampaign.SignalInformationProperty

Method Summary

Modifier and Type	Method	Description
static CfnCampaign.SignalInformationProperty.Builder	builder()
default String	getDataPartitionId()	The ID of the data partition this signal is associated with.
default Number	getMaxSampleCount()	The maximum number of samples to collect.
default Number	getMinimumSamplingIntervalMs()	The minimum duration of time (in milliseconds) between two triggering events to collect data.
String	getName()	The name of the signal.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the signal.

See Also:

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

getDataPartitionId

@Stability(Stable)
@Nullable
default String getDataPartitionId()

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 .

See Also:

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

getMaxSampleCount

@Stability(Stable)
@Nullable
default Number getMaxSampleCount()

The maximum number of samples to collect.

See Also:

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

getMinimumSamplingIntervalMs

@Stability(Stable)
@Nullable
default Number getMinimumSamplingIntervalMs()

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.

See Also:

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

builder

@Stability(Stable)
static CfnCampaign.SignalInformationProperty.Builder builder()

Returns:

a CfnCampaign.SignalInformationProperty.Builder of CfnCampaign.SignalInformationProperty