Package software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise

Class CfnCampaignPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise.CfnCampaignPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:00.393Z")
@Stability(Stable)
public class CfnCampaignPropsMixin
extends Mixin
implements software.constructs.IMixin

Creates an orchestration of data collection rules.

The AWS IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, AWS IoT FleetWise automatically deploys them to vehicles.

For more information, see Campaigns in the AWS IoT FleetWise Developer Guide .

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 .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnCampaignPropsMixin cfnCampaignPropsMixin = CfnCampaignPropsMixin.Builder.create(CfnCampaignMixinProps.builder()
         .action("action")
         .collectionScheme(CollectionSchemeProperty.builder()
                 .conditionBasedCollectionScheme(ConditionBasedCollectionSchemeProperty.builder()
                         .conditionLanguageVersion(123)
                         .expression("expression")
                         .minimumTriggerIntervalMs(123)
                         .triggerMode("triggerMode")
                         .build())
                 .timeBasedCollectionScheme(TimeBasedCollectionSchemeProperty.builder()
                         .periodMs(123)
                         .build())
                 .build())
         .compression("compression")
         .dataDestinationConfigs(List.of(DataDestinationConfigProperty.builder()
                 .mqttTopicConfig(MqttTopicConfigProperty.builder()
                         .executionRoleArn("executionRoleArn")
                         .mqttTopicArn("mqttTopicArn")
                         .build())
                 .s3Config(S3ConfigProperty.builder()
                         .bucketArn("bucketArn")
                         .dataFormat("dataFormat")
                         .prefix("prefix")
                         .storageCompressionFormat("storageCompressionFormat")
                         .build())
                 .timestreamConfig(TimestreamConfigProperty.builder()
                         .executionRoleArn("executionRoleArn")
                         .timestreamTableArn("timestreamTableArn")
                         .build())
                 .build()))
         .dataExtraDimensions(List.of("dataExtraDimensions"))
         .dataPartitions(List.of(DataPartitionProperty.builder()
                 .id("id")
                 .storageOptions(DataPartitionStorageOptionsProperty.builder()
                         .maximumSize(StorageMaximumSizeProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .minimumTimeToLive(StorageMinimumTimeToLiveProperty.builder()
                                 .unit("unit")
                                 .value(123)
                                 .build())
                         .storageLocation("storageLocation")
                         .build())
                 .uploadOptions(DataPartitionUploadOptionsProperty.builder()
                         .conditionLanguageVersion(123)
                         .expression("expression")
                         .build())
                 .build()))
         .description("description")
         .diagnosticsMode("diagnosticsMode")
         .expiryTime("expiryTime")
         .name("name")
         .postTriggerCollectionDuration(123)
         .priority(123)
         .signalCatalogArn("signalCatalogArn")
         .signalsToCollect(List.of(SignalInformationProperty.builder()
                 .dataPartitionId("dataPartitionId")
                 .maxSampleCount(123)
                 .minimumSamplingIntervalMs(123)
                 .name("name")
                 .build()))
         .signalsToFetch(List.of(SignalFetchInformationProperty.builder()
                 .actions(List.of("actions"))
                 .conditionLanguageVersion(123)
                 .fullyQualifiedName("fullyQualifiedName")
                 .signalFetchConfig(SignalFetchConfigProperty.builder()
                         .conditionBased(ConditionBasedSignalFetchConfigProperty.builder()
                                 .conditionExpression("conditionExpression")
                                 .triggerMode("triggerMode")
                                 .build())
                         .timeBased(TimeBasedSignalFetchConfigProperty.builder()
                                 .executionFrequencyMs(123)
                                 .build())
                         .build())
                 .build()))
         .spoolingMode("spoolingMode")
         .startTime("startTime")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetArn("targetArn")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnCampaignPropsMixin.Builder	A fluent builder for CfnCampaignPropsMixin.
static interface	CfnCampaignPropsMixin.CollectionSchemeProperty	Specifies what data to collect and how often or when to collect it.
static interface	CfnCampaignPropsMixin.ConditionBasedCollectionSchemeProperty	Information about a collection scheme that uses a simple logical expression to recognize what data to collect.
static interface	CfnCampaignPropsMixin.ConditionBasedSignalFetchConfigProperty	Specifies the condition under which a signal fetch occurs.
static interface	CfnCampaignPropsMixin.DataDestinationConfigProperty	The destination where the AWS IoT FleetWise campaign sends data.
static interface	CfnCampaignPropsMixin.DataPartitionProperty	The configuration for signal data storage and upload options.
static interface	CfnCampaignPropsMixin.DataPartitionStorageOptionsProperty	Size, time, and location options for the data partition.
static interface	CfnCampaignPropsMixin.DataPartitionUploadOptionsProperty	The upload options for the data partition.
static interface	CfnCampaignPropsMixin.MqttTopicConfigProperty	The MQTT topic to which the AWS IoT FleetWise campaign routes data.
static interface	CfnCampaignPropsMixin.S3ConfigProperty	The Amazon S3 bucket where the AWS IoT FleetWise campaign sends data.
static interface	CfnCampaignPropsMixin.SignalFetchConfigProperty	The configuration of the signal fetch operation.
static interface	CfnCampaignPropsMixin.SignalFetchInformationProperty	Information about the signal to be fetched.
static interface	CfnCampaignPropsMixin.SignalInformationProperty	Information about a signal.
static interface	CfnCampaignPropsMixin.StorageMaximumSizeProperty	The maximum storage size for the data partition.
static interface	CfnCampaignPropsMixin.StorageMinimumTimeToLiveProperty	Information about the minimum amount of time that data will be kept.
static interface	CfnCampaignPropsMixin.TimeBasedCollectionSchemeProperty	Information about a collection scheme that uses a time period to decide how often to collect data.
static interface	CfnCampaignPropsMixin.TimeBasedSignalFetchConfigProperty	Used to configure a frequency-based vehicle signal fetch.
static interface	CfnCampaignPropsMixin.TimestreamConfigProperty	The Amazon Timestream table where the AWS IoT FleetWise campaign sends data.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnCampaignPropsMixin(CfnCampaignMixinProps props)	Create a mixin to apply properties to AWS::IoTFleetWise::Campaign.
	CfnCampaignPropsMixin(CfnCampaignMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::IoTFleetWise::Campaign.
protected	CfnCampaignPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnCampaignPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnCampaignMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnCampaignPropsMixin

protected CfnCampaignPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnCampaignPropsMixin

protected CfnCampaignPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnCampaignPropsMixin

@Stability(Stable)
public CfnCampaignPropsMixin(@NotNull
 CfnCampaignMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::IoTFleetWise::Campaign.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnCampaignPropsMixin

@Stability(Stable)
public CfnCampaignPropsMixin(@NotNull
 CfnCampaignMixinProps props)

Create a mixin to apply properties to AWS::IoTFleetWise::Campaign.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnCampaignMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()