Package software.amazon.awscdk.services.iotfleetwise

Class CfnCampaign.Builder

java.lang.Object
software.amazon.awscdk.services.iotfleetwise.CfnCampaign.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnCampaign>
Enclosing class:
CfnCampaign
@Stability(Stable) public static final class CfnCampaign.Builder extends Object implements software.amazon.jsii.Builder<CfnCampaign>
A fluent builder for CfnCampaign.

  • Method Details

    • create

      @Stability(Stable) public static CfnCampaign.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnCampaign.Builder.

    • action

      @Stability(Stable) public CfnCampaign.Builder action(String 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 the SUSPEND 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

    • 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

    • collectionScheme

      @Stability(Stable) public CfnCampaign.Builder collectionScheme(IResolvable 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

    • name

      @Stability(Stable) public CfnCampaign.Builder name(String name)
      The name of a campaign.

      Parameters:
      name - The name of a campaign. This parameter is required.
      Returns:
      this

    • signalCatalogArn

      @Stability(Stable) public CfnCampaign.Builder signalCatalogArn(String 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

    • targetArn

      @Stability(Stable) public CfnCampaign.Builder targetArn(String 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

    • compression

      @Stability(Stable) public CfnCampaign.Builder compression(String compression)
      (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

      Parameters:
      compression - (Optional) Whether to compress signals before transmitting data to AWS IoT FleetWise . This parameter is required.
      Returns:
      this

    • dataDestinationConfigs

      @Stability(Stable) public CfnCampaign.Builder dataDestinationConfigs(IResolvable dataDestinationConfigs)
      (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.

      Parameters:
      dataDestinationConfigs - (Optional) The destination where the campaign sends data. This parameter is required.
      Returns:
      this

    • dataDestinationConfigs

      @Stability(Stable) public CfnCampaign.Builder dataDestinationConfigs(List<? extends Object> dataDestinationConfigs)
      (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.

      Parameters:
      dataDestinationConfigs - (Optional) The destination where the campaign sends data. This parameter is required.
      Returns:
      this

    • dataExtraDimensions

      @Stability(Stable) public CfnCampaign.Builder dataExtraDimensions(List<String> dataExtraDimensions)
      (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

      Parameters:
      dataExtraDimensions - (Optional) A list of vehicle attributes to associate with a campaign. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnCampaign.Builder description(String description)
      (Optional) The description of the campaign.

      Parameters:
      description - (Optional) The description of the campaign. This parameter is required.
      Returns:
      this

    • diagnosticsMode

      @Stability(Stable) public CfnCampaign.Builder diagnosticsMode(String diagnosticsMode)
      (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

      Parameters:
      diagnosticsMode - (Optional) Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise . This parameter is required.
      Returns:
      this

    • expiryTime

      @Stability(Stable) public CfnCampaign.Builder expiryTime(String expiryTime)
      (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)

      Parameters:
      expiryTime - (Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). This parameter is required.
      Returns:
      this

    • postTriggerCollectionDuration

      @Stability(Stable) public CfnCampaign.Builder postTriggerCollectionDuration(Number postTriggerCollectionDuration)
      (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

      Parameters:
      postTriggerCollectionDuration - (Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. This parameter is required.
      Returns:
      this

    • priority

      @Stability(Stable) public CfnCampaign.Builder priority(Number priority)
      (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

      Parameters:
      priority - (Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. This parameter is required.
      Returns:
      this

    • signalsToCollect

      @Stability(Stable) public CfnCampaign.Builder signalsToCollect(IResolvable signalsToCollect)
      (Optional) A list of information about signals to collect.

      Parameters:
      signalsToCollect - (Optional) A list of information about signals to collect. This parameter is required.
      Returns:
      this

    • signalsToCollect

      @Stability(Stable) public CfnCampaign.Builder signalsToCollect(List<? extends Object> signalsToCollect)
      (Optional) A list of information about signals to collect.

      Parameters:
      signalsToCollect - (Optional) A list of information about signals to collect. This parameter is required.
      Returns:
      this

    • spoolingMode

      @Stability(Stable) public CfnCampaign.Builder spoolingMode(String spoolingMode)
      (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

      Parameters:
      spoolingMode - (Optional) Whether to store collected data after a vehicle lost a connection with the cloud. This parameter is required.
      Returns:
      this

    • startTime

      @Stability(Stable) public CfnCampaign.Builder startTime(String startTime)
      (Optional) The time, in milliseconds, to deliver a campaign after it was approved.

      If it's not specified, 0 is used.

      Default: 0

      Parameters:
      startTime - (Optional) The time, in milliseconds, to deliver a campaign after it was approved. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnCampaign.Builder tags(List<? extends CfnTag> tags)
      (Optional) Metadata that can be used to manage the campaign.

      Parameters:
      tags - (Optional) Metadata that can be used to manage the campaign. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnCampaign build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCampaign>
      Returns:
      a newly built instance of CfnCampaign.