api-typescript.md

cdk-aws-iotfleetwise

L2 CDK construct to provision AWS IoT Fleetwise

Install

Typescript

npm install cdk-aws-iotfleetwise

API Reference

Python

pip install cdk-aws-iotfleetwise

API Reference

Sample

import {
  SignalCatalog,
  VehicleModel,
  Vehicle,
  Campaign,
  CanVehicleInterface,
  CanVehicleSignal,
  SignalCatalogBranch,
  TimeBasedCollectionScheme,
} from 'cdk-aws-iotfleetwise';

const signalCatalog = new SignalCatalog(stack, 'SignalCatalog', {
  database: tsDatabaseConstruct,
  table: tsHeartBeatTableConstruct,
  nodes: [
    new SignalCatalogBranch({
      fullyQualifiedName: 'Vehicle',
    }),
    new SignalCatalogSensor({
      fullyQualifiedName: 'Vehicle.EngineTorque',
      dataType: 'DOUBLE',
    }),
  ],
});

const model_a = new VehicleModel(stack, 'ModelA', {
  signalCatalog,
  name: 'modelA',
  description: 'Model A vehicle',
  networkInterfaces: [
    new CanVehicleInterface({
      interfaceId: '1',
      name: 'vcan0',
    }),
  ],
  signals: [
    new CanVehicleSignal({
      fullyQualifiedName: 'Vehicle.EngineTorque',
      interfaceId: '1',
      messageId: 401,
      factor: 1.0,
      isBigEndian: true,
      isSigned: false,
      length: 8,
      offset: 0.0,
      startBit: 0,
    }),
  ],
});

const vin100 = new Vehicle(stack, 'vin100', {
  vehicleName: 'vin100',
  vehicleModel: model_a,
  createIotThing: true,
});

new Campaign(stack, 'Campaign', {
  name: 'TimeBasedCampaign',
  target: vin100,
  collectionScheme: new TimeBasedCollectionScheme(cdk.Duration.seconds(10)),
  signals: [new CampaignSignal('Vehicle.EngineTorque')],
});

Getting started

To deploy a simple end-to-end example you can use the following commands

yarn install
npx projen && npx projen compile
# Define Amazon Timestream as fleetwise storage destination
npx cdk -a lib/integ.full.js deploy -c key_name=mykey
# Define Amazon S3 as fleetwise storage destination
npx cdk -a lib/integ.full.js deploy -c key_name=mykey -c use_s3=true

Where mykey is an existing keypair name present in your account. The deploy takes about 15 mins mostly due to compilation of the IoT FleetWise agent in the EC2 instance that simulate the vehicle. Once deploy is finshed, data will start to show up in your Timestream table.

TODO

Warning: this construct should be considered at alpha stage and is not feature complete.

• Implement updates for all the custom resources
• Conditional campaigns

Security

See CONTRIBUTING for more information.

License

This code is licensed under the MIT-0 License. See the LICENSE file.

API Reference

Constructs

Campaign

Initializers

import { Campaign } from 'cdk-aws-iotfleetwise'

new Campaign(scope: Construct, id: string, props: CampaignProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	CampaignProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: CampaignProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Campaign } from 'cdk-aws-iotfleetwise'

Campaign.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
arn	string	No description.
name	string	No description.
target	Vehicle	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

arn^Required

public readonly arn: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

target^Required

public readonly target: Vehicle;

• Type: Vehicle

---

Fleet

The fleet of vehicles.

Initializers

import { Fleet } from 'cdk-aws-iotfleetwise'

new Fleet(scope: Construct, id: string, props: FleetProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	FleetProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: FleetProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Fleet } from 'cdk-aws-iotfleetwise'

Fleet.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
arn	string	No description.
fleetId	string	No description.
signalCatalog	SignalCatalog	No description.
vehicles	Vehicle[]	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

arn^Required

public readonly arn: string;

• Type: string

---

fleetId^Required

public readonly fleetId: string;

• Type: string

---

signalCatalog^Required

public readonly signalCatalog: SignalCatalog;

• Type: SignalCatalog

---

vehicles^Optional

public readonly vehicles: Vehicle[];

• Type: Vehicle[]

---

Logging

Configures FleetWise logging to CloudWatch logs.

If enabled, this will ensure the log group is accessible, or create a new one if it is not.

Initializers

import { Logging } from 'cdk-aws-iotfleetwise'

new Logging(scope: Construct, id: string, props: LoggingProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	LoggingProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: LoggingProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Logging } from 'cdk-aws-iotfleetwise'

Logging.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

SignalCatalog

The Signal Catalog represents the list of all signals that you want to collect from all the vehicles.

The AWS IoT Fleetwise preview can only support a single Signal Catalog per account.

Initializers

import { SignalCatalog } from 'cdk-aws-iotfleetwise'

new SignalCatalog(scope: Construct, id: string, props: SignalCatalogProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	SignalCatalogProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: SignalCatalogProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { SignalCatalog } from 'cdk-aws-iotfleetwise'

SignalCatalog.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
arn	string	No description.
description	string	No description.
name	string	The name of the signal catalog.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

arn^Required

public readonly arn: string;

• Type: string

---

description^Required

public readonly description: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

The name of the signal catalog.

---

Vehicle

The vehicle of a specific type from which IoT FleetWise collect signals.

Initializers

import { Vehicle } from 'cdk-aws-iotfleetwise'

new Vehicle(scope: Construct, id: string, props: VehicleProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	VehicleProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: VehicleProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { Vehicle } from 'cdk-aws-iotfleetwise'

Vehicle.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
arn	string	No description.
vehicleModel	VehicleModel	No description.
vehicleName	string	No description.
certificateArn	string	No description.
certificateId	string	No description.
certificatePem	string	No description.
endpointAddress	string	No description.
privateKey	string	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

arn^Required

public readonly arn: string;

• Type: string

---

vehicleModel^Required

public readonly vehicleModel: VehicleModel;

• Type: VehicleModel

---

vehicleName^Required

public readonly vehicleName: string;

• Type: string

---

certificateArn^Optional

public readonly certificateArn: string;

• Type: string

---

certificateId^Optional

public readonly certificateId: string;

• Type: string

---

certificatePem^Optional

public readonly certificatePem: string;

• Type: string

---

endpointAddress^Optional

public readonly endpointAddress: string;

• Type: string

---

privateKey^Optional

public readonly privateKey: string;

• Type: string

---

VehicleModel

Initializers

import { VehicleModel } from 'cdk-aws-iotfleetwise'

new VehicleModel(scope: Construct, id: string, props: VehicleModelProps)

Name	Type	Description
scope	constructs.Construct	No description.
id	string	No description.
props	VehicleModelProps	No description.

---

scope^Required

• Type: constructs.Construct

---

id^Required

• Type: string

---

props^Required

• Type: VehicleModelProps

---

Methods

Name	Description
toString	Returns a string representation of this construct.

---

toString

public toString(): string

Returns a string representation of this construct.

Static Functions

Name	Description
isConstruct	Checks if x is a construct.

---

isConstruct

import { VehicleModel } from 'cdk-aws-iotfleetwise'

VehicleModel.isConstruct(x: any)

Checks if x is a construct.

x^Required

• Type: any

Any object.

---

Properties

Name	Type	Description
node	constructs.Node	The tree node.
name	string	No description.
signalCatalog	SignalCatalog	No description.

---

node^Required

public readonly node: Node;

• Type: constructs.Node

The tree node.

---

name^Required

public readonly name: string;

• Type: string

---

signalCatalog^Required

public readonly signalCatalog: SignalCatalog;

• Type: SignalCatalog

---

Structs

AttributeVehicleSignalProps

Attribute Signal - needed when creating a vehicle with attributes.

Initializer

import { AttributeVehicleSignalProps } from 'cdk-aws-iotfleetwise'

const attributeVehicleSignalProps: AttributeVehicleSignalProps = { ... }

Properties

Name	Type	Description
fullyQualifiedName	string	No description.

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

CampaignProps

Initializer

import { CampaignProps } from 'cdk-aws-iotfleetwise'

const campaignProps: CampaignProps = { ... }

Properties

Name	Type	Description
collectionScheme	CollectionScheme	No description.
dataDestinationConfigs	DataDestinationConfig[]	No description.
name	string	No description.
signals	CampaignSignal[]	No description.
target	Vehicle	No description.
autoApprove	boolean	No description.

---

collectionScheme^Required

public readonly collectionScheme: CollectionScheme;

• Type: CollectionScheme

---

dataDestinationConfigs^Required

public readonly dataDestinationConfigs: DataDestinationConfig[];

• Type: DataDestinationConfig[]

---

name^Required

public readonly name: string;

• Type: string

---

signals^Required

public readonly signals: CampaignSignal[];

• Type: CampaignSignal[]

---

target^Required

public readonly target: Vehicle;

• Type: Vehicle

---

autoApprove^Optional

public readonly autoApprove: boolean;

• Type: boolean

---

CanVehicleInterfaceProps

Initializer

import { CanVehicleInterfaceProps } from 'cdk-aws-iotfleetwise'

const canVehicleInterfaceProps: CanVehicleInterfaceProps = { ... }

Properties

Name	Type	Description
interfaceId	string	No description.
name	string	No description.
protocolName	string	No description.
protocolVersion	string	No description.

---

interfaceId^Required

public readonly interfaceId: string;

• Type: string

---

name^Required

public readonly name: string;

• Type: string

---

protocolName^Optional

public readonly protocolName: string;

• Type: string

---

protocolVersion^Optional

public readonly protocolVersion: string;

• Type: string

---

CanVehicleSignalProps

Initializer

import { CanVehicleSignalProps } from 'cdk-aws-iotfleetwise'

const canVehicleSignalProps: CanVehicleSignalProps = { ... }

Properties

Name	Type	Description
factor	number	No description.
fullyQualifiedName	string	No description.
interfaceId	string	No description.
isBigEndian	boolean	No description.
isSigned	boolean	No description.
length	number	No description.
messageId	number	No description.
offset	number	No description.
startBit	number	No description.
name	string	No description.

---

factor^Required

public readonly factor: number;

• Type: number

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

interfaceId^Required

public readonly interfaceId: string;

• Type: string

---

isBigEndian^Required

public readonly isBigEndian: boolean;

• Type: boolean

---

isSigned^Required

public readonly isSigned: boolean;

• Type: boolean

---

length^Required

public readonly length: number;

• Type: number

---

messageId^Required

public readonly messageId: number;

• Type: number

---

offset^Required

public readonly offset: number;

• Type: number

---

startBit^Required

public readonly startBit: number;

• Type: number

---

name^Optional

public readonly name: string;

• Type: string

---

FleetProps

Interface.

Initializer

import { FleetProps } from 'cdk-aws-iotfleetwise'

const fleetProps: FleetProps = { ... }

Properties

Name	Type	Description
fleetId	string	No description.
signalCatalog	SignalCatalog	No description.
description	string	No description.
vehicles	Vehicle[]	No description.

---

fleetId^Required

public readonly fleetId: string;

• Type: string

---

signalCatalog^Required

public readonly signalCatalog: SignalCatalog;

• Type: SignalCatalog

---

description^Optional

public readonly description: string;

• Type: string

---

vehicles^Optional

public readonly vehicles: Vehicle[];

• Type: Vehicle[]

---

LoggingProps

FleetWise Logging Properties.

Initializer

import { LoggingProps } from 'cdk-aws-iotfleetwise'

const loggingProps: LoggingProps = { ... }

Properties

Name	Type	Description
enableLogging	string	No description.
logGroupName	string	Name of log group to configure.
keepLogGroup	boolean	No description.

---

enableLogging^Required

public readonly enableLogging: string;

• Type: string

---

logGroupName^Required

public readonly logGroupName: string;

• Type: string

Name of log group to configure.

This can be either single name such as AWSIoTFleetWiseLogs or a fully pathed entry such as: /iot/FleetWiseLogs

---

keepLogGroup^Optional

public readonly keepLogGroup: boolean;

• Type: boolean

---

SignalCatalogActuatorProps

Initializer

import { SignalCatalogActuatorProps } from 'cdk-aws-iotfleetwise'

const signalCatalogActuatorProps: SignalCatalogActuatorProps = { ... }

Properties

Name	Type	Description
dataType	string	No description.
fullyQualifiedName	string	No description.
allowedValues	string[]	No description.
assignedValue	string	No description.
description	string	No description.
max	number	No description.
min	number	No description.
unit	string	No description.

---

dataType^Required

public readonly dataType: string;

• Type: string

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

allowedValues^Optional

public readonly allowedValues: string[];

• Type: string[]

---

assignedValue^Optional

public readonly assignedValue: string;

• Type: string

---

description^Optional

public readonly description: string;

• Type: string

---

max^Optional

public readonly max: number;

• Type: number

---

min^Optional

public readonly min: number;

• Type: number

---

unit^Optional

public readonly unit: string;

• Type: string

---

SignalCatalogAttributeProps

Initializer

import { SignalCatalogAttributeProps } from 'cdk-aws-iotfleetwise'

const signalCatalogAttributeProps: SignalCatalogAttributeProps = { ... }

Properties

Name	Type	Description
dataType	string	No description.
fullyQualifiedName	string	No description.
allowedValues	string[]	No description.
assignedValue	string	No description.
defaultValue	string	No description.
description	string	No description.
max	number	No description.
min	number	No description.
unit	string	No description.

---

dataType^Required

public readonly dataType: string;

• Type: string

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

allowedValues^Optional

public readonly allowedValues: string[];

• Type: string[]

---

assignedValue^Optional

public readonly assignedValue: string;

• Type: string

---

defaultValue^Optional

public readonly defaultValue: string;

• Type: string

---

description^Optional

public readonly description: string;

• Type: string

---

max^Optional

public readonly max: number;

• Type: number

---

min^Optional

public readonly min: number;

• Type: number

---

unit^Optional

public readonly unit: string;

• Type: string

---

SignalCatalogBranchProps

Initializer

import { SignalCatalogBranchProps } from 'cdk-aws-iotfleetwise'

const signalCatalogBranchProps: SignalCatalogBranchProps = { ... }

Properties

Name	Type	Description
fullyQualifiedName	string	No description.
description	string	No description.

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

description^Optional

public readonly description: string;

• Type: string

---

SignalCatalogProps

Initializer

import { SignalCatalogProps } from 'cdk-aws-iotfleetwise'

const signalCatalogProps: SignalCatalogProps = { ... }

Properties

Name	Type	Description
deregister	boolean	Deregister FleetWise on stack deletion.
description	string	Description of the Signal Catalog.
name	string	Name of the Signal Catalog.
nodes	SignalCatalogNode[]	An array of signal nodes.
vssFile	string	A YAML file that conforms to the Vehicle Signal Specification format and contains a list of signals. If provided, the contents of the file, along with the prefix property will be appended after any SignalCatalogNode objects provided.
vssGeneratePrefixBranch	boolean	If set to true, this will parse the vssPrefix into branch nodes.
vssPrefix	string	A prefix to prepend to the fully qualified names found in the VSS file.

---

deregister^Optional

public readonly deregister: boolean;

• Type: boolean
• Default: false

Deregister FleetWise on stack deletion.

If set to 'true', FleetWise will be deregistered from the Timestream destination.

---

description^Optional

public readonly description: string;

• Type: string
• Default: None

Description of the Signal Catalog.

If not provided no description is set.

---

name^Optional

public readonly name: string;

• Type: string
• Default: default

Name of the Signal Catalog.

If not provided, default value is used.

---

nodes^Optional

public readonly nodes: SignalCatalogNode[];

• Type: SignalCatalogNode[]
• Default: []

An array of signal nodes.

Nodes are a general abstraction of a signal. A node can be specified as an actuator, attribute, branch, or sensor. See SignalCatalogBranch, SignalCatalogSensor, SignalCatalogActuator, or SignalCatalogAttribute for creating nodes.

---

vssFile^Optional

public readonly vssFile: string;

• Type: string
• Default: None

A YAML file that conforms to the Vehicle Signal Specification format and contains a list of signals. If provided, the contents of the file, along with the prefix property will be appended after any SignalCatalogNode objects provided.

---

vssGeneratePrefixBranch^Optional

public readonly vssGeneratePrefixBranch: boolean;

• Type: boolean
• Default: true

If set to true, this will parse the vssPrefix into branch nodes.

For instance if OBD.MyData was provided, the OBD.MyData will be parsed into branch nodes of OBD and OBD.MyData. By default this is set to true. If you define branches in another way such as via SignalCatalogNode, set this to false to suppress creation of branch nodes.

---

vssPrefix^Optional

public readonly vssPrefix: string;

• Type: string
• Default: None

A prefix to prepend to the fully qualified names found in the VSS file.

The format of the prefix is in dotted notation, and will be the prepended to all signal names.

For instance, with the prefix of OBD.MyData and signal names of PidA and PidB will be combined to create OBD.MyData.PidA and OBD.MyData.PidB.

---

SignalCatalogSensorProps

Initializer

import { SignalCatalogSensorProps } from 'cdk-aws-iotfleetwise'

const signalCatalogSensorProps: SignalCatalogSensorProps = { ... }

Properties

Name	Type	Description
dataType	string	No description.
fullyQualifiedName	string	No description.
allowedValues	string[]	No description.
description	string	No description.
max	number	No description.
min	number	No description.
unit	string	No description.

---

dataType^Required

public readonly dataType: string;

• Type: string

---

fullyQualifiedName^Required

public readonly fullyQualifiedName: string;

• Type: string

---

allowedValues^Optional

public readonly allowedValues: string[];

• Type: string[]

---

description^Optional

public readonly description: string;

• Type: string

---

max^Optional

public readonly max: number;

• Type: number

---

min^Optional

public readonly min: number;

• Type: number

---

unit^Optional

public readonly unit: string;

• Type: string

---

VehicleModelProps

Initializer

import { VehicleModelProps } from 'cdk-aws-iotfleetwise'

const vehicleModelProps: VehicleModelProps = { ... }

Properties

Name	Type	Description
name	string	No description.
networkInterfaces	VehicleInterface[]	No description.
signalCatalog	SignalCatalog	No description.
description	string	No description.
networkFileDefinitions	NetworkFileDefinition[]	No description.
signals	VehicleSignal[]	No description.

---

name^Required

public readonly name: string;

• Type: string

---

networkInterfaces^Required

public readonly networkInterfaces: VehicleInterface[];

• Type: VehicleInterface[]

---

signalCatalog^Required

public readonly signalCatalog: SignalCatalog;

• Type: SignalCatalog

---

description^Optional

public readonly description: string;

• Type: string

---

networkFileDefinitions^Optional

public readonly networkFileDefinitions: NetworkFileDefinition[];

• Type: NetworkFileDefinition[]

---

signals^Optional

public readonly signals: VehicleSignal[];

• Type: VehicleSignal[]

---

VehicleProps

Interface.

Initializer

import { VehicleProps } from 'cdk-aws-iotfleetwise'

const vehicleProps: VehicleProps = { ... }

Properties

Name	Type	Description
createIotThing	boolean	No description.
vehicleModel	VehicleModel	No description.
vehicleName	string	No description.
attributes	{[ key: string ]: string}	No description.

---

createIotThing^Required

public readonly createIotThing: boolean;

• Type: boolean

---

vehicleModel^Required

public readonly vehicleModel: VehicleModel;

• Type: VehicleModel

---

vehicleName^Required

public readonly vehicleName: string;

• Type: string

---

attributes^Optional

public readonly attributes: {[ key: string ]: string};

• Type: {[ key: string ]: string}

---

Classes

AttributeVehicleSignal

Initializers

import { AttributeVehicleSignal } from 'cdk-aws-iotfleetwise'

new AttributeVehicleSignal(props: AttributeVehicleSignalProps)

Name	Type	Description
props	AttributeVehicleSignalProps	No description.

---

props^Required

• Type: AttributeVehicleSignalProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

CampaignSignal

Initializers

import { CampaignSignal } from 'cdk-aws-iotfleetwise'

new CampaignSignal(name: string, maxSampleCount?: number, minimumSamplingInterval?: Duration)

Name	Type	Description
name	string	No description.
maxSampleCount	number	No description.
minimumSamplingInterval	aws-cdk-lib.Duration	No description.

---

name^Required

• Type: string

---

maxSampleCount^Optional

• Type: number

---

minimumSamplingInterval^Optional

• Type: aws-cdk-lib.Duration

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

CanDefinition

Initializers

import { CanDefinition } from 'cdk-aws-iotfleetwise'

new CanDefinition(networkInterface: string, signalsMap: {[ key: string ]: string}, canDbcFiles: string[])

Name	Type	Description
networkInterface	string	No description.
signalsMap	{[ key: string ]: string}	No description.
canDbcFiles	string[]	No description.

---

networkInterface^Required

• Type: string

---

signalsMap^Required

• Type: {[ key: string ]: string}

---

canDbcFiles^Required

• Type: string[]

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

CanVehicleInterface

Initializers

import { CanVehicleInterface } from 'cdk-aws-iotfleetwise'

new CanVehicleInterface(props: CanVehicleInterfaceProps)

Name	Type	Description
props	CanVehicleInterfaceProps	No description.

---

props^Required

• Type: CanVehicleInterfaceProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

CanVehicleSignal

Initializers

import { CanVehicleSignal } from 'cdk-aws-iotfleetwise'

new CanVehicleSignal(props: CanVehicleSignalProps)

Name	Type	Description
props	CanVehicleSignalProps	No description.

---

props^Required

• Type: CanVehicleSignalProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

CollectionScheme

Initializers

import { CollectionScheme } from 'cdk-aws-iotfleetwise'

new CollectionScheme()

Name	Type	Description

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

DataDestinationConfig

Initializers

import { DataDestinationConfig } from 'cdk-aws-iotfleetwise'

new DataDestinationConfig()

Name	Type	Description

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

NetworkFileDefinition

Initializers

import { NetworkFileDefinition } from 'cdk-aws-iotfleetwise'

new NetworkFileDefinition()

Name	Type	Description

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

S3ConfigProperty

Initializers

import { S3ConfigProperty } from 'cdk-aws-iotfleetwise'

new S3ConfigProperty(bucketArn: string, dataFormat?: string, prefix?: string, storageCompressionFormat?: string)

Name	Type	Description
bucketArn	string	No description.
dataFormat	string	No description.
prefix	string	No description.
storageCompressionFormat	string	No description.

---

bucketArn^Required

• Type: string

---

dataFormat^Optional

• Type: string

---

prefix^Optional

• Type: string

---

storageCompressionFormat^Optional

• Type: string

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

SignalCatalogActuator

Initializers

import { SignalCatalogActuator } from 'cdk-aws-iotfleetwise'

new SignalCatalogActuator(props: SignalCatalogActuatorProps)

Name	Type	Description
props	SignalCatalogActuatorProps	No description.

---

props^Required

• Type: SignalCatalogActuatorProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

SignalCatalogAttribute

Initializers

import { SignalCatalogAttribute } from 'cdk-aws-iotfleetwise'

new SignalCatalogAttribute(props: SignalCatalogAttributeProps)

Name	Type	Description
props	SignalCatalogAttributeProps	No description.

---

props^Required

• Type: SignalCatalogAttributeProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

SignalCatalogBranch

Initializers

import { SignalCatalogBranch } from 'cdk-aws-iotfleetwise'

new SignalCatalogBranch(props: SignalCatalogBranchProps)

Name	Type	Description
props	SignalCatalogBranchProps	No description.

---

props^Required

• Type: SignalCatalogBranchProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

SignalCatalogNode

Initializers

import { SignalCatalogNode } from 'cdk-aws-iotfleetwise'

new SignalCatalogNode()

Name	Type	Description

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

SignalCatalogSensor

Initializers

import { SignalCatalogSensor } from 'cdk-aws-iotfleetwise'

new SignalCatalogSensor(props: SignalCatalogSensorProps)

Name	Type	Description
props	SignalCatalogSensorProps	No description.

---

props^Required

• Type: SignalCatalogSensorProps

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

TimeBasedCollectionScheme

Initializers

import { TimeBasedCollectionScheme } from 'cdk-aws-iotfleetwise'

new TimeBasedCollectionScheme(period: Duration)

Name	Type	Description
period	aws-cdk-lib.Duration	No description.

---

period^Required

• Type: aws-cdk-lib.Duration

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

TimestreamConfigProperty

Initializers

import { TimestreamConfigProperty } from 'cdk-aws-iotfleetwise'

new TimestreamConfigProperty(executionRoleArn: string, timestreamTableArn: string)

Name	Type	Description
executionRoleArn	string	No description.
timestreamTableArn	string	No description.

---

executionRoleArn^Required

• Type: string

---

timestreamTableArn^Required

• Type: string

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

VehicleInterface

Initializers

import { VehicleInterface } from 'cdk-aws-iotfleetwise'

new VehicleInterface()

Name	Type	Description

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object

VehicleSignal

Initializers

import { VehicleSignal } from 'cdk-aws-iotfleetwise'

new VehicleSignal()

Name	Type	Description

---

Methods

Name	Description
toObject	No description.

---

toObject

public toObject(): object