GitHub - aws/aws-iot-device-sdk-java-v2: Next generation AWS IoT Client SDK for Java using the AWS Common Runtime (original) (raw)

AWS IoT Device SDK for Java v2

This document provides information about the AWS IoT device SDK for Java V2. This SDK is built on the AWS Common Runtime

Jump To:

Installation

Minimum Requirements

Step-by-step instructions

Requirements to build the AWS CRT locally

Step-by-step instructions

Consuming IoT Device SDK from Maven in your application

Consuming this SDK via Maven is the preferred method of consuming it and using it within your application. To consume the Java V2 SDK in your application, add the following to your pom.xml dependencies:

software.amazon.awssdk.iotdevicesdk aws-iot-device-sdk 1.25.0

Replace 1.25.0 in <version>1.25.0</version> with the latest release version for the SDK. Look up the latest SDK version here: https://github.com/aws/aws-iot-device-sdk-java-v2/releases

Build IoT Device SDK from source

Install Maven and Set PATH

Create a workspace directory to hold all the SDK files

mkdir sdk-workspace cd sdk-workspace

Clone the repository

git clone https://github.com/awslabs/aws-iot-device-sdk-java-v2.git cd aws-iot-device-sdk-java-v2

Compile and install

mvn clean install

If you wish to use the latest CRT release, rather than the latest tested with the IoT SDK, you can run the following before running mvn clean install:

Update the version of the CRT being used

mvn versions:use-latest-versions -Dincludes="software.amazon.awssdk.crt*"

Samples

Samples README

Mac-Only TLS Behavior

Please note that on Mac, once a private key is used with a certificate, that certificate-key pair is imported into the Mac Keychain. All subsequent uses of that certificate will use the stored private key and ignore anything passed in programmatically. Beginning in v1.7.3, when a stored private key from the Keychain is used, the following will be logged at the "info" log level:

static: certificate has an existing certificate-key pair that was previously imported into the Keychain.  Using key from Keychain instead of the one provided.

Getting Help

The best way to interact with our team is through GitHub. You can open a discussion for guidance questions or an issue for bug reports, or feature requests. You may also find help on community resources such as StackOverFlow with the tag #aws-iot or if you have a support plan with AWS Support, you can also create a new support case.

Please make sure to check out our resources too before opening an issue:

License

This library is licensed under the Apache 2.0 License.

Latest released version: v1.25.0