AWS::IoTFleetWise::Campaign - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::IoTFleetWise::Campaign

Creates an orchestration of data collection rules. The Amazon 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, Amazon IoT FleetWise automatically deploys them to vehicles.

For more information, see Collect and transfer data with campaigns in the Amazon IoT FleetWise Developer Guide.

Syntax

To declare this entity in your Amazon 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

Not currently supported by Amazon CloudFormation.

Required: Yes

Type: String

Update requires: No interruption

CollectionScheme

Not currently supported by Amazon CloudFormation.

Required: Yes

Type: CollectionScheme

Update requires: Replacement

Compression

Not currently supported by Amazon CloudFormation.

Required: No

Type: String

Update requires: Replacement

DataExtraDimensions

Not currently supported by Amazon CloudFormation.

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

Not currently supported by Amazon CloudFormation.

Required: No

Type: String

Update requires: Replacement

ExpiryTime

Not currently supported by Amazon CloudFormation.

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

Not currently supported by Amazon CloudFormation.

Required: No

Type: Double

Update requires: Replacement

Priority

Not currently supported by Amazon CloudFormation.

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

Not currently supported by Amazon CloudFormation.

Required: No

Type: List of SignalInformation

Update requires: No interruption

SpoolingMode

Not currently supported by Amazon CloudFormation.

Required: No

Type: String

Update requires: Replacement

StartTime

Not currently supported by Amazon CloudFormation.

Required: No

Type: String

Update requires: Replacement

Tags

Not currently supported by Amazon CloudFormation.

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

Not currently supported by Amazon CloudFormation.

CreationTime

Not currently supported by Amazon CloudFormation.

LastModificationTime

Not currently supported by Amazon CloudFormation.

Status

Not currently supported by Amazon CloudFormation.