AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::IoTFleetWise::Campaign

CfnCampaign

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](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/campaigns.html) 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](https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html) in the *AWS IoT FleetWise Developer Guide* .

Import

import { CfnCampaign } from 'aws-cdk-lib/aws-iotfleetwise';

Or use the module namespace:

import * as iotfleetwise from 'aws-cdk-lib/aws-iotfleetwise';
// iotfleetwise.CfnCampaign

Properties

Configuration passed to the constructor as CfnCampaignProps.

collectionSchemeRequired
IResolvable | CollectionSchemeProperty

The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

nameRequired
string

The name of a campaign.

signalCatalogArnRequired
string

The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.

targetArnRequired
string

The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

actionOptional
string

Specifies how to update a campaign. The action can be one of the following:. - `APPROVE` - To approve delivering a data collection scheme to vehicles. - `SUSPEND` - To suspend collecting signal data. The campaign is deleted from vehicles and all vehicles in the suspended campaign will stop sending data. - `RESUME` - To reactivate the `SUSPEND` campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data. - `UPDATE` - To update a campaign.

compressionOptional
string

Whether to compress signals before transmitting data to AWS IoT FleetWise . If you don't want to compress the signals, use `OFF` . If it's not specified, `SNAPPY` is used. Default: `SNAPPY`

Default: - "OFF"

dataDestinationConfigsOptional
IResolvable | IResolvable | DataDestinationConfigProperty[]

The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream . Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. AWS IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple AWS IoT FleetWise servers for redundancy and high availability. You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.

dataExtraDimensionsOptional
string[]

A list of vehicle attributes to associate with a campaign. Enrich the data with specified vehicle attributes. For example, add `make` and `model` to the campaign, and AWS IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream . You can then query the data against `make` and `model` . Default: An empty array

dataPartitionsOptional
IResolvable | IResolvable | DataPartitionProperty[]

The data partitions associated with the signals collected from the vehicle.

descriptionOptional
string

The description of the campaign.

diagnosticsModeOptional
string

Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . If you want to send diagnostic trouble codes, use `SEND_ACTIVE_DTCS` . If it's not specified, `OFF` is used. Default: `OFF`

Default: - "OFF"

expiryTimeOptional
string

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC)

Default: - "253402214400"

postTriggerCollectionDurationOptional
number

How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, `0` is used. Default: `0`

Default: - 0

priorityOptional
number

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, `0` is used. Default: `0`

Default: - 0

signalsToCollectOptional
IResolvable | IResolvable | SignalInformationProperty[]

A list of information about signals to collect.

signalsToFetchOptional
IResolvable | IResolvable | SignalFetchInformationProperty[]

A list of information about signals to fetch.

spoolingModeOptional
string

Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to AWS IoT FleetWise . If you want to store collected data when a vehicle loses connection with the cloud, use `TO_DISK` . If it's not specified, `OFF` is used. Default: `OFF`

Default: - "OFF"

startTimeOptional
string

The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, `0` is used. Default: `0`

Default: - "0"

tagsOptional
CfnTag[]

Metadata that can be used to manage the campaign.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::IoTFleetWise::CampaignView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-iotfleetwise
CFN TypeAWS::IoTFleetWise::Campaign
Properties19

Related Constructs

Explore This Service

External Links