All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnCampaignProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.842Z") @Stability(Stable) public interface CfnCampaignProps extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCampaign.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iotfleetwise.*;
 CfnCampaignProps cfnCampaignProps = CfnCampaignProps.builder()
         .action("action")
         .collectionScheme(CollectionSchemeProperty.builder()
                 .conditionBasedCollectionScheme(ConditionBasedCollectionSchemeProperty.builder()
                         .expression("expression")
                         // the properties below are optional
                         .conditionLanguageVersion(123)
                         .minimumTriggerIntervalMs(123)
                         .triggerMode("triggerMode")
                         .build())
                 .timeBasedCollectionScheme(TimeBasedCollectionSchemeProperty.builder()
                         .periodMs(123)
                         .build())
                 .build())
         .name("name")
         .signalCatalogArn("signalCatalogArn")
         .targetArn("targetArn")
         // the properties below are optional
         .compression("compression")
         .dataDestinationConfigs(List.of(DataDestinationConfigProperty.builder()
                 .s3Config(S3ConfigProperty.builder()
                         .bucketArn("bucketArn")
                         // the properties below are optional
                         .dataFormat("dataFormat")
                         .prefix("prefix")
                         .storageCompressionFormat("storageCompressionFormat")
                         .build())
                 .timestreamConfig(TimestreamConfigProperty.builder()
                         .executionRoleArn("executionRoleArn")
                         .timestreamTableArn("timestreamTableArn")
                         .build())
                 .build()))
         .dataExtraDimensions(List.of("dataExtraDimensions"))
         .description("description")
         .diagnosticsMode("diagnosticsMode")
         .expiryTime("expiryTime")
         .postTriggerCollectionDuration(123)
         .priority(123)
         .signalsToCollect(List.of(SignalInformationProperty.builder()
                 .name("name")
                 // the properties below are optional
                 .maxSampleCount(123)
                 .minimumSamplingIntervalMs(123)
                 .build()))
         .spoolingMode("spoolingMode")
         .startTime("startTime")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnCampaignProps.Builder

A builder for CfnCampaignProps

static final class

CfnCampaignProps.Jsii$Proxy

An implementation for CfnCampaignProps
Method Summary

Modifier and Type

Method

Description

static CfnCampaignProps.Builder

builder()

String

getAction()

Specifies how to update a campaign.

Object

getCollectionScheme()

The data collection scheme associated with the campaign.

default String

getCompression()

(Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise .

default Object

getDataDestinationConfigs()

(Optional) The destination where the campaign sends data.

default List<String>

getDataExtraDimensions()

(Optional) A list of vehicle attributes to associate with a campaign.

default String

getDescription()

(Optional) The description of the campaign.

default String

getDiagnosticsMode()

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

default String

getExpiryTime()

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

String

getName()

The name of a campaign.

default Number

getPostTriggerCollectionDuration()

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

default Number

getPriority()

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

String

getSignalCatalogArn()

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

default Object

getSignalsToCollect()

(Optional) A list of information about signals to collect.

default String

getSpoolingMode()

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

default String

getStartTime()

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

default List<CfnTag>

getTags()

(Optional) Metadata that can be used to manage the campaign.

String

getTargetArn()

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getAction
  
  @Stability(Stable) @NotNull String getAction()
  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.
- getCollectionScheme
  
  @Stability(Stable) @NotNull Object getCollectionScheme()
  
  The data collection scheme associated with the campaign.
  You can specify a scheme that collects data based on time or an event.
- getName
  
  @Stability(Stable) @NotNull String getName()
  
  The name of a campaign.
- getSignalCatalogArn
  
  @Stability(Stable) @NotNull String getSignalCatalogArn()
  
  The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
- getTargetArn
  
  @Stability(Stable) @NotNull String getTargetArn()
  
  The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
- getCompression
  
  @Stability(Stable) @Nullable default String getCompression()
  
  (Optional) 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
- getDataDestinationConfigs
  
  @Stability(Stable) @Nullable default Object getDataDestinationConfigs()
  
  (Optional) 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.
- getDataExtraDimensions
  
  @Stability(Stable) @Nullable default List<String> getDataExtraDimensions()
  
  (Optional) 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
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  (Optional) The description of the campaign.
- getDiagnosticsMode
  
  @Stability(Stable) @Nullable default String getDiagnosticsMode()
  
  (Optional) 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
- getExpiryTime
  
  @Stability(Stable) @Nullable default String getExpiryTime()
  
  (Optional) 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)
- getPostTriggerCollectionDuration
  
  @Stability(Stable) @Nullable default Number getPostTriggerCollectionDuration()
  
  (Optional) 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
- getPriority
  
  @Stability(Stable) @Nullable default Number getPriority()
  
  (Optional) 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
- getSignalsToCollect
  
  @Stability(Stable) @Nullable default Object getSignalsToCollect()
  
  (Optional) A list of information about signals to collect.
- getSpoolingMode
  
  @Stability(Stable) @Nullable default String getSpoolingMode()
  
  (Optional) 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
- getStartTime
  
  @Stability(Stable) @Nullable default String getStartTime()
  
  (Optional) The time, in milliseconds, to deliver a campaign after it was approved.
  If it's not specified, 0 is used.
  Default: 0
- getTags
  
  @Stability(Stable) @Nullable default List<CfnTag> getTags()
  
  (Optional) Metadata that can be used to manage the campaign.
- builder
  
  @Stability(Stable) static CfnCampaignProps.Builder builder()
  
  Returns:
  
  a CfnCampaignProps.Builder of CfnCampaignProps

Interface CfnCampaignProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAction

getCollectionScheme

getName

getSignalCatalogArn

getTargetArn

getCompression

getDataDestinationConfigs

getDataExtraDimensions

getDescription

getDiagnosticsMode

getExpiryTime

getPostTriggerCollectionDuration

getPriority

getSignalsToCollect

getSpoolingMode

getStartTime

getTags

builder