fix: updated service api (#21)

* feat: add update to fleet * updated snapshot * align with the first IoTFleetWise GA API * chore: self mutation Signed-off-by: github-actions <github-actions@github.com> Signed-off-by: github-actions <github-actions@github.com> Co-authored-by: github-actions <salamida@amazon.com> Co-authored-by: github-actions <github-actions@github.com>
aws-samples · Oct 7, 2022 · 543600f · 543600f
1 parent 69afb42
commit 543600f
Show file tree

Hide file tree

Showing 16 changed files with 252 additions and 274 deletions.
diff --git a/README.md b/README.md
@@ -42,8 +42,8 @@ const signalCatalog = new SignalCatalog(stack, 'SignalCatalog', {
   table,
   role,
   nodes: [
-    new SignalCatalogBranch('Vehicle', 'Vehicle'),
-    new SignalCatalogSensor('EngineTorque', 'Vehicle.EngineTorque', 'DOUBLE'),
+    new SignalCatalogBranch('Vehicle'),
+    new SignalCatalogSensor('Vehicle.EngineTorque', 'DOUBLE'),
   ],
 });
 
@@ -53,7 +53,7 @@ const model_a = new VehicleModel(stack, 'ModelA', {
   description: 'Model A vehicle',
   networkInterfaces: [new CanVehicleInterface('1', 'vcan0')],
   signals: [
-    new CanVehicleSignal('EngineTorque', 'Vehicle.EngineTorque', '1',
+    new CanVehicleSignal('Vehicle.EngineTorque', '1',
       401, // messageId
       1.0, // factor
       true, // isBigEndian
@@ -65,7 +65,7 @@ const model_a = new VehicleModel(stack, 'ModelA', {
 });
 
 const vin100 = new Vehicle(stack, 'vin100', {
-  vehicleId: 'vin100',
+  vehicleName: 'vin100',
   vehicleModel: model_a,
   createIotThing: true
 });

diff --git a/doc/api-python.md b/doc/api-python.md
@@ -544,8 +544,8 @@ cdk_aws_iotfleetwise.Vehicle(
   scope: Construct,
   id: str,
   create_iot_thing: bool,
-  vehicle_id: str,
-  vehicle_model: VehicleModel
+  vehicle_model: VehicleModel,
+  vehicle_name: str
 )
 ```
 
@@ -554,8 +554,8 @@ cdk_aws_iotfleetwise.Vehicle(
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.id">id</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.createIotThing">create_iot_thing</a></code> | <code>bool</code> | *No description.* |
-| <code><a href="#cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleId">vehicle_id</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleModel">vehicle_model</a></code> | <code><a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a></code> | *No description.* |
+| <code><a href="#cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleName">vehicle_name</a></code> | <code>str</code> | *No description.* |
 
 ---
 
@@ -577,15 +577,15 @@ cdk_aws_iotfleetwise.Vehicle(
 
 ---
 
-##### `vehicle_id`<sup>Required</sup> <a name="vehicle_id" id="cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleId"></a>
+##### `vehicle_model`<sup>Required</sup> <a name="vehicle_model" id="cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleModel"></a>
 
-- *Type:* str
+- *Type:* <a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a>
 
 ---
 
-##### `vehicle_model`<sup>Required</sup> <a name="vehicle_model" id="cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleModel"></a>
+##### `vehicle_name`<sup>Required</sup> <a name="vehicle_name" id="cdk-aws-iotfleetwise.Vehicle.Initializer.parameter.vehicleName"></a>
 
-- *Type:* <a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a>
+- *Type:* str
 
 ---
 
@@ -639,8 +639,8 @@ Any object.
 | --- | --- | --- |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.arn">arn</a></code> | <code>str</code> | *No description.* |
-| <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.vehicleId">vehicle_id</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.vehicleModel">vehicle_model</a></code> | <code><a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a></code> | *No description.* |
+| <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.vehicleName">vehicle_name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.certificateArn">certificate_arn</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.certificateId">certificate_id</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.Vehicle.property.certificatePem">certificate_pem</a></code> | <code>str</code> | *No description.* |
@@ -671,23 +671,23 @@ arn: str
 
 ---
 
-##### `vehicle_id`<sup>Required</sup> <a name="vehicle_id" id="cdk-aws-iotfleetwise.Vehicle.property.vehicleId"></a>
+##### `vehicle_model`<sup>Required</sup> <a name="vehicle_model" id="cdk-aws-iotfleetwise.Vehicle.property.vehicleModel"></a>
 
 ```python
-vehicle_id: str
+vehicle_model: VehicleModel
 ```
 
-- *Type:* str
+- *Type:* <a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a>
 
 ---
 
-##### `vehicle_model`<sup>Required</sup> <a name="vehicle_model" id="cdk-aws-iotfleetwise.Vehicle.property.vehicleModel"></a>
+##### `vehicle_name`<sup>Required</sup> <a name="vehicle_name" id="cdk-aws-iotfleetwise.Vehicle.property.vehicleName"></a>
 
 ```python
-vehicle_model: VehicleModel
+vehicle_name: str
 ```
 
-- *Type:* <a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a>
+- *Type:* str
 
 ---
 
@@ -1248,8 +1248,8 @@ import cdk_aws_iotfleetwise
 
 cdk_aws_iotfleetwise.VehicleProps(
   create_iot_thing: bool,
-  vehicle_id: str,
-  vehicle_model: VehicleModel
+  vehicle_model: VehicleModel,
+  vehicle_name: str
 )
 ```
 
@@ -1258,8 +1258,8 @@ cdk_aws_iotfleetwise.VehicleProps(
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
 | <code><a href="#cdk-aws-iotfleetwise.VehicleProps.property.createIotThing">create_iot_thing</a></code> | <code>bool</code> | *No description.* |
-| <code><a href="#cdk-aws-iotfleetwise.VehicleProps.property.vehicleId">vehicle_id</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.VehicleProps.property.vehicleModel">vehicle_model</a></code> | <code><a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a></code> | *No description.* |
+| <code><a href="#cdk-aws-iotfleetwise.VehicleProps.property.vehicleName">vehicle_name</a></code> | <code>str</code> | *No description.* |
 
 ---
 
@@ -1273,23 +1273,23 @@ create_iot_thing: bool
 
 ---
 
-##### `vehicle_id`<sup>Required</sup> <a name="vehicle_id" id="cdk-aws-iotfleetwise.VehicleProps.property.vehicleId"></a>
+##### `vehicle_model`<sup>Required</sup> <a name="vehicle_model" id="cdk-aws-iotfleetwise.VehicleProps.property.vehicleModel"></a>
 
 ```python
-vehicle_id: str
+vehicle_model: VehicleModel
 ```
 
-- *Type:* str
+- *Type:* <a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a>
 
 ---
 
-##### `vehicle_model`<sup>Required</sup> <a name="vehicle_model" id="cdk-aws-iotfleetwise.VehicleProps.property.vehicleModel"></a>
+##### `vehicle_name`<sup>Required</sup> <a name="vehicle_name" id="cdk-aws-iotfleetwise.VehicleProps.property.vehicleName"></a>
 
 ```python
-vehicle_model: VehicleModel
+vehicle_name: str
 ```
 
-- *Type:* <a href="#cdk-aws-iotfleetwise.VehicleModel">VehicleModel</a>
+- *Type:* str
 
 ---
 
@@ -1466,7 +1466,6 @@ def to_object() -> any
 import cdk_aws_iotfleetwise
 
 cdk_aws_iotfleetwise.CanVehicleSignal(
-  name: str,
   fully_qualified_name: str,
   interface_id: str,
   message_id: typing.Union[int, float],
@@ -1481,7 +1480,6 @@ cdk_aws_iotfleetwise.CanVehicleSignal(
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#cdk-aws-iotfleetwise.CanVehicleSignal.Initializer.parameter.name">name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.CanVehicleSignal.Initializer.parameter.fullyQualifiedName">fully_qualified_name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.CanVehicleSignal.Initializer.parameter.interfaceId">interface_id</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.CanVehicleSignal.Initializer.parameter.messageId">message_id</a></code> | <code>typing.Union[int, float]</code> | *No description.* |
@@ -1494,12 +1492,6 @@ cdk_aws_iotfleetwise.CanVehicleSignal(
 
 ---
 
-##### `name`<sup>Required</sup> <a name="name" id="cdk-aws-iotfleetwise.CanVehicleSignal.Initializer.parameter.name"></a>
-
-- *Type:* str
-
----
-
 ##### `fully_qualified_name`<sup>Required</sup> <a name="fully_qualified_name" id="cdk-aws-iotfleetwise.CanVehicleSignal.Initializer.parameter.fullyQualifiedName"></a>
 
 - *Type:* str
@@ -1643,26 +1635,18 @@ def to_object() -> any
 import cdk_aws_iotfleetwise
 
 cdk_aws_iotfleetwise.SignalCatalogBranch(
-  name: str,
   fully_qualified_name: str,
   description: str = None
 )
 ```
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#cdk-aws-iotfleetwise.SignalCatalogBranch.Initializer.parameter.name">name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.SignalCatalogBranch.Initializer.parameter.fullyQualifiedName">fully_qualified_name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.SignalCatalogBranch.Initializer.parameter.description">description</a></code> | <code>str</code> | *No description.* |
 
 ---
 
-##### `name`<sup>Required</sup> <a name="name" id="cdk-aws-iotfleetwise.SignalCatalogBranch.Initializer.parameter.name"></a>
-
-- *Type:* str
-
----
-
 ##### `fully_qualified_name`<sup>Required</sup> <a name="fully_qualified_name" id="cdk-aws-iotfleetwise.SignalCatalogBranch.Initializer.parameter.fullyQualifiedName"></a>
 
 - *Type:* str
@@ -1732,7 +1716,6 @@ def to_object() -> any
 import cdk_aws_iotfleetwise
 
 cdk_aws_iotfleetwise.SignalCatalogSensor(
-  name: str,
   fully_qualified_name: str,
   data_type: str,
   unit: str = None,
@@ -1744,7 +1727,6 @@ cdk_aws_iotfleetwise.SignalCatalogSensor(
 
 | **Name** | **Type** | **Description** |
 | --- | --- | --- |
-| <code><a href="#cdk-aws-iotfleetwise.SignalCatalogSensor.Initializer.parameter.name">name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.SignalCatalogSensor.Initializer.parameter.fullyQualifiedName">fully_qualified_name</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.SignalCatalogSensor.Initializer.parameter.dataType">data_type</a></code> | <code>str</code> | *No description.* |
 | <code><a href="#cdk-aws-iotfleetwise.SignalCatalogSensor.Initializer.parameter.unit">unit</a></code> | <code>str</code> | *No description.* |
@@ -1754,12 +1736,6 @@ cdk_aws_iotfleetwise.SignalCatalogSensor(
 
 ---
 
-##### `name`<sup>Required</sup> <a name="name" id="cdk-aws-iotfleetwise.SignalCatalogSensor.Initializer.parameter.name"></a>
-
-- *Type:* str
-
----
-
 ##### `fully_qualified_name`<sup>Required</sup> <a name="fully_qualified_name" id="cdk-aws-iotfleetwise.SignalCatalogSensor.Initializer.parameter.fullyQualifiedName"></a>
 
 - *Type:* str