Class CfnCampaignProps
Properties for defining a CfnCampaign
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.IoTFleetWise
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCampaignProps : Object, ICfnCampaignProps
Syntax (vb)
Public Class CfnCampaignProps
Inherits Object
Implements ICfnCampaignProps
Remarks
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 cfnCampaignProps = new CfnCampaignProps {
Action = "action",
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
Compression = "compression",
DataDestinationConfigs = new [] { new DataDestinationConfigProperty {
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" },
Description = "description",
DiagnosticsMode = "diagnosticsMode",
ExpiryTime = "expiryTime",
PostTriggerCollectionDuration = 123,
Priority = 123,
SignalsToCollect = new [] { new SignalInformationProperty {
Name = "name",
// the properties below are optional
MaxSampleCount = 123,
MinimumSamplingIntervalMs = 123
} },
SpoolingMode = "spoolingMode",
StartTime = "startTime",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Constructors
CfnCampaignProps() |
Properties
Action | Specifies how to update a campaign. The action can be one of the following:. |
CollectionScheme | The data collection scheme associated with the campaign. |
Compression | (Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise . |
DataDestinationConfigs | (Optional) The destination where the campaign sends data. |
DataExtraDimensions | (Optional) A list of vehicle attributes to associate with a campaign. |
Description | (Optional) The description of the campaign. |
DiagnosticsMode | (Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . |
ExpiryTime | (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). |
Name | The name of a campaign. |
PostTriggerCollectionDuration | (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. |
Priority | (Optional) 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 | (Optional) A list of information about signals to collect. |
SpoolingMode | (Optional) Whether to store collected data after a vehicle lost a connection with the cloud. |
StartTime | (Optional) The time, in milliseconds, to deliver a campaign after it was approved. |
Tags | (Optional) 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. |
Constructors
CfnCampaignProps()
public CfnCampaignProps()
Properties
Action
Specifies how to update a campaign. The action can be one of the following:.
public string Action { get; set; }
Property Value
System.String
Remarks
CollectionScheme
The data collection scheme associated with the campaign.
public object CollectionScheme { get; set; }
Property Value
System.Object
Remarks
You can specify a scheme that collects data based on time or an event.
Compression
(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .
public string Compression { get; set; }
Property Value
System.String
Remarks
If you don't want to compress the signals, use OFF
. If it's not specified, SNAPPY
is used.
Default: SNAPPY
Default: - "OFF"
DataDestinationConfigs
(Optional) The destination where the campaign sends data.
public object DataDestinationConfigs { get; set; }
Property Value
System.Object
Remarks
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.
DataExtraDimensions
(Optional) A list of vehicle attributes to associate with a campaign.
public string[] DataExtraDimensions { get; set; }
Property Value
System.String[]
Remarks
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
Description
(Optional) The description of the campaign.
public string Description { get; set; }
Property Value
System.String
Remarks
DiagnosticsMode
(Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
public string DiagnosticsMode { get; set; }
Property Value
System.String
Remarks
If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS
. If it's not specified, OFF
is used.
Default: OFF
Default: - "OFF"
ExpiryTime
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
public string ExpiryTime { get; set; }
Property Value
System.String
Remarks
Vehicle data isn't collected after the campaign expires.
Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
Default: - "253402214400"
Name
The name of a campaign.
public string Name { get; set; }
Property Value
System.String
Remarks
PostTriggerCollectionDuration
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
public Nullable<double> PostTriggerCollectionDuration { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
If it's not specified, 0
is used.
Default: 0
Default: - 0
Priority
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
public Nullable<double> Priority { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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
SignalCatalogArn
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
public string SignalCatalogArn { get; set; }
Property Value
System.String
Remarks
SignalsToCollect
(Optional) A list of information about signals to collect.
public object SignalsToCollect { get; set; }
Property Value
System.Object
Remarks
SpoolingMode
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud.
public string SpoolingMode { get; set; }
Property Value
System.String
Remarks
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"
StartTime
(Optional) The time, in milliseconds, to deliver a campaign after it was approved.
public string StartTime { get; set; }
Property Value
System.String
Remarks
If it's not specified, 0
is used.
Default: 0
Default: - "0"
Tags
(Optional) Metadata that can be used to manage the campaign.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
TargetArn
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
public string TargetArn { get; set; }
Property Value
System.String