Package software.amazon.awscdk.services.iotfleetwise

Class CfnCampaignProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.iotfleetwise.CfnCampaignProps.Jsii$Proxy

All Implemented Interfaces:

CfnCampaignProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

CfnCampaignProps

@Stability(Stable)
@Internal
public static final class CfnCampaignProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements CfnCampaignProps

An implementation for CfnCampaignProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.iotfleetwise.CfnCampaignProps

CfnCampaignProps.Builder, CfnCampaignProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(CfnCampaignProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the CfnCampaignProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAction()	Specifies how to update a campaign.
final Object	getCollectionScheme()	The data collection scheme associated with the campaign.
final String	getCompression()	Whether to compress signals before transmitting data to AWS IoT FleetWise .
final Object	getDataDestinationConfigs()	The destination where the campaign sends data.
final List<String>	getDataExtraDimensions()	A list of vehicle attributes to associate with a campaign.
final Object	getDataPartitions()	The data partitions associated with the signals collected from the vehicle.
final String	getDescription()	The description of the campaign.
final String	getDiagnosticsMode()	Option for a vehicle to send diagnostic trouble codes to AWS IoT FleetWise .
final String	getExpiryTime()	The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time).
final String	getName()	The name of a campaign.
final Number	getPostTriggerCollectionDuration()	How long (in milliseconds) to collect raw data after a triggering event initiates the collection.
final Number	getPriority()	A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet.
final String	getSignalCatalogArn()	The Amazon Resource Name (ARN) of the signal catalog associated with the campaign.
final Object	getSignalsToCollect()	A list of information about signals to collect.
final Object	getSignalsToFetch()	A list of information about signals to fetch.
final String	getSpoolingMode()	Whether to store collected data after a vehicle lost a connection with the cloud.
final String	getStartTime()	The time, in milliseconds, to deliver a campaign after it was approved.
final List<CfnTag>	getTags()	Metadata that can be used to manage the campaign.
final String	getTargetArn()	The Amazon Resource Name (ARN) of a vehicle or fleet to which the campaign is deployed.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(CfnCampaignProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the CfnCampaignProps.Builder.

Method Details

getCollectionScheme

public final Object getCollectionScheme()

Description copied from interface: CfnCampaignProps

The data collection scheme associated with the campaign.

You can specify a scheme that collects data based on time or an event.

Returns union: either IResolvable or CfnCampaign.CollectionSchemeProperty

Specified by:

getCollectionScheme in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-collectionscheme

getName

public final String getName()

Description copied from interface: CfnCampaignProps

The name of a campaign.

Specified by:

getName in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-name

getSignalCatalogArn

public final String getSignalCatalogArn()

Description copied from interface: CfnCampaignProps

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

Specified by:

getSignalCatalogArn in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalcatalogarn

getTargetArn

public final String getTargetArn()

Description copied from interface: CfnCampaignProps

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

Specified by:

getTargetArn in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-targetarn

getAction

public final String getAction()

Description copied from interface: CfnCampaignProps

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.

Specified by:

getAction in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-action

getCompression

public final String getCompression()

Description copied from interface: CfnCampaignProps

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"

Specified by:

getCompression in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-compression

getDataDestinationConfigs

public final Object getDataDestinationConfigs()

Description copied from interface: CfnCampaignProps

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 union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCampaign.DataDestinationConfigProperty>

Specified by:

getDataDestinationConfigs in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datadestinationconfigs

getDataExtraDimensions

public final List<String> getDataExtraDimensions()

Description copied from interface: CfnCampaignProps

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

Specified by:

getDataExtraDimensions in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-dataextradimensions

getDataPartitions

public final Object getDataPartitions()

Description copied from interface: CfnCampaignProps

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

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCampaign.DataPartitionProperty>

Specified by:

getDataPartitions in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-datapartitions

getDescription

public final String getDescription()

Description copied from interface: CfnCampaignProps

The description of the campaign.

Specified by:

getDescription in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-description

getDiagnosticsMode

public final String getDiagnosticsMode()

Description copied from interface: CfnCampaignProps

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"

Specified by:

getDiagnosticsMode in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-diagnosticsmode

getExpiryTime

public final String getExpiryTime()

Description copied from interface: CfnCampaignProps

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"

Specified by:

getExpiryTime in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-expirytime

getPostTriggerCollectionDuration

public final Number getPostTriggerCollectionDuration()

Description copied from interface: CfnCampaignProps

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

Specified by:

getPostTriggerCollectionDuration in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-posttriggercollectionduration

getPriority

public final Number getPriority()

Description copied from interface: CfnCampaignProps

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

Specified by:

getPriority in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-priority

getSignalsToCollect

public final Object getSignalsToCollect()

Description copied from interface: CfnCampaignProps

A list of information about signals to collect.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCampaign.SignalInformationProperty>

Specified by:

getSignalsToCollect in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstocollect

getSignalsToFetch

public final Object getSignalsToFetch()

Description copied from interface: CfnCampaignProps

A list of information about signals to fetch.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCampaign.SignalFetchInformationProperty>

Specified by:

getSignalsToFetch in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-signalstofetch

getSpoolingMode

public final String getSpoolingMode()

Description copied from interface: CfnCampaignProps

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"

Specified by:

getSpoolingMode in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-spoolingmode

getStartTime

public final String getStartTime()

Description copied from interface: CfnCampaignProps

The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.

Default: 0

Default: - "0"

Specified by:

getStartTime in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-starttime

getTags

public final List<CfnTag> getTags()

Description copied from interface: CfnCampaignProps

Metadata that can be used to manage the campaign.

Specified by:

getTags in interface CfnCampaignProps

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iotfleetwise-campaign.html#cfn-iotfleetwise-campaign-tags

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object