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

# Example automatically generated from non-compiling source. May contain errors.
from cdk_aws_iotfleetwise import SignalCatalog, VehicleModel, Vehicle, Campaign, CanVehicleInterface, CanVehicleSignal, SignalCatalogBranch, TimeBasedCollectionScheme

signal_catalog = SignalCatalog(stack, "SignalCatalog",
    database=ts_database_construct,
    table=ts_heart_beat_table_construct,
    nodes=[
        SignalCatalogBranch(
            fully_qualified_name="Vehicle"
        ),
        SignalCatalogSensor(
            fully_qualified_name="Vehicle.EngineTorque",
            data_type="DOUBLE"
        )
    ]
)

model_a = VehicleModel(stack, "ModelA",
    signal_catalog=signal_catalog,
    name="modelA",
    description="Model A vehicle",
    network_interfaces=[
        CanVehicleInterface(
            interface_id="1",
            name="vcan0"
        )
    ],
    signals=[
        CanVehicleSignal(
            fully_qualified_name="Vehicle.EngineTorque",
            interface_id="1",
            message_id=401,
            factor=1,
            is_big_endian=True,
            is_signed=False,
            length=8,
            offset=0,
            start_bit=0
        )
    ]
)

vin100 = Vehicle(stack, "vin100",
    vehicle_name="vin100",
    vehicle_model=model_a,
    create_iot_thing=True
)

Campaign(stack, "Campaign",
    name="TimeBasedCampaign",
    target=vin100,
    collection_scheme=TimeBasedCollectionScheme(cdk.Duration.seconds(10)),
    signals=[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 cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Campaign(
  scope: Construct,
  id: str,
  collection_scheme: CollectionScheme,
  data_destination_configs: typing.List[DataDestinationConfig],
  name: str,
  signals: typing.List[CampaignSignal],
  target: Vehicle,
  auto_approve: bool = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No description.
`collection_scheme`	`CollectionScheme`	No description.
`data_destination_configs`	`typing.List[DataDestinationConfig]`	No description.
`name`	`str`	No description.
`signals`	`typing.List[CampaignSignal]`	No description.
`target`	`Vehicle`	No description.
`auto_approve`	`bool`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`collection_scheme`^Required

Type: CollectionScheme

`data_destination_configs`^Required

Type: typing.List[DataDestinationConfig]

`name`^Required

Type: str

`signals`^Required

Type: typing.List[CampaignSignal]

`target`^Required

Type: Vehicle

`auto_approve`^Optional

Type: bool

Methods

Name	Description
`to_string`	Returns a string representation of this construct.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.

`is_construct`

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Campaign.is_construct(
  x: typing.Any
)

Checks if x is a construct.

`x`^Required

Type: typing.Any

Any object.

Properties

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

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`arn`^Required

arn: str

Type: str

`name`^Required

name: str

Type: str

`target`^Required

target: Vehicle

Type: Vehicle

Fleet

The fleet of vehicles.

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Fleet(
  scope: Construct,
  id: str,
  fleet_id: str,
  signal_catalog: SignalCatalog,
  description: str = None,
  vehicles: typing.List[Vehicle] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No description.
`fleet_id`	`str`	No description.
`signal_catalog`	`SignalCatalog`	No description.
`description`	`str`	No description.
`vehicles`	`typing.List[Vehicle]`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`fleet_id`^Required

Type: str

`signal_catalog`^Required

Type: SignalCatalog

`description`^Optional

Type: str

`vehicles`^Optional

Type: typing.List[Vehicle]

Methods

Name	Description
`to_string`	Returns a string representation of this construct.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.

`is_construct`

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Fleet.is_construct(
  x: typing.Any
)

Checks if x is a construct.

`x`^Required

Type: typing.Any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`arn`	`str`	No description.
`fleet_id`	`str`	No description.
`signal_catalog`	`SignalCatalog`	No description.
`vehicles`	`typing.List[Vehicle]`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`arn`^Required

arn: str

Type: str

`fleet_id`^Required

fleet_id: str

Type: str

`signal_catalog`^Required

signal_catalog: SignalCatalog

Type: SignalCatalog

`vehicles`^Optional

vehicles: typing.List[Vehicle]

Type: typing.List[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 cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Logging(
  scope: Construct,
  id: str,
  enable_logging: str,
  log_group_name: str,
  keep_log_group: bool = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No description.
`enable_logging`	`str`	No description.
`log_group_name`	`str`	Name of log group to configure.
`keep_log_group`	`bool`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`enable_logging`^Required

Type: str

`log_group_name`^Required

Type: str

Name of log group to configure.

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

`keep_log_group`^Optional

Type: bool

Methods

Name	Description
`to_string`	Returns a string representation of this construct.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.

`is_construct`

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Logging.is_construct(
  x: typing.Any
)

Checks if x is a construct.

`x`^Required

Type: typing.Any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.

`node`^Required

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 cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalog(
  scope: Construct,
  id: str,
  deregister: bool = None,
  description: str = None,
  name: str = None,
  nodes: typing.List[SignalCatalogNode] = None,
  vss_file: str = None,
  vss_generate_prefix_branch: bool = None,
  vss_prefix: str = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No description.
`deregister`	`bool`	Deregister FleetWise on stack deletion.
`description`	`str`	Description of the Signal Catalog.
`name`	`str`	Name of the Signal Catalog.
`nodes`	`typing.List[SignalCatalogNode]`	An array of signal nodes.
`vss_file`	`str`	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.
`vss_generate_prefix_branch`	`bool`	If set to true, this will parse the vssPrefix into branch nodes.
`vss_prefix`	`str`	A prefix to prepend to the fully qualified names found in the VSS file.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`deregister`^Optional

Type: bool
Default: false

Deregister FleetWise on stack deletion.

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

`description`^Optional

Type: str
Default: None

Description of the Signal Catalog.

If not provided no description is set.

`name`^Optional

Type: str
Default: default

Name of the Signal Catalog.

If not provided, default value is used.

`nodes`^Optional

Type: typing.List[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.

`vss_file`^Optional

Type: str
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.

`vss_generate_prefix_branch`^Optional

Type: bool
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.

`vss_prefix`^Optional

Type: str
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.

Methods

Name	Description
`to_string`	Returns a string representation of this construct.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.

`is_construct`

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalog.is_construct(
  x: typing.Any
)

Checks if x is a construct.

`x`^Required

Type: typing.Any

Any object.

Properties

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

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`arn`^Required

arn: str

Type: str

`description`^Required

description: str

Type: str

`name`^Required

name: str

Type: str

The name of the signal catalog.

Vehicle

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

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Vehicle(
  scope: Construct,
  id: str,
  create_iot_thing: bool,
  vehicle_model: VehicleModel,
  vehicle_name: str,
  attributes: typing.Mapping[str] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No description.
`create_iot_thing`	`bool`	No description.
`vehicle_model`	`VehicleModel`	No description.
`vehicle_name`	`str`	No description.
`attributes`	`typing.Mapping[str]`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`create_iot_thing`^Required

Type: bool

`vehicle_model`^Required

Type: VehicleModel

`vehicle_name`^Required

Type: str

`attributes`^Optional

Type: typing.Mapping[str]

Methods

Name	Description
`to_string`	Returns a string representation of this construct.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.

`is_construct`

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.Vehicle.is_construct(
  x: typing.Any
)

Checks if x is a construct.

`x`^Required

Type: typing.Any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`arn`	`str`	No description.
`vehicle_model`	`VehicleModel`	No description.
`vehicle_name`	`str`	No description.
`certificate_arn`	`str`	No description.
`certificate_id`	`str`	No description.
`certificate_pem`	`str`	No description.
`endpoint_address`	`str`	No description.
`private_key`	`str`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`arn`^Required

arn: str

Type: str

`vehicle_model`^Required

vehicle_model: VehicleModel

Type: VehicleModel

`vehicle_name`^Required

vehicle_name: str

Type: str

`certificate_arn`^Optional

certificate_arn: str

Type: str

`certificate_id`^Optional

certificate_id: str

Type: str

`certificate_pem`^Optional

certificate_pem: str

Type: str

`endpoint_address`^Optional

endpoint_address: str

Type: str

`private_key`^Optional

private_key: str

Type: str

VehicleModel

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.VehicleModel(
  scope: Construct,
  id: str,
  name: str,
  network_interfaces: typing.List[VehicleInterface],
  signal_catalog: SignalCatalog,
  description: str = None,
  network_file_definitions: typing.List[NetworkFileDefinition] = None,
  signals: typing.List[VehicleSignal] = None
)

Name	Type	Description
`scope`	`constructs.Construct`	No description.
`id`	`str`	No description.
`name`	`str`	No description.
`network_interfaces`	`typing.List[VehicleInterface]`	No description.
`signal_catalog`	`SignalCatalog`	No description.
`description`	`str`	No description.
`network_file_definitions`	`typing.List[NetworkFileDefinition]`	No description.
`signals`	`typing.List[VehicleSignal]`	No description.

`scope`^Required

Type: constructs.Construct

`id`^Required

Type: str

`name`^Required

Type: str

`network_interfaces`^Required

Type: typing.List[VehicleInterface]

`signal_catalog`^Required

Type: SignalCatalog

`description`^Optional

Type: str

`network_file_definitions`^Optional

Type: typing.List[NetworkFileDefinition]

`signals`^Optional

Type: typing.List[VehicleSignal]

Methods

Name	Description
`to_string`	Returns a string representation of this construct.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

Static Functions

Name	Description
`is_construct`	Checks if `x` is a construct.

`is_construct`

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.VehicleModel.is_construct(
  x: typing.Any
)

Checks if x is a construct.

`x`^Required

Type: typing.Any

Any object.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`name`	`str`	No description.
`signal_catalog`	`SignalCatalog`	No description.

`node`^Required

node: Node

Type: constructs.Node

The tree node.

`name`^Required

name: str

Type: str

`signal_catalog`^Required

signal_catalog: SignalCatalog

Type: SignalCatalog

Structs

AttributeVehicleSignalProps

Attribute Signal - needed when creating a vehicle with attributes.

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.AttributeVehicleSignalProps(
  fully_qualified_name: str
)

Properties

Name	Type	Description
`fully_qualified_name`	`str`	No description.

`fully_qualified_name`^Required

fully_qualified_name: str

Type: str

CampaignProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CampaignProps(
  collection_scheme: CollectionScheme,
  data_destination_configs: typing.List[DataDestinationConfig],
  name: str,
  signals: typing.List[CampaignSignal],
  target: Vehicle,
  auto_approve: bool = None
)

Properties

Name	Type	Description
`collection_scheme`	`CollectionScheme`	No description.
`data_destination_configs`	`typing.List[DataDestinationConfig]`	No description.
`name`	`str`	No description.
`signals`	`typing.List[CampaignSignal]`	No description.
`target`	`Vehicle`	No description.
`auto_approve`	`bool`	No description.

`collection_scheme`^Required

collection_scheme: CollectionScheme

Type: CollectionScheme

`data_destination_configs`^Required

data_destination_configs: typing.List[DataDestinationConfig]

Type: typing.List[DataDestinationConfig]

`name`^Required

name: str

Type: str

`signals`^Required

signals: typing.List[CampaignSignal]

Type: typing.List[CampaignSignal]

`target`^Required

target: Vehicle

Type: Vehicle

`auto_approve`^Optional

auto_approve: bool

Type: bool

CanVehicleInterfaceProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CanVehicleInterfaceProps(
  interface_id: str,
  name: str,
  protocol_name: str = None,
  protocol_version: str = None
)

Properties

Name	Type	Description
`interface_id`	`str`	No description.
`name`	`str`	No description.
`protocol_name`	`str`	No description.
`protocol_version`	`str`	No description.

`interface_id`^Required

interface_id: str

Type: str

`name`^Required

name: str

Type: str

`protocol_name`^Optional

protocol_name: str

Type: str

`protocol_version`^Optional

protocol_version: str

Type: str

CanVehicleSignalProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CanVehicleSignalProps(
  factor: typing.Union[int, float],
  fully_qualified_name: str,
  interface_id: str,
  is_big_endian: bool,
  is_signed: bool,
  length: typing.Union[int, float],
  message_id: typing.Union[int, float],
  offset: typing.Union[int, float],
  start_bit: typing.Union[int, float],
  name: str = None
)

Properties

Name	Type	Description
`factor`	`typing.Union[int, float]`	No description.
`fully_qualified_name`	`str`	No description.
`interface_id`	`str`	No description.
`is_big_endian`	`bool`	No description.
`is_signed`	`bool`	No description.
`length`	`typing.Union[int, float]`	No description.
`message_id`	`typing.Union[int, float]`	No description.
`offset`	`typing.Union[int, float]`	No description.
`start_bit`	`typing.Union[int, float]`	No description.
`name`	`str`	No description.

`factor`^Required

factor: typing.Union[int, float]

Type: typing.Union[int, float]

`fully_qualified_name`^Required

fully_qualified_name: str

Type: str

`interface_id`^Required

interface_id: str

Type: str

`is_big_endian`^Required

is_big_endian: bool

Type: bool

`is_signed`^Required

is_signed: bool

Type: bool

`length`^Required

length: typing.Union[int, float]

Type: typing.Union[int, float]

`message_id`^Required

message_id: typing.Union[int, float]

Type: typing.Union[int, float]

`offset`^Required

offset: typing.Union[int, float]

Type: typing.Union[int, float]

`start_bit`^Required

start_bit: typing.Union[int, float]

Type: typing.Union[int, float]

`name`^Optional

name: str

Type: str

FleetProps

Interface.

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.FleetProps(
  fleet_id: str,
  signal_catalog: SignalCatalog,
  description: str = None,
  vehicles: typing.List[Vehicle] = None
)

Properties

Name	Type	Description
`fleet_id`	`str`	No description.
`signal_catalog`	`SignalCatalog`	No description.
`description`	`str`	No description.
`vehicles`	`typing.List[Vehicle]`	No description.

`fleet_id`^Required

fleet_id: str

Type: str

`signal_catalog`^Required

signal_catalog: SignalCatalog

Type: SignalCatalog

`description`^Optional

description: str

Type: str

`vehicles`^Optional

vehicles: typing.List[Vehicle]

Type: typing.List[Vehicle]

LoggingProps

FleetWise Logging Properties.

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.LoggingProps(
  enable_logging: str,
  log_group_name: str,
  keep_log_group: bool = None
)

Properties

Name	Type	Description
`enable_logging`	`str`	No description.
`log_group_name`	`str`	Name of log group to configure.
`keep_log_group`	`bool`	No description.

`enable_logging`^Required

enable_logging: str

Type: str

`log_group_name`^Required

log_group_name: str

Type: str

Name of log group to configure.

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

`keep_log_group`^Optional

keep_log_group: bool

Type: bool

SignalCatalogActuatorProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogActuatorProps(
  data_type: str,
  fully_qualified_name: str,
  allowed_values: typing.List[str] = None,
  assigned_value: str = None,
  description: str = None,
  max: typing.Union[int, float] = None,
  min: typing.Union[int, float] = None,
  unit: str = None
)

Properties

Name	Type	Description
`data_type`	`str`	No description.
`fully_qualified_name`	`str`	No description.
`allowed_values`	`typing.List[str]`	No description.
`assigned_value`	`str`	No description.
`description`	`str`	No description.
`max`	`typing.Union[int, float]`	No description.
`min`	`typing.Union[int, float]`	No description.
`unit`	`str`	No description.

`data_type`^Required

data_type: str

Type: str

`fully_qualified_name`^Required

fully_qualified_name: str

Type: str

`allowed_values`^Optional

allowed_values: typing.List[str]

Type: typing.List[str]

`assigned_value`^Optional

assigned_value: str

Type: str

`description`^Optional

description: str

Type: str

`max`^Optional

max: typing.Union[int, float]

Type: typing.Union[int, float]

`min`^Optional

min: typing.Union[int, float]

Type: typing.Union[int, float]

`unit`^Optional

unit: str

Type: str

SignalCatalogAttributeProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogAttributeProps(
  data_type: str,
  fully_qualified_name: str,
  allowed_values: typing.List[str] = None,
  assigned_value: str = None,
  default_value: str = None,
  description: str = None,
  max: typing.Union[int, float] = None,
  min: typing.Union[int, float] = None,
  unit: str = None
)

Properties

Name	Type	Description
`data_type`	`str`	No description.
`fully_qualified_name`	`str`	No description.
`allowed_values`	`typing.List[str]`	No description.
`assigned_value`	`str`	No description.
`default_value`	`str`	No description.
`description`	`str`	No description.
`max`	`typing.Union[int, float]`	No description.
`min`	`typing.Union[int, float]`	No description.
`unit`	`str`	No description.

`data_type`^Required

data_type: str

Type: str

`fully_qualified_name`^Required

fully_qualified_name: str

Type: str

`allowed_values`^Optional

allowed_values: typing.List[str]

Type: typing.List[str]

`assigned_value`^Optional

assigned_value: str

Type: str

`default_value`^Optional

default_value: str

Type: str

`description`^Optional

description: str

Type: str

`max`^Optional

max: typing.Union[int, float]

Type: typing.Union[int, float]

`min`^Optional

min: typing.Union[int, float]

Type: typing.Union[int, float]

`unit`^Optional

unit: str

Type: str

SignalCatalogBranchProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogBranchProps(
  fully_qualified_name: str,
  description: str = None
)

Properties

Name	Type	Description
`fully_qualified_name`	`str`	No description.
`description`	`str`	No description.

`fully_qualified_name`^Required

fully_qualified_name: str

Type: str

`description`^Optional

description: str

Type: str

SignalCatalogProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogProps(
  deregister: bool = None,
  description: str = None,
  name: str = None,
  nodes: typing.List[SignalCatalogNode] = None,
  vss_file: str = None,
  vss_generate_prefix_branch: bool = None,
  vss_prefix: str = None
)

Properties

Name	Type	Description
`deregister`	`bool`	Deregister FleetWise on stack deletion.
`description`	`str`	Description of the Signal Catalog.
`name`	`str`	Name of the Signal Catalog.
`nodes`	`typing.List[SignalCatalogNode]`	An array of signal nodes.
`vss_file`	`str`	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.
`vss_generate_prefix_branch`	`bool`	If set to true, this will parse the vssPrefix into branch nodes.
`vss_prefix`	`str`	A prefix to prepend to the fully qualified names found in the VSS file.

`deregister`^Optional

deregister: bool

Type: bool
Default: false

Deregister FleetWise on stack deletion.

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

`description`^Optional

description: str

Type: str
Default: None

Description of the Signal Catalog.

If not provided no description is set.

`name`^Optional

name: str

Type: str
Default: default

Name of the Signal Catalog.

If not provided, default value is used.

`nodes`^Optional

nodes: typing.List[SignalCatalogNode]

Type: typing.List[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.

`vss_file`^Optional

vss_file: str

Type: str
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.

`vss_generate_prefix_branch`^Optional

vss_generate_prefix_branch: bool

Type: bool
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.

`vss_prefix`^Optional

vss_prefix: str

Type: str
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 cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogSensorProps(
  data_type: str,
  fully_qualified_name: str,
  allowed_values: typing.List[str] = None,
  description: str = None,
  max: typing.Union[int, float] = None,
  min: typing.Union[int, float] = None,
  unit: str = None
)

Properties

Name	Type	Description
`data_type`	`str`	No description.
`fully_qualified_name`	`str`	No description.
`allowed_values`	`typing.List[str]`	No description.
`description`	`str`	No description.
`max`	`typing.Union[int, float]`	No description.
`min`	`typing.Union[int, float]`	No description.
`unit`	`str`	No description.

`data_type`^Required

data_type: str

Type: str

`fully_qualified_name`^Required

fully_qualified_name: str

Type: str

`allowed_values`^Optional

allowed_values: typing.List[str]

Type: typing.List[str]

`description`^Optional

description: str

Type: str

`max`^Optional

max: typing.Union[int, float]

Type: typing.Union[int, float]

`min`^Optional

min: typing.Union[int, float]

Type: typing.Union[int, float]

`unit`^Optional

unit: str

Type: str

VehicleModelProps

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.VehicleModelProps(
  name: str,
  network_interfaces: typing.List[VehicleInterface],
  signal_catalog: SignalCatalog,
  description: str = None,
  network_file_definitions: typing.List[NetworkFileDefinition] = None,
  signals: typing.List[VehicleSignal] = None
)

Properties

Name	Type	Description
`name`	`str`	No description.
`network_interfaces`	`typing.List[VehicleInterface]`	No description.
`signal_catalog`	`SignalCatalog`	No description.
`description`	`str`	No description.
`network_file_definitions`	`typing.List[NetworkFileDefinition]`	No description.
`signals`	`typing.List[VehicleSignal]`	No description.

`name`^Required

name: str

Type: str

`network_interfaces`^Required

network_interfaces: typing.List[VehicleInterface]

Type: typing.List[VehicleInterface]

`signal_catalog`^Required

signal_catalog: SignalCatalog

Type: SignalCatalog

`description`^Optional

description: str

Type: str

`network_file_definitions`^Optional

network_file_definitions: typing.List[NetworkFileDefinition]

Type: typing.List[NetworkFileDefinition]

`signals`^Optional

signals: typing.List[VehicleSignal]

Type: typing.List[VehicleSignal]

VehicleProps

Interface.

Initializer

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.VehicleProps(
  create_iot_thing: bool,
  vehicle_model: VehicleModel,
  vehicle_name: str,
  attributes: typing.Mapping[str] = None
)

Properties

Name	Type	Description
`create_iot_thing`	`bool`	No description.
`vehicle_model`	`VehicleModel`	No description.
`vehicle_name`	`str`	No description.
`attributes`	`typing.Mapping[str]`	No description.

`create_iot_thing`^Required

create_iot_thing: bool

Type: bool

`vehicle_model`^Required

vehicle_model: VehicleModel

Type: VehicleModel

`vehicle_name`^Required

vehicle_name: str

Type: str

`attributes`^Optional

attributes: typing.Mapping[str]

Type: typing.Mapping[str]

Classes

AttributeVehicleSignal

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.AttributeVehicleSignal(
  fully_qualified_name: str
)

Name	Type	Description
`fully_qualified_name`	`str`	No description.

`fully_qualified_name`^Required

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

CampaignSignal

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CampaignSignal(
  name: str,
  max_sample_count: typing.Union[int, float] = None,
  minimum_sampling_interval: Duration = None
)

Name	Type	Description
`name`	`str`	No description.
`max_sample_count`	`typing.Union[int, float]`	No description.
`minimum_sampling_interval`	`aws_cdk.Duration`	No description.

`name`^Required

Type: str

`max_sample_count`^Optional

Type: typing.Union[int, float]

`minimum_sampling_interval`^Optional

Type: aws_cdk.Duration

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

CanDefinition

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CanDefinition(
  network_interface: str,
  signals_map: typing.Mapping[str],
  can_dbc_files: typing.List[str]
)

Name	Type	Description
`network_interface`	`str`	No description.
`signals_map`	`typing.Mapping[str]`	No description.
`can_dbc_files`	`typing.List[str]`	No description.

`network_interface`^Required

Type: str

`signals_map`^Required

Type: typing.Mapping[str]

`can_dbc_files`^Required

Type: typing.List[str]

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

CanVehicleInterface

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CanVehicleInterface(
  interface_id: str,
  name: str,
  protocol_name: str = None,
  protocol_version: str = None
)

Name	Type	Description
`interface_id`	`str`	No description.
`name`	`str`	No description.
`protocol_name`	`str`	No description.
`protocol_version`	`str`	No description.

`interface_id`^Required

Type: str

`name`^Required

Type: str

`protocol_name`^Optional

Type: str

`protocol_version`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

CanVehicleSignal

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CanVehicleSignal(
  factor: typing.Union[int, float],
  fully_qualified_name: str,
  interface_id: str,
  is_big_endian: bool,
  is_signed: bool,
  length: typing.Union[int, float],
  message_id: typing.Union[int, float],
  offset: typing.Union[int, float],
  start_bit: typing.Union[int, float],
  name: str = None
)

Name	Type	Description
`factor`	`typing.Union[int, float]`	No description.
`fully_qualified_name`	`str`	No description.
`interface_id`	`str`	No description.
`is_big_endian`	`bool`	No description.
`is_signed`	`bool`	No description.
`length`	`typing.Union[int, float]`	No description.
`message_id`	`typing.Union[int, float]`	No description.
`offset`	`typing.Union[int, float]`	No description.
`start_bit`	`typing.Union[int, float]`	No description.
`name`	`str`	No description.

`factor`^Required

Type: typing.Union[int, float]

`fully_qualified_name`^Required

Type: str

`interface_id`^Required

Type: str

`is_big_endian`^Required

Type: bool

`is_signed`^Required

Type: bool

`length`^Required

Type: typing.Union[int, float]

`message_id`^Required

Type: typing.Union[int, float]

`offset`^Required

Type: typing.Union[int, float]

`start_bit`^Required

Type: typing.Union[int, float]

`name`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

CollectionScheme

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.CollectionScheme()

Name	Type	Description

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

DataDestinationConfig

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.DataDestinationConfig()

Name	Type	Description

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

NetworkFileDefinition

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.NetworkFileDefinition()

Name	Type	Description

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

S3ConfigProperty

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.S3ConfigProperty(
  bucket_arn: str,
  data_format: str = None,
  prefix: str = None,
  storage_compression_format: str = None
)

Name	Type	Description
`bucket_arn`	`str`	No description.
`data_format`	`str`	No description.
`prefix`	`str`	No description.
`storage_compression_format`	`str`	No description.

`bucket_arn`^Required

Type: str

`data_format`^Optional

Type: str

`prefix`^Optional

Type: str

`storage_compression_format`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

SignalCatalogActuator

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogActuator(
  data_type: str,
  fully_qualified_name: str,
  allowed_values: typing.List[str] = None,
  assigned_value: str = None,
  description: str = None,
  max: typing.Union[int, float] = None,
  min: typing.Union[int, float] = None,
  unit: str = None
)

Name	Type	Description
`data_type`	`str`	No description.
`fully_qualified_name`	`str`	No description.
`allowed_values`	`typing.List[str]`	No description.
`assigned_value`	`str`	No description.
`description`	`str`	No description.
`max`	`typing.Union[int, float]`	No description.
`min`	`typing.Union[int, float]`	No description.
`unit`	`str`	No description.

`data_type`^Required

Type: str

`fully_qualified_name`^Required

Type: str

`allowed_values`^Optional

Type: typing.List[str]

`assigned_value`^Optional

Type: str

`description`^Optional

Type: str

`max`^Optional

Type: typing.Union[int, float]

`min`^Optional

Type: typing.Union[int, float]

`unit`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

SignalCatalogAttribute

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogAttribute(
  data_type: str,
  fully_qualified_name: str,
  allowed_values: typing.List[str] = None,
  assigned_value: str = None,
  default_value: str = None,
  description: str = None,
  max: typing.Union[int, float] = None,
  min: typing.Union[int, float] = None,
  unit: str = None
)

Name	Type	Description
`data_type`	`str`	No description.
`fully_qualified_name`	`str`	No description.
`allowed_values`	`typing.List[str]`	No description.
`assigned_value`	`str`	No description.
`default_value`	`str`	No description.
`description`	`str`	No description.
`max`	`typing.Union[int, float]`	No description.
`min`	`typing.Union[int, float]`	No description.
`unit`	`str`	No description.

`data_type`^Required

Type: str

`fully_qualified_name`^Required

Type: str

`allowed_values`^Optional

Type: typing.List[str]

`assigned_value`^Optional

Type: str

`default_value`^Optional

Type: str

`description`^Optional

Type: str

`max`^Optional

Type: typing.Union[int, float]

`min`^Optional

Type: typing.Union[int, float]

`unit`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

SignalCatalogBranch

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogBranch(
  fully_qualified_name: str,
  description: str = None
)

Name	Type	Description
`fully_qualified_name`	`str`	No description.
`description`	`str`	No description.

`fully_qualified_name`^Required

Type: str

`description`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

SignalCatalogNode

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogNode()

Name	Type	Description

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

SignalCatalogSensor

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.SignalCatalogSensor(
  data_type: str,
  fully_qualified_name: str,
  allowed_values: typing.List[str] = None,
  description: str = None,
  max: typing.Union[int, float] = None,
  min: typing.Union[int, float] = None,
  unit: str = None
)

Name	Type	Description
`data_type`	`str`	No description.
`fully_qualified_name`	`str`	No description.
`allowed_values`	`typing.List[str]`	No description.
`description`	`str`	No description.
`max`	`typing.Union[int, float]`	No description.
`min`	`typing.Union[int, float]`	No description.
`unit`	`str`	No description.

`data_type`^Required

Type: str

`fully_qualified_name`^Required

Type: str

`allowed_values`^Optional

Type: typing.List[str]

`description`^Optional

Type: str

`max`^Optional

Type: typing.Union[int, float]

`min`^Optional

Type: typing.Union[int, float]

`unit`^Optional

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

TimeBasedCollectionScheme

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.TimeBasedCollectionScheme(
  period: Duration
)

Name	Type	Description
`period`	`aws_cdk.Duration`	No description.

`period`^Required

Type: aws_cdk.Duration

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

TimestreamConfigProperty

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.TimestreamConfigProperty(
  execution_role_arn: str,
  timestream_table_arn: str
)

Name	Type	Description
`execution_role_arn`	`str`	No description.
`timestream_table_arn`	`str`	No description.

`execution_role_arn`^Required

Type: str

`timestream_table_arn`^Required

Type: str

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

VehicleInterface

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.VehicleInterface()

Name	Type	Description

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

VehicleSignal

Initializers

import cdk_aws_iotfleetwise

cdk_aws_iotfleetwise.VehicleSignal()

Name	Type	Description

Methods

Name	Description
`to_object`	No description.

`to_object`

def to_object() -> any

Files

api-python.md

Latest commit

History

api-python.md

File metadata and controls

cdk-aws-iotfleetwise

Install

Typescript

Python

Sample

Getting started

TODO

Security

License

API Reference

Constructs

Campaign

Initializers

scopeRequired

idRequired

collection_schemeRequired

data_destination_configsRequired

nameRequired

signalsRequired

targetRequired

auto_approveOptional

Methods

to_string

Static Functions

is_construct

xRequired

Properties

nodeRequired

arnRequired

nameRequired

targetRequired

Fleet

Initializers

scopeRequired

idRequired

fleet_idRequired

signal_catalogRequired

descriptionOptional

vehiclesOptional

Methods

to_string

Static Functions

is_construct

xRequired

Properties

nodeRequired

arnRequired

fleet_idRequired

signal_catalogRequired

vehiclesOptional

Logging

Initializers

scopeRequired

idRequired

enable_loggingRequired

log_group_nameRequired

keep_log_groupOptional

Methods

to_string

Static Functions

is_construct

xRequired

Properties

nodeRequired

SignalCatalog

Initializers

scopeRequired

idRequired

deregisterOptional

descriptionOptional

nameOptional

nodesOptional

vss_fileOptional

vss_generate_prefix_branchOptional

`scope`^Required

`id`^Required

`collection_scheme`^Required

`data_destination_configs`^Required

`name`^Required

`signals`^Required

`target`^Required

`auto_approve`^Optional

`to_string`

`is_construct`

`x`^Required

`node`^Required

`arn`^Required

`name`^Required

`target`^Required

`scope`^Required

`id`^Required

`fleet_id`^Required

`signal_catalog`^Required

`description`^Optional

`vehicles`^Optional

`to_string`

`is_construct`

`x`^Required

`node`^Required

`arn`^Required

`fleet_id`^Required

`signal_catalog`^Required

`vehicles`^Optional

`scope`^Required

`id`^Required

`enable_logging`^Required

`log_group_name`^Required

`keep_log_group`^Optional

`to_string`

`is_construct`

`x`^Required

`node`^Required

`scope`^Required

`id`^Required

`deregister`^Optional

`description`^Optional

`name`^Optional

`nodes`^Optional

`vss_file`^Optional

`vss_generate_prefix_branch`^Optional

`vss_prefix`^Optional

`to_string`

`is_construct`

`x`^Required

`node`^Required

`arn`^Required

`description`^Required

`name`^Required

`scope`^Required

`id`^Required

`create_iot_thing`^Required

`vehicle_model`^Required

`vehicle_name`^Required

`attributes`^Optional

`to_string`

`is_construct`

`x`^Required

`node`^Required

`arn`^Required

`vehicle_model`^Required

`vehicle_name`^Required

`certificate_arn`^Optional

`certificate_id`^Optional

`certificate_pem`^Optional

`endpoint_address`^Optional

`private_key`^Optional

`scope`^Required

`id`^Required

`name`^Required

`network_interfaces`^Required

`signal_catalog`^Required

`description`^Optional

`network_file_definitions`^Optional

`signals`^Optional