Package software.amazon.awscdk.services.iotfleetwise

Class CfnCampaignProps.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • action

      @Stability(Stable) public CfnCampaignProps.Builder action(String action)
      Sets the value of CfnCampaignProps.getAction()
      Parameters:
      action - Specifies how to update a campaign. The action can be one of the following:. This parameter is required.
      • 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.
      Returns:
      this

    • collectionScheme

      @Stability(Stable) public CfnCampaignProps.Builder collectionScheme(CfnCampaign.CollectionSchemeProperty collectionScheme)
      Sets the value of CfnCampaignProps.getCollectionScheme()
      Parameters:
      collectionScheme - The data collection scheme associated with the campaign. This parameter is required. You can specify a scheme that collects data based on time or an event.
      Returns:
      this

    • collectionScheme

      @Stability(Stable) public CfnCampaignProps.Builder collectionScheme(IResolvable collectionScheme)
      Sets the value of CfnCampaignProps.getCollectionScheme()
      Parameters:
      collectionScheme - The data collection scheme associated with the campaign. This parameter is required. You can specify a scheme that collects data based on time or an event.
      Returns:
      this

    • name

      @Stability(Stable) public CfnCampaignProps.Builder name(String name)
      Sets the value of CfnCampaignProps.getName()
      Parameters:
      name - The name of a campaign. This parameter is required.
      Returns:
      this

    • signalCatalogArn

      @Stability(Stable) public CfnCampaignProps.Builder signalCatalogArn(String signalCatalogArn)
      Sets the value of CfnCampaignProps.getSignalCatalogArn()
      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 CfnCampaignProps.Builder targetArn(String targetArn)
      Sets the value of CfnCampaignProps.getTargetArn()
      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 CfnCampaignProps.Builder compression(String compression)
      Sets the value of CfnCampaignProps.getCompression()
      Parameters:
      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

      Returns:
      this

    • dataDestinationConfigs

      @Stability(Stable) public CfnCampaignProps.Builder dataDestinationConfigs(IResolvable dataDestinationConfigs)
      Sets the value of CfnCampaignProps.getDataDestinationConfigs()
      Parameters:
      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.

      Returns:
      this

    • dataDestinationConfigs

      @Stability(Stable) public CfnCampaignProps.Builder dataDestinationConfigs(List<? extends Object> dataDestinationConfigs)
      Sets the value of CfnCampaignProps.getDataDestinationConfigs()
      Parameters:
      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.

      Returns:
      this

    • dataExtraDimensions

      @Stability(Stable) public CfnCampaignProps.Builder dataExtraDimensions(List<String> dataExtraDimensions)
      Sets the value of CfnCampaignProps.getDataExtraDimensions()
      Parameters:
      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

      Returns:
      this

    • description

      @Stability(Stable) public CfnCampaignProps.Builder description(String description)
      Sets the value of CfnCampaignProps.getDescription()
      Parameters:
      description - (Optional) The description of the campaign.
      Returns:
      this

    • diagnosticsMode

      @Stability(Stable) public CfnCampaignProps.Builder diagnosticsMode(String diagnosticsMode)
      Sets the value of CfnCampaignProps.getDiagnosticsMode()
      Parameters:
      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

      Returns:
      this

    • expiryTime

      @Stability(Stable) public CfnCampaignProps.Builder expiryTime(String expiryTime)
      Sets the value of CfnCampaignProps.getExpiryTime()
      Parameters:
      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)

      Returns:
      this

    • postTriggerCollectionDuration

      @Stability(Stable) public CfnCampaignProps.Builder postTriggerCollectionDuration(Number postTriggerCollectionDuration)
      Sets the value of CfnCampaignProps.getPostTriggerCollectionDuration()
      Parameters:
      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

      Returns:
      this

    • priority

      @Stability(Stable) public CfnCampaignProps.Builder priority(Number priority)
      Sets the value of CfnCampaignProps.getPriority()
      Parameters:
      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

      Returns:
      this

    • signalsToCollect

      @Stability(Stable) public CfnCampaignProps.Builder signalsToCollect(IResolvable signalsToCollect)
      Sets the value of CfnCampaignProps.getSignalsToCollect()
      Parameters:
      signalsToCollect - (Optional) A list of information about signals to collect.
      Returns:
      this

    • signalsToCollect

      @Stability(Stable) public CfnCampaignProps.Builder signalsToCollect(List<? extends Object> signalsToCollect)
      Sets the value of CfnCampaignProps.getSignalsToCollect()
      Parameters:
      signalsToCollect - (Optional) A list of information about signals to collect.
      Returns:
      this

    • spoolingMode

      @Stability(Stable) public CfnCampaignProps.Builder spoolingMode(String spoolingMode)
      Sets the value of CfnCampaignProps.getSpoolingMode()
      Parameters:
      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

      Returns:
      this

    • startTime

      @Stability(Stable) public CfnCampaignProps.Builder startTime(String startTime)
      Sets the value of CfnCampaignProps.getStartTime()
      Parameters:
      startTime - (Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

      Default: 0

      Returns:
      this

    • tags

      @Stability(Stable) public CfnCampaignProps.Builder tags(List<? extends CfnTag> tags)
      Sets the value of CfnCampaignProps.getTags()
      Parameters:
      tags - (Optional) Metadata that can be used to manage the campaign.
      Returns:
      this

    • build

      @Stability(Stable) public CfnCampaignProps build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnCampaignProps>
      Returns:
      a new instance of CfnCampaignProps
      Throws:
      NullPointerException - if any required attribute was not provided