Class CfnCampaign

Creates an orchestration of data collection rules.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnCampaign

Implements

IInspectable

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.IoTFleetWise

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnCampaign : CfnResource, IInspectable, ITaggable

Syntax (vb)

Public Class CfnCampaign Inherits CfnResource Implements IInspectable, ITaggable

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.IoTFleetWise;

             var cfnCampaign = new CfnCampaign(this, "MyCfnCampaign", new CfnCampaignProps {
                 CollectionScheme = new CollectionSchemeProperty {
                     ConditionBasedCollectionScheme = new ConditionBasedCollectionSchemeProperty {
                         Expression = "expression",

                         // the properties below are optional
                         ConditionLanguageVersion = 123,
                         MinimumTriggerIntervalMs = 123,
                         TriggerMode = "triggerMode"
                     },
                     TimeBasedCollectionScheme = new TimeBasedCollectionSchemeProperty {
                         PeriodMs = 123
                     }
                 },
                 Name = "name",
                 SignalCatalogArn = "signalCatalogArn",
                 TargetArn = "targetArn",

                 // the properties below are optional
                 Action = "action",
                 Compression = "compression",
                 DataDestinationConfigs = new [] { new DataDestinationConfigProperty {
                     MqttTopicConfig = new MqttTopicConfigProperty {
                         ExecutionRoleArn = "executionRoleArn",
                         MqttTopicArn = "mqttTopicArn"
                     },
                     S3Config = new S3ConfigProperty {
                         BucketArn = "bucketArn",

                         // the properties below are optional
                         DataFormat = "dataFormat",
                         Prefix = "prefix",
                         StorageCompressionFormat = "storageCompressionFormat"
                     },
                     TimestreamConfig = new TimestreamConfigProperty {
                         ExecutionRoleArn = "executionRoleArn",
                         TimestreamTableArn = "timestreamTableArn"
                     }
                 } },
                 DataExtraDimensions = new [] { "dataExtraDimensions" },
                 DataPartitions = new [] { new DataPartitionProperty {
                     Id = "id",
                     StorageOptions = new DataPartitionStorageOptionsProperty {
                         MaximumSize = new StorageMaximumSizeProperty {
                             Unit = "unit",
                             Value = 123
                         },
                         MinimumTimeToLive = new StorageMinimumTimeToLiveProperty {
                             Unit = "unit",
                             Value = 123
                         },
                         StorageLocation = "storageLocation"
                     },

                     // the properties below are optional
                     UploadOptions = new DataPartitionUploadOptionsProperty {
                         Expression = "expression",

                         // the properties below are optional
                         ConditionLanguageVersion = 123
                     }
                 } },
                 Description = "description",
                 DiagnosticsMode = "diagnosticsMode",
                 ExpiryTime = "expiryTime",
                 PostTriggerCollectionDuration = 123,
                 Priority = 123,
                 SignalsToCollect = new [] { new SignalInformationProperty {
                     Name = "name",

                     // the properties below are optional
                     DataPartitionId = "dataPartitionId",
                     MaxSampleCount = 123,
                     MinimumSamplingIntervalMs = 123
                 } },
                 SignalsToFetch = new [] { new SignalFetchInformationProperty {
                     Actions = new [] { "actions" },
                     FullyQualifiedName = "fullyQualifiedName",
                     SignalFetchConfig = new SignalFetchConfigProperty {
                         ConditionBased = new ConditionBasedSignalFetchConfigProperty {
                             ConditionExpression = "conditionExpression",
                             TriggerMode = "triggerMode"
                         },
                         TimeBased = new TimeBasedSignalFetchConfigProperty {
                             ExecutionFrequencyMs = 123
                         }
                     },

                     // the properties below are optional
                     ConditionLanguageVersion = 123
                 } },
                 SpoolingMode = "spoolingMode",
                 StartTime = "startTime",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnCampaign(Construct, string, ICfnCampaignProps)

Creates an orchestration of data collection rules.

Properties

Action	Specifies how to update a campaign.
AttrArn	The Amazon Resource Name (ARN) of the campaign.
AttrCreationTime	The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).
AttrLastModificationTime	The last time the campaign was modified.
AttrStatus	The state of the campaign.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates an orchestration of data collection rules.
CollectionScheme	The data collection scheme associated with the campaign.
Compression	Whether to compress signals before transmitting data to AWS IoT FleetWise .
DataDestinationConfigs	The destination where the campaign sends data.
DataExtraDimensions	A list of vehicle attributes to associate with a campaign.
DataPartitions	The data partitions associated with the signals collected from the vehicle.
Description	The description of the campaign.
DiagnosticsMode	Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
ExpiryTime	The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
Name	The name of a campaign.
PostTriggerCollectionDuration	How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
Priority	A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
SignalCatalogArn	The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
SignalsToCollect	A list of information about signals to collect.
SignalsToFetch	A list of information about signals to fetch.
SpoolingMode	Whether to store collected data after a vehicle lost a connection with the cloud.
StartTime	The time, in milliseconds, to deliver a campaign after it was approved.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Metadata that can be used to manage the campaign.
TargetArn	The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<string, object>)	Creates an orchestration of data collection rules.

Constructors

CfnCampaign(Construct, string, ICfnCampaignProps)

Creates an orchestration of data collection rules.

public CfnCampaign(Construct scope, string id, ICfnCampaignProps props)

Parameters

scope Construct

Scope in which this resource is defined.

id string

Construct identifier for this resource (unique in its scope).

props ICfnCampaignProps

Resource properties.

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Properties

Action

Specifies how to update a campaign.

public virtual string? Action { get; set; }

Property Value

string

Remarks

The action can be one of the following:.

AttrArn

The Amazon Resource Name (ARN) of the campaign.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreationTime

The time the campaign was created in seconds since epoch (January 1, 1970 at midnight UTC time).

public virtual string AttrCreationTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreationTime

AttrLastModificationTime

The last time the campaign was modified.

public virtual string AttrLastModificationTime { get; }

Property Value

string

Remarks

CloudformationAttribute: LastModificationTime

AttrStatus

The state of the campaign.

public virtual string AttrStatus { get; }

Property Value

string

Remarks

The status can be one of: CREATING , WAITING_FOR_APPROVAL , RUNNING , and SUSPENDED .

CloudformationAttribute: Status

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

CfnProperties

Creates an orchestration of data collection rules.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

CollectionScheme

The data collection scheme associated with the campaign.

public virtual object CollectionScheme { get; set; }

Property Value

object

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Compression

Whether to compress signals before transmitting data to AWS IoT FleetWise .

public virtual string? Compression { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

DataDestinationConfigs

The destination where the campaign sends data.

public virtual object? DataDestinationConfigs { get; set; }

Property Value

object

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

DataExtraDimensions

A list of vehicle attributes to associate with a campaign.

public virtual string[]? DataExtraDimensions { get; set; }

Property Value

string[]

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

DataPartitions

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

public virtual object? DataPartitions { get; set; }

Property Value

object

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Description

The description of the campaign.

public virtual string? Description { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

DiagnosticsMode

Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .

public virtual string? DiagnosticsMode { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

ExpiryTime

The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).

public virtual string? ExpiryTime { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Name

The name of a campaign.

public virtual string Name { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

PostTriggerCollectionDuration

How long (in milliseconds) to collect raw data after a triggering event initiates the collection.

public virtual double? PostTriggerCollectionDuration { get; set; }

Property Value

double?

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Priority

A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.

public virtual double? Priority { get; set; }

Property Value

double?

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

SignalCatalogArn

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

public virtual string SignalCatalogArn { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

SignalsToCollect

A list of information about signals to collect.

public virtual object? SignalsToCollect { get; set; }

Property Value

object

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

SignalsToFetch

A list of information about signals to fetch.

public virtual object? SignalsToFetch { get; set; }

Property Value

object

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

SpoolingMode

Whether to store collected data after a vehicle lost a connection with the cloud.

public virtual string? SpoolingMode { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

StartTime

The time, in milliseconds, to deliver a campaign after it was approved.

public virtual string? StartTime { get; set; }

Property Value

string

Remarks

If it's not specified, 0 is used.

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

TagsRaw

Metadata that can be used to manage the campaign.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

TargetArn

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

public virtual string TargetArn { get; set; }

Property Value

string

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates an orchestration of data collection rules.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

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 <a href="https://docs.aws.amazon.com/iot-fleetwise/latest/developerguide/fleetwise-regions.html">AWS Region and feature availability</a> in the <em>AWS IoT FleetWise Developer Guide</em> .

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

CloudformationResource: AWS::IoTFleetWise::Campaign

ExampleMetadata: fixture=_generated

Implements

IInspectable

ITaggable