AWS::IoTFleetWise::Campaign

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 Collect and transfer data with campaigns in the AWS IoT FleetWise Developer Guide.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::IoTFleetWise::Campaign", "Properties" : { "Action" : String, "CollectionScheme" : CollectionScheme, "Compression" : String, "DataExtraDimensions" : [ String, ... ], "Description" : String, "DiagnosticsMode" : String, "ExpiryTime" : String, "Name" : String, "PostTriggerCollectionDuration" : Double, "Priority" : Integer, "SignalCatalogArn" : String, "SignalsToCollect" : [ SignalInformation, ... ], "SpoolingMode" : String, "StartTime" : String, "Tags" : [ Tag, ... ], "TargetArn" : String } }

YAML

Type: AWS::IoTFleetWise::Campaign Properties: Action: String CollectionScheme: CollectionScheme Compression: String DataExtraDimensions: - String Description: String DiagnosticsMode: String ExpiryTime: String Name: String PostTriggerCollectionDuration: Double Priority: Integer SignalCatalogArn: String SignalsToCollect: - SignalInformation SpoolingMode: String StartTime: String Tags: - Tag TargetArn: String

Properties

Action

Property description not available.

Required: Yes

Type: String

Update requires: No interruption

CollectionScheme

Property description not available.

Required: Yes

Type: CollectionScheme

Update requires: Replacement

Compression

Property description not available.

Required: No

Type: String

Update requires: Replacement

DataExtraDimensions

Property description not available.

Required: No

Type: List of String

Update requires: No interruption

Description

The description of the campaign.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: [^\u0000-\u001F\u007F]+

Update requires: No interruption

DiagnosticsMode

Property description not available.

Required: No

Type: String

Update requires: Replacement

ExpiryTime

Property description not available.

Required: No

Type: String

Update requires: Replacement

Name

The name of a campaign.

Required: Yes

Type: String

Minimum: 1

Maximum: 100

Pattern: [a-zA-Z\d\-_:]+

Update requires: Replacement

PostTriggerCollectionDuration

Property description not available.

Required: No

Type: Double

Update requires: Replacement

Priority

Property description not available.

Required: No

Type: Integer

Update requires: Replacement

SignalCatalogArn

The ARN of the signal catalog associated with the campaign.

Required: Yes

Type: String

Update requires: Replacement

SignalsToCollect

Property description not available.

Required: No

Type: List of SignalInformation

Update requires: No interruption

SpoolingMode

Property description not available.

Required: No

Type: String

Update requires: Replacement

StartTime

Property description not available.

Required: No

Type: String

Update requires: Replacement

Tags

Property description not available.

Required: No

Type: List of Tag

Update requires: No interruption

TargetArn

The ARN of a vehicle or fleet to which the campaign is deployed.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

Fn::GetAtt

Arn

Property description not available.

CreationTime

Property description not available.

LastModificationTime

Property description not available.

Status

Property description not available.