Package software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise

Class CfnCampaignMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iotfleetwise.CfnCampaignMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnCampaignMixinProps>

Enclosing interface:

CfnCampaignMixinProps

@Stability(Stable)
public static final class CfnCampaignMixinProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnCampaignMixinProps>

A builder for CfnCampaignMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnCampaignMixinProps.Builder	action(String action)	Sets the value of CfnCampaignMixinProps.getAction()
CfnCampaignMixinProps	build()	Builds the configured instance.
CfnCampaignMixinProps.Builder	collectionScheme(CfnCampaignPropsMixin.CollectionSchemeProperty collectionScheme)	Sets the value of CfnCampaignMixinProps.getCollectionScheme()
CfnCampaignMixinProps.Builder	collectionScheme(IResolvable collectionScheme)	Sets the value of CfnCampaignMixinProps.getCollectionScheme()
CfnCampaignMixinProps.Builder	compression(String compression)	Sets the value of CfnCampaignMixinProps.getCompression()
CfnCampaignMixinProps.Builder	dataDestinationConfigs(List<? extends Object> dataDestinationConfigs)	Sets the value of CfnCampaignMixinProps.getDataDestinationConfigs()
CfnCampaignMixinProps.Builder	dataDestinationConfigs(IResolvable dataDestinationConfigs)	Sets the value of CfnCampaignMixinProps.getDataDestinationConfigs()
CfnCampaignMixinProps.Builder	dataExtraDimensions(List<String> dataExtraDimensions)	Sets the value of CfnCampaignMixinProps.getDataExtraDimensions()
CfnCampaignMixinProps.Builder	dataPartitions(List<? extends Object> dataPartitions)	Sets the value of CfnCampaignMixinProps.getDataPartitions()
CfnCampaignMixinProps.Builder	dataPartitions(IResolvable dataPartitions)	Sets the value of CfnCampaignMixinProps.getDataPartitions()
CfnCampaignMixinProps.Builder	description(String description)	Sets the value of CfnCampaignMixinProps.getDescription()
CfnCampaignMixinProps.Builder	diagnosticsMode(String diagnosticsMode)	Sets the value of CfnCampaignMixinProps.getDiagnosticsMode()
CfnCampaignMixinProps.Builder	expiryTime(String expiryTime)	Sets the value of CfnCampaignMixinProps.getExpiryTime()
CfnCampaignMixinProps.Builder	name(String name)	Sets the value of CfnCampaignMixinProps.getName()
CfnCampaignMixinProps.Builder	postTriggerCollectionDuration(Number postTriggerCollectionDuration)	Sets the value of CfnCampaignMixinProps.getPostTriggerCollectionDuration()
CfnCampaignMixinProps.Builder	priority(Number priority)	Sets the value of CfnCampaignMixinProps.getPriority()
CfnCampaignMixinProps.Builder	signalCatalogArn(String signalCatalogArn)	Sets the value of CfnCampaignMixinProps.getSignalCatalogArn()
CfnCampaignMixinProps.Builder	signalsToCollect(List<? extends Object> signalsToCollect)	Sets the value of CfnCampaignMixinProps.getSignalsToCollect()
CfnCampaignMixinProps.Builder	signalsToCollect(IResolvable signalsToCollect)	Sets the value of CfnCampaignMixinProps.getSignalsToCollect()
CfnCampaignMixinProps.Builder	signalsToFetch(List<? extends Object> signalsToFetch)	Sets the value of CfnCampaignMixinProps.getSignalsToFetch()
CfnCampaignMixinProps.Builder	signalsToFetch(IResolvable signalsToFetch)	Sets the value of CfnCampaignMixinProps.getSignalsToFetch()
CfnCampaignMixinProps.Builder	spoolingMode(String spoolingMode)	Sets the value of CfnCampaignMixinProps.getSpoolingMode()
CfnCampaignMixinProps.Builder	startTime(String startTime)	Sets the value of CfnCampaignMixinProps.getStartTime()
CfnCampaignMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnCampaignMixinProps.getTags()
CfnCampaignMixinProps.Builder	targetArn(String targetArn)	Sets the value of CfnCampaignMixinProps.getTargetArn()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

action

@Stability(Stable)
public CfnCampaignMixinProps.Builder action(String action)

Sets the value of CfnCampaignMixinProps.getAction()

Parameters:

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.

Returns:

this

collectionScheme

@Stability(Stable)
public CfnCampaignMixinProps.Builder collectionScheme(IResolvable collectionScheme)

Sets the value of CfnCampaignMixinProps.getCollectionScheme()

Parameters:

collectionScheme - The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

Returns:

this

collectionScheme

@Stability(Stable)
public CfnCampaignMixinProps.Builder collectionScheme(CfnCampaignPropsMixin.CollectionSchemeProperty collectionScheme)

Sets the value of CfnCampaignMixinProps.getCollectionScheme()

Parameters:

collectionScheme - The data collection scheme associated with the campaign. You can specify a scheme that collects data based on time or an event.

Returns:

this

compression

@Stability(Stable)
public CfnCampaignMixinProps.Builder compression(String compression)

Sets the value of CfnCampaignMixinProps.getCompression()

Parameters:

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

Returns:

this

dataDestinationConfigs

@Stability(Stable)
public CfnCampaignMixinProps.Builder dataDestinationConfigs(IResolvable dataDestinationConfigs)

Sets the value of CfnCampaignMixinProps.getDataDestinationConfigs()

Parameters:

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.

Returns:

this

dataDestinationConfigs

@Stability(Stable)
public CfnCampaignMixinProps.Builder dataDestinationConfigs(List<? extends Object> dataDestinationConfigs)

Sets the value of CfnCampaignMixinProps.getDataDestinationConfigs()

Parameters:

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.

Returns:

this

dataExtraDimensions

@Stability(Stable)
public CfnCampaignMixinProps.Builder dataExtraDimensions(List<String> dataExtraDimensions)

Sets the value of CfnCampaignMixinProps.getDataExtraDimensions()

Parameters:

dataExtraDimensions - 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

dataPartitions

@Stability(Stable)
public CfnCampaignMixinProps.Builder dataPartitions(IResolvable dataPartitions)

Sets the value of CfnCampaignMixinProps.getDataPartitions()

Parameters:

dataPartitions - The data partitions associated with the signals collected from the vehicle.

Returns:

this

dataPartitions

@Stability(Stable)
public CfnCampaignMixinProps.Builder dataPartitions(List<? extends Object> dataPartitions)

Sets the value of CfnCampaignMixinProps.getDataPartitions()

Parameters:

dataPartitions - The data partitions associated with the signals collected from the vehicle.

Returns:

this

description

@Stability(Stable)
public CfnCampaignMixinProps.Builder description(String description)

Sets the value of CfnCampaignMixinProps.getDescription()

Parameters:

description - The description of the campaign.

Returns:

this

diagnosticsMode

@Stability(Stable)
public CfnCampaignMixinProps.Builder diagnosticsMode(String diagnosticsMode)

Sets the value of CfnCampaignMixinProps.getDiagnosticsMode()

Parameters:

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

Returns:

this

expiryTime

@Stability(Stable)
public CfnCampaignMixinProps.Builder expiryTime(String expiryTime)

Sets the value of CfnCampaignMixinProps.getExpiryTime()

Parameters:

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)

Returns:

this

name

@Stability(Stable)
public CfnCampaignMixinProps.Builder name(String name)

Sets the value of CfnCampaignMixinProps.getName()

Parameters:

name - The name of a campaign.

Returns:

this

postTriggerCollectionDuration

@Stability(Stable)
public CfnCampaignMixinProps.Builder postTriggerCollectionDuration(Number postTriggerCollectionDuration)

Sets the value of CfnCampaignMixinProps.getPostTriggerCollectionDuration()

Parameters:

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

Returns:

this

priority

@Stability(Stable)
public CfnCampaignMixinProps.Builder priority(Number priority)

Sets the value of CfnCampaignMixinProps.getPriority()

Parameters:

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

Returns:

this

signalCatalogArn

@Stability(Stable)
public CfnCampaignMixinProps.Builder signalCatalogArn(String signalCatalogArn)

Sets the value of CfnCampaignMixinProps.getSignalCatalogArn()

Parameters:

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

Returns:

this

signalsToCollect

@Stability(Stable)
public CfnCampaignMixinProps.Builder signalsToCollect(IResolvable signalsToCollect)

Sets the value of CfnCampaignMixinProps.getSignalsToCollect()

Parameters:

signalsToCollect - A list of information about signals to collect.

Returns:

this

signalsToCollect

@Stability(Stable)
public CfnCampaignMixinProps.Builder signalsToCollect(List<? extends Object> signalsToCollect)

Sets the value of CfnCampaignMixinProps.getSignalsToCollect()

Parameters:

signalsToCollect - A list of information about signals to collect.

Returns:

this

signalsToFetch

@Stability(Stable)
public CfnCampaignMixinProps.Builder signalsToFetch(IResolvable signalsToFetch)

Sets the value of CfnCampaignMixinProps.getSignalsToFetch()

Parameters:

signalsToFetch - A list of information about signals to fetch.

Returns:

this

signalsToFetch

@Stability(Stable)
public CfnCampaignMixinProps.Builder signalsToFetch(List<? extends Object> signalsToFetch)

Sets the value of CfnCampaignMixinProps.getSignalsToFetch()

Parameters:

signalsToFetch - A list of information about signals to fetch.

Returns:

this

spoolingMode

@Stability(Stable)
public CfnCampaignMixinProps.Builder spoolingMode(String spoolingMode)

Sets the value of CfnCampaignMixinProps.getSpoolingMode()

Parameters:

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

Returns:

this

startTime

@Stability(Stable)
public CfnCampaignMixinProps.Builder startTime(String startTime)

Sets the value of CfnCampaignMixinProps.getStartTime()

Parameters:

startTime - 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 CfnCampaignMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnCampaignMixinProps.getTags()

Parameters:

tags - Metadata that can be used to manage the campaign.

Returns:

this

targetArn

@Stability(Stable)
public CfnCampaignMixinProps.Builder targetArn(String targetArn)

Sets the value of CfnCampaignMixinProps.getTargetArn()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnCampaignMixinProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnCampaignMixinProps>

Returns:

a new instance of CfnCampaignMixinProps

Throws:

NullPointerException - if any required attribute was not provided