Class CfnCampaign.SignalInformationProperty.Builder
java.lang.Object
software.amazon.awscdk.services.iotfleetwise.CfnCampaign.SignalInformationProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCampaign.SignalInformationProperty>
- Enclosing interface:
CfnCampaign.SignalInformationProperty
@Stability(Stable)
public static final class CfnCampaign.SignalInformationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCampaign.SignalInformationProperty>
A builder for
CfnCampaign.SignalInformationProperty
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.dataPartitionId
(String dataPartitionId) Sets the value ofCfnCampaign.SignalInformationProperty.getDataPartitionId()
maxSampleCount
(Number maxSampleCount) Sets the value ofCfnCampaign.SignalInformationProperty.getMaxSampleCount()
minimumSamplingIntervalMs
(Number minimumSamplingIntervalMs) Sets the value ofCfnCampaign.SignalInformationProperty.getMinimumSamplingIntervalMs()
Sets the value ofCfnCampaign.SignalInformationProperty.getName()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
name
Sets the value ofCfnCampaign.SignalInformationProperty.getName()
- Parameters:
name
- The name of the signal. This parameter is required.- Returns:
this
-
dataPartitionId
@Stability(Stable) public CfnCampaign.SignalInformationProperty.Builder dataPartitionId(String dataPartitionId) Sets the value ofCfnCampaign.SignalInformationProperty.getDataPartitionId()
- Parameters:
dataPartitionId
- The ID of the data partition this signal is associated with. The ID must match one of the IDs provided indataPartitions
. This is accomplished either by specifying a particular data partition ID or by usingdefault
for an established default partition. You can establish a default partition in theDataPartition
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 .- Returns:
this
-
maxSampleCount
@Stability(Stable) public CfnCampaign.SignalInformationProperty.Builder maxSampleCount(Number maxSampleCount) Sets the value ofCfnCampaign.SignalInformationProperty.getMaxSampleCount()
- Parameters:
maxSampleCount
- The maximum number of samples to collect.- Returns:
this
-
minimumSamplingIntervalMs
@Stability(Stable) public CfnCampaign.SignalInformationProperty.Builder minimumSamplingIntervalMs(Number minimumSamplingIntervalMs) Sets the value ofCfnCampaign.SignalInformationProperty.getMinimumSamplingIntervalMs()
- Parameters:
minimumSamplingIntervalMs
- 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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCampaign.SignalInformationProperty>
- Returns:
- a new instance of
CfnCampaign.SignalInformationProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-