Skip to content

Commit f62d8bf

Browse files
authored
Fix migration guide rendering (#629)
1 parent a67d4db commit f62d8bf

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

documents/MIGRATION_GUIDE.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -167,23 +167,23 @@ and other connection-related features.
167167
For more information, refer to the [How to set up MQTT5 builder based on desired connection method](https://github.com/aws/aws-iot-device-sdk-java-v2/blob/main/documents/MQTT5_Userguide.md#how-to-setup-mqtt5-builder-based-on-desired-connection-method)
168168
section of the MQTT5 user guide for detailed information and code snippets on each connection type and connection feature.
169169

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

189189
#### Example of creating connection using KeyStore in the v1 SDK

0 commit comments

Comments
 (0)