# API Reference ## Constructs ### Campaign #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.Campaign( scope: Construct, id: str, collection_scheme: CollectionScheme, 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.* | | 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 --- ##### `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` ```python 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`~~ ```python 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 ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ##### `arn`Required ```python arn: str ``` - *Type:* str --- ##### `name`Required ```python name: str ``` - *Type:* str --- ##### `target`Required ```python target: Vehicle ``` - *Type:* Vehicle --- ### Fleet The fleet of vehicles. #### Initializers ```python 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` ```python 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`~~ ```python 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 ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ##### `arn`Required ```python arn: str ``` - *Type:* str --- ##### `fleet_id`Required ```python fleet_id: str ``` - *Type:* str --- ##### `signal_catalog`Required ```python signal_catalog: SignalCatalog ``` - *Type:* SignalCatalog --- ##### `vehicles`Optional ```python vehicles: typing.List[Vehicle] ``` - *Type:* typing.List[Vehicle] --- ### 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 ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.SignalCatalog( scope: Construct, id: str, database: CfnDatabase, nodes: typing.List[SignalCatalogNode], table: CfnTable, description: str = None, name: str = None ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | scope | constructs.Construct | *No description.* | | id | str | *No description.* | | database | aws_cdk.aws_timestream.CfnDatabase | *No description.* | | nodes | typing.List[SignalCatalogNode] | *No description.* | | table | aws_cdk.aws_timestream.CfnTable | *No description.* | | description | str | *No description.* | | name | str | *No description.* | --- ##### `scope`Required - *Type:* constructs.Construct --- ##### `id`Required - *Type:* str --- ##### `database`Required - *Type:* aws_cdk.aws_timestream.CfnDatabase --- ##### `nodes`Required - *Type:* typing.List[SignalCatalogNode] --- ##### `table`Required - *Type:* aws_cdk.aws_timestream.CfnTable --- ##### `description`Optional - *Type:* str --- ##### `name`Optional - *Type:* str --- #### Methods | **Name** | **Description** | | --- | --- | | to_string | Returns a string representation of this construct. | --- ##### `to_string` ```python 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`~~ ```python 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.* | | name | str | The name of the signal catalog. | | description | str | *No description.* | --- ##### `node`Required ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ##### `arn`Required ```python arn: str ``` - *Type:* str --- ##### `name`Required ```python name: str ``` - *Type:* str The name of the signal catalog. --- ##### `description`Optional ```python description: str ``` - *Type:* str --- ### Vehicle The vehicle of a specific type from which IoT FleetWise collect signals. #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.Vehicle( scope: Construct, id: str, create_iot_thing: bool, vehicle_model: VehicleModel, vehicle_name: str ) ``` | **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.* | --- ##### `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 --- #### Methods | **Name** | **Description** | | --- | --- | | to_string | Returns a string representation of this construct. | --- ##### `to_string` ```python 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`~~ ```python 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 ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ##### `arn`Required ```python arn: str ``` - *Type:* str --- ##### `vehicle_model`Required ```python vehicle_model: VehicleModel ``` - *Type:* VehicleModel --- ##### `vehicle_name`Required ```python vehicle_name: str ``` - *Type:* str --- ##### `certificate_arn`Optional ```python certificate_arn: str ``` - *Type:* str --- ##### `certificate_id`Optional ```python certificate_id: str ``` - *Type:* str --- ##### `certificate_pem`Optional ```python certificate_pem: str ``` - *Type:* str --- ##### `endpoint_address`Optional ```python endpoint_address: str ``` - *Type:* str --- ##### `private_key`Optional ```python private_key: str ``` - *Type:* str --- ### VehicleModel #### Initializers ```python 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` ```python 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`~~ ```python 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 ```python node: Node ``` - *Type:* constructs.Node The tree node. --- ##### `name`Required ```python name: str ``` - *Type:* str --- ##### `signal_catalog`Required ```python signal_catalog: SignalCatalog ``` - *Type:* SignalCatalog --- ## Structs ### CampaignProps #### Initializer ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.CampaignProps( collection_scheme: CollectionScheme, name: str, signals: typing.List[CampaignSignal], target: Vehicle, auto_approve: bool = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | collection_scheme | CollectionScheme | *No description.* | | name | str | *No description.* | | signals | typing.List[CampaignSignal] | *No description.* | | target | Vehicle | *No description.* | | auto_approve | bool | *No description.* | --- ##### `collection_scheme`Required ```python collection_scheme: CollectionScheme ``` - *Type:* CollectionScheme --- ##### `name`Required ```python name: str ``` - *Type:* str --- ##### `signals`Required ```python signals: typing.List[CampaignSignal] ``` - *Type:* typing.List[CampaignSignal] --- ##### `target`Required ```python target: Vehicle ``` - *Type:* Vehicle --- ##### `auto_approve`Optional ```python auto_approve: bool ``` - *Type:* bool --- ### FleetProps Interface. #### Initializer ```python 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 ```python fleet_id: str ``` - *Type:* str --- ##### `signal_catalog`Required ```python signal_catalog: SignalCatalog ``` - *Type:* SignalCatalog --- ##### `description`Optional ```python description: str ``` - *Type:* str --- ##### `vehicles`Optional ```python vehicles: typing.List[Vehicle] ``` - *Type:* typing.List[Vehicle] --- ### SignalCatalogProps #### Initializer ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.SignalCatalogProps( database: CfnDatabase, nodes: typing.List[SignalCatalogNode], table: CfnTable, description: str = None, name: str = None ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | database | aws_cdk.aws_timestream.CfnDatabase | *No description.* | | nodes | typing.List[SignalCatalogNode] | *No description.* | | table | aws_cdk.aws_timestream.CfnTable | *No description.* | | description | str | *No description.* | | name | str | *No description.* | --- ##### `database`Required ```python database: CfnDatabase ``` - *Type:* aws_cdk.aws_timestream.CfnDatabase --- ##### `nodes`Required ```python nodes: typing.List[SignalCatalogNode] ``` - *Type:* typing.List[SignalCatalogNode] --- ##### `table`Required ```python table: CfnTable ``` - *Type:* aws_cdk.aws_timestream.CfnTable --- ##### `description`Optional ```python description: str ``` - *Type:* str --- ##### `name`Optional ```python name: str ``` - *Type:* str --- ### VehicleModelProps #### Initializer ```python 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 ```python name: str ``` - *Type:* str --- ##### `network_interfaces`Required ```python network_interfaces: typing.List[VehicleInterface] ``` - *Type:* typing.List[VehicleInterface] --- ##### `signal_catalog`Required ```python signal_catalog: SignalCatalog ``` - *Type:* SignalCatalog --- ##### `description`Optional ```python description: str ``` - *Type:* str --- ##### `network_file_definitions`Optional ```python network_file_definitions: typing.List[NetworkFileDefinition] ``` - *Type:* typing.List[NetworkFileDefinition] --- ##### `signals`Optional ```python signals: typing.List[VehicleSignal] ``` - *Type:* typing.List[VehicleSignal] --- ### VehicleProps Interface. #### Initializer ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.VehicleProps( create_iot_thing: bool, vehicle_model: VehicleModel, vehicle_name: str ) ``` #### Properties | **Name** | **Type** | **Description** | | --- | --- | --- | | create_iot_thing | bool | *No description.* | | vehicle_model | VehicleModel | *No description.* | | vehicle_name | str | *No description.* | --- ##### `create_iot_thing`Required ```python create_iot_thing: bool ``` - *Type:* bool --- ##### `vehicle_model`Required ```python vehicle_model: VehicleModel ``` - *Type:* VehicleModel --- ##### `vehicle_name`Required ```python vehicle_name: str ``` - *Type:* str --- ## Classes ### CampaignSignal #### Initializers ```python 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` ```python def to_object() -> any ``` ### CanDefinition #### Initializers ```python 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` ```python def to_object() -> any ``` ### CanVehicleInterface #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.CanVehicleInterface( interface_id: str, name: str ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | interface_id | str | *No description.* | | name | str | *No description.* | --- ##### `interface_id`Required - *Type:* str --- ##### `name`Required - *Type:* str --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### CanVehicleSignal #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.CanVehicleSignal( fully_qualified_name: str, interface_id: str, message_id: typing.Union[int, float], factor: typing.Union[int, float], is_big_endian: bool, is_signed: bool, length: typing.Union[int, float], offset: typing.Union[int, float], start_bit: typing.Union[int, float] ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | fully_qualified_name | str | *No description.* | | interface_id | str | *No description.* | | message_id | typing.Union[int, float] | *No description.* | | factor | typing.Union[int, float] | *No description.* | | is_big_endian | bool | *No description.* | | is_signed | bool | *No description.* | | length | typing.Union[int, float] | *No description.* | | offset | typing.Union[int, float] | *No description.* | | start_bit | typing.Union[int, float] | *No description.* | --- ##### `fully_qualified_name`Required - *Type:* str --- ##### `interface_id`Required - *Type:* str --- ##### `message_id`Required - *Type:* typing.Union[int, float] --- ##### `factor`Required - *Type:* typing.Union[int, float] --- ##### `is_big_endian`Required - *Type:* bool --- ##### `is_signed`Required - *Type:* bool --- ##### `length`Required - *Type:* typing.Union[int, float] --- ##### `offset`Required - *Type:* typing.Union[int, float] --- ##### `start_bit`Required - *Type:* typing.Union[int, float] --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### CollectionScheme #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.CollectionScheme() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### NetworkFileDefinition #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.NetworkFileDefinition() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### SignalCatalogBranch #### Initializers ```python 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` ```python def to_object() -> any ``` ### SignalCatalogNode #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.SignalCatalogNode() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### SignalCatalogSensor #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.SignalCatalogSensor( fully_qualified_name: str, data_type: str, unit: str = None, min: typing.Union[int, float] = None, max: typing.Union[int, float] = None, description: str = None ) ``` | **Name** | **Type** | **Description** | | --- | --- | --- | | fully_qualified_name | str | *No description.* | | data_type | str | *No description.* | | unit | str | *No description.* | | min | typing.Union[int, float] | *No description.* | | max | typing.Union[int, float] | *No description.* | | description | str | *No description.* | --- ##### `fully_qualified_name`Required - *Type:* str --- ##### `data_type`Required - *Type:* str --- ##### `unit`Optional - *Type:* str --- ##### `min`Optional - *Type:* typing.Union[int, float] --- ##### `max`Optional - *Type:* typing.Union[int, float] --- ##### `description`Optional - *Type:* str --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### TimeBasedCollectionScheme #### Initializers ```python 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` ```python def to_object() -> any ``` ### VehicleInterface #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.VehicleInterface() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ``` ### VehicleSignal #### Initializers ```python import cdk_aws_iotfleetwise cdk_aws_iotfleetwise.VehicleSignal() ``` | **Name** | **Type** | **Description** | | --- | --- | --- | --- #### Methods | **Name** | **Description** | | --- | --- | | to_object | *No description.* | --- ##### `to_object` ```python def to_object() -> any ```