Class CfnCampaign.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCampaign>
- Enclosing class:
CfnCampaign
CfnCampaign
.-
Method Summary
Modifier and TypeMethodDescriptionSpecifies how to update a campaign.build()
collectionScheme
(IResolvable collectionScheme) The data collection scheme associated with the campaign.collectionScheme
(CfnCampaign.CollectionSchemeProperty collectionScheme) The data collection scheme associated with the campaign.compression
(String compression) Whether to compress signals before transmitting data to AWS IoT FleetWise .static CfnCampaign.Builder
dataDestinationConfigs
(List<? extends Object> dataDestinationConfigs) The destination where the campaign sends data.dataDestinationConfigs
(IResolvable dataDestinationConfigs) The destination where the campaign sends data.dataExtraDimensions
(List<String> dataExtraDimensions) A list of vehicle attributes to associate with a campaign.dataPartitions
(List<? extends Object> dataPartitions) The data partitions associated with the signals collected from the vehicle.dataPartitions
(IResolvable dataPartitions) The data partitions associated with the signals collected from the vehicle.description
(String description) The description of the campaign.diagnosticsMode
(String diagnosticsMode) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .expiryTime
(String expiryTime) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).The name of a campaign.postTriggerCollectionDuration
(Number postTriggerCollectionDuration) How long (in milliseconds) to collect raw data after a triggering event initiates the collection.A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.signalCatalogArn
(String signalCatalogArn) The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.signalsToCollect
(List<? extends Object> signalsToCollect) A list of information about signals to collect.signalsToCollect
(IResolvable signalsToCollect) A list of information about signals to collect.signalsToFetch
(List<? extends Object> signalsToFetch) A list of information about signals to fetch.signalsToFetch
(IResolvable signalsToFetch) A list of information about signals to fetch.spoolingMode
(String spoolingMode) Whether to store collected data after a vehicle lost a connection with the cloud.The time, in milliseconds, to deliver a campaign after it was approved.Metadata that can be used to manage the campaign.The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
-
Method Details
-
create
@Stability(Stable) public static CfnCampaign.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnCampaign.Builder
.
-
collectionScheme
The data collection scheme associated with the campaign.You can specify a scheme that collects data based on time or an event.
- Parameters:
collectionScheme
- The data collection scheme associated with the campaign. This parameter is required.- Returns:
this
- See Also:
-
collectionScheme
@Stability(Stable) public CfnCampaign.Builder collectionScheme(CfnCampaign.CollectionSchemeProperty collectionScheme) The data collection scheme associated with the campaign.You can specify a scheme that collects data based on time or an event.
- Parameters:
collectionScheme
- The data collection scheme associated with the campaign. This parameter is required.- Returns:
this
- See Also:
-
name
The name of a campaign.- Parameters:
name
- The name of a campaign. This parameter is required.- Returns:
this
- See Also:
-
signalCatalogArn
The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.- Parameters:
signalCatalogArn
- The Amazon Resource Name (ARN) of the signal catalog associated with the campaign. This parameter is required.- Returns:
this
- See Also:
-
targetArn
The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.- Parameters:
targetArn
- The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed. This parameter is required.- Returns:
this
- See Also:
-
action
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 theSUSPEND
campaign. The campaign is redeployed to all vehicles and the vehicles will resume sending data.UPDATE
- To update a campaign.
- Parameters:
action
- Specifies how to update a campaign. The action can be one of the following:. This parameter is required.- Returns:
this
- See Also:
-
compression
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
Default: - "OFF"
- Parameters:
compression
- Whether to compress signals before transmitting data to AWS IoT FleetWise . This parameter is required.- Returns:
this
- See Also:
-
dataDestinationConfigs
@Stability(Stable) public CfnCampaign.Builder dataDestinationConfigs(IResolvable dataDestinationConfigs) 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.
- Parameters:
dataDestinationConfigs
- The destination where the campaign sends data. This parameter is required.- Returns:
this
- See Also:
-
dataDestinationConfigs
@Stability(Stable) public CfnCampaign.Builder dataDestinationConfigs(List<? extends Object> dataDestinationConfigs) 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.
- Parameters:
dataDestinationConfigs
- The destination where the campaign sends data. This parameter is required.- Returns:
this
- See Also:
-
dataExtraDimensions
A list of vehicle attributes to associate with a campaign.Enrich the data with specified vehicle attributes. For example, add
make
andmodel
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 againstmake
andmodel
.Default: An empty array
- Parameters:
dataExtraDimensions
- A list of vehicle attributes to associate with a campaign. This parameter is required.- Returns:
this
- See Also:
-
dataPartitions
The data partitions associated with the signals collected from the vehicle.- Parameters:
dataPartitions
- The data partitions associated with the signals collected from the vehicle. This parameter is required.- Returns:
this
- See Also:
-
dataPartitions
The data partitions associated with the signals collected from the vehicle.- Parameters:
dataPartitions
- The data partitions associated with the signals collected from the vehicle. This parameter is required.- Returns:
this
- See Also:
-
description
The description of the campaign.- Parameters:
description
- The description of the campaign. This parameter is required.- Returns:
this
- See Also:
-
diagnosticsMode
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
Default: - "OFF"
- Parameters:
diagnosticsMode
- Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . This parameter is required.- Returns:
this
- See Also:
-
expiryTime
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)
Default: - "253402214400"
- Parameters:
expiryTime
- The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). This parameter is required.- Returns:
this
- See Also:
-
postTriggerCollectionDuration
@Stability(Stable) public CfnCampaign.Builder postTriggerCollectionDuration(Number postTriggerCollectionDuration) 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
Default: - 0
- Parameters:
postTriggerCollectionDuration
- How long (in milliseconds) to collect raw data after a triggering event initiates the collection. This parameter is required.- Returns:
this
- See Also:
-
priority
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
Default: - 0
- Parameters:
priority
- A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. This parameter is required.- Returns:
this
- See Also:
-
signalsToCollect
A list of information about signals to collect.- Parameters:
signalsToCollect
- A list of information about signals to collect. This parameter is required.- Returns:
this
- See Also:
-
signalsToCollect
@Stability(Stable) public CfnCampaign.Builder signalsToCollect(List<? extends Object> signalsToCollect) A list of information about signals to collect.- Parameters:
signalsToCollect
- A list of information about signals to collect. This parameter is required.- Returns:
this
- See Also:
-
signalsToFetch
A list of information about signals to fetch.- Parameters:
signalsToFetch
- A list of information about signals to fetch. This parameter is required.- Returns:
this
- See Also:
-
signalsToFetch
A list of information about signals to fetch.- Parameters:
signalsToFetch
- A list of information about signals to fetch. This parameter is required.- Returns:
this
- See Also:
-
spoolingMode
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
Default: - "OFF"
- Parameters:
spoolingMode
- Whether to store collected data after a vehicle lost a connection with the cloud. This parameter is required.- Returns:
this
- See Also:
-
startTime
The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified,0
is used.Default:
0
Default: - "0"
- Parameters:
startTime
- The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified,0
is used. This parameter is required.- Returns:
this
- See Also:
-
tags
Metadata that can be used to manage the campaign.- Parameters:
tags
- Metadata that can be used to manage the campaign. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnCampaign>
- Returns:
- a newly built instance of
CfnCampaign
.
-