Skip to content

Commit 332c615

Browse files
authored
Fix migration guide rendering (#805)
1 parent d350197 commit 332c615

File tree

1 file changed

+13
-14
lines changed

1 file changed

+13
-14
lines changed

documents/MIGRATION_GUIDE.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -168,20 +168,20 @@ and other connection-related features.
168168
For more information, refer to the [Connecting To AWS IoT Core](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#connecting-to-aws-iot-core)
169169
section of the MQTT5 user guide for detailed information and code snippets on each connection type and connection feature.
170170

171-
| Connection type/feature | v1 SDK | v2 SDK | User guide |
172-
|----------------------------------------------------------|---------------------------------------|----------------------------------|:----------:|
173-
| MQTT over Secure WebSocket with AWS SigV4 authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#mqtt-over-websockets-with-sigv4-authentication) |
174-
| MQTT with X.509 certificate based mutual authentication | $${\Large\color{green}&#10004}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-x509-based-mutual-tls) |
175-
| Websocket Connection with Cognito Authentication Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#mqtt-over-websockets-with-cognito) |
176-
| MQTT with PKCS12 Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-pkcs12-method) |
177-
| MQTT with Custom Authorizer Method | $${\Large\color{orange}&#10004\*}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-custom-authentication) |
178-
| MQTT with Windows Certificate Store Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-windows-certificate-store-method) |
179-
| MQTT with PKCS11 Method | $${\Large\color{red}&#10008}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-pkcs11-method) |
180-
| HTTP Proxy | $${\Large\color{orange}&#10004\*\*}$$ | $${\Large\color{green}&#10004}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#adding-an-http-proxy) |
181-
182-
${\Large\color{orange}&#10004\*}$ - To get this connection type work in the v1 SDK, you need to implement the
171+
| Connection type/feature | v1 SDK | v2 SDK | User guide |
172+
|----------------------------------------------------------|---------------------------------------------------|-----------------------------------|:----------:|
173+
| MQTT over Secure WebSocket with AWS SigV4 authentication | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#mqtt-over-websockets-with-sigv4-authentication) |
174+
| MQTT with X.509 certificate based mutual authentication | $${\Large\color{green}✔}$$ | $${\Large\color{green}✔}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-x509-based-mutual-tls) |
175+
| Websocket Connection with Cognito Authentication Method | $${\Large\color{red}✘}$$ | $${\Large\color{green}✔}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#mqtt-over-websockets-with-cognito) |
176+
| MQTT with PKCS12 Method | $${\Large\color{red}✘}$$ | $${\Large\color{green}✔}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-pkcs12-method) |
177+
| MQTT with Custom Authorizer Method | $${\Large\color{orange}&#10004;}$$<sup>\*</sup> | $${\Large\color{green}&#10004;}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-custom-authentication) |
178+
| MQTT with Windows Certificate Store Method | $${\Large\color{red}&#10008;}$$ | $${\Large\color{green}&#10004;}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-windows-certificate-store-method) |
179+
| MQTT with PKCS11 Method | $${\Large\color{red}&#10008;}$$ | $${\Large\color{green}&#10004;}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#direct-mqtt-with-pkcs11-method) |
180+
| HTTP Proxy | $${\Large\color{orange}&#10004;}$$<sup>\*\*</sup> | $${\Large\color{green}&#10004;}$$ | [link](https://github.com/aws/aws-iot-device-sdk-cpp-v2/blob/main/documents/MQTT5_Userguide.md#adding-an-http-proxy) |
181+
182+
${\Large\color{orange}&#10004;}$<sup>\*</sup> - To get this connection type work in the v1 SDK, you need to implement the
183183
[Custom Authentication workflow](https://docs.aws.amazon.com/iot/latest/developerguide/custom-authorizer.html).\
184-
${\Large\color{orange}&#10004\*\*}$ - The v1 SDK does not allow specifying HTTP proxy, but it is possible to configure
184+
${\Large\color{orange}&#10004;}$<sup>\*\*</sup> - The v1 SDK does not allow specifying HTTP proxy, but it is possible to configure
185185
systemwide proxy.
186186

187187
### Lifecycle Events
@@ -1445,4 +1445,3 @@ in the v2 SDK.
14451445
> AWS Iot Core supports Shared Subscriptions for both MQTT3 and MQTT5. For more information, see
14461446
> [Shared Subscriptions](https://docs.aws.amazon.com/iot/latest/developerguide/mqtt.html#mqtt5-shared-subscription)
14471447
> from the AWS IoT Core developer guide
1448-

0 commit comments

Comments
 (0)