Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reactiverse/aws-sdk
Using vertx-client for AWS SDK v2
https://github.com/reactiverse/aws-sdk
aws-sdk java netty non-blocking performance reactive scalability vertx
Last synced: about 1 month ago
JSON representation
Using vertx-client for AWS SDK v2
- Host: GitHub
- URL: https://github.com/reactiverse/aws-sdk
- Owner: reactiverse
- License: apache-2.0
- Created: 2018-11-22T06:15:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T07:16:33.000Z (about 1 year ago)
- Last Synced: 2024-09-27T07:41:06.792Z (about 1 month ago)
- Topics: aws-sdk, java, netty, non-blocking, performance, reactive, scalability, vertx
- Language: Java
- Size: 851 KB
- Stars: 49
- Watchers: 8
- Forks: 14
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
- vertx-awesome - AWS SDK - Use AWS Java SDK v2 (async) with Vert.x (Cloud Support)
README
# Use AWS SDK v2 with Vert.x
[](https://travis-ci.org/reactiverse/aws-sdk)
This project provides a `VertxNioAsyncHttpClient` and a `VertxExecutor` so that you can use AWS SDK v2 in a Vert.x context.
## Coordinates
Artifacts are published [here](https://search.maven.org/artifact/io.reactiverse/aws-sdk)
## Version compatibility matrix
| Project | Vert.x | AWS sdk |
|---------|--------|----------|
| 1.2.2 | 4.4.5 | 2.20.138 |
| 1.2.1 | 4.4.2 | 2.20.74 |
| 1.2.0 | 4.4.0 | 2.20.2 |
| 1.1.0 | 4.2.4 | 2.17.129 |
| 1.0.0 | 4.0.0 | 2.15.45 |
| 0.7.0 | 3.9.4 | 2.15.23 |
| 0.6.0 | 3.9.2 | 2.14.7 |
| 0.5.1 | 3.9.2 | 2.13.6 |
| 0.5.0 | 3.9.0 | 2.12.0 |
| 0.4.0 | 3.8.3 | 2.10.16 |
| 0.3.0 | 3.8.1 | 2.7.8 |
## Documentation
See [this page](https://reactiverse.io/aws-sdk)
## Motivations
### AWS SDK v1 => blocking IOs
As you know, Vert.x uses non-blocking IO. This means, among other stuff, that you should never ever block the event-loop.
AWS SDK v1 implementation relies on blocking IOs. This means you cannot use it together with Vert.x in a straightforward
way. You would end up blocking the event-loop, hence killing your application's scalability. The only option would be
to wrap your synchronous calls to AWS SDK v1 within `executeBlocking` or use a worker thread.
Even though some methods of the AWS SDK are indicated as "async" (`DynamoAsyncClient` for instance), it internally uses
a thread pool whose size is configurable. Those threads can be a bottleneck in your application
You cannot really use AWS SDK v1 together with Vert.x in a non-blocking scalable way.
### Embrace AWS SDK v2
Since 2018, AWS has published the version 2 of its SDK, embracing non-blocking IO model.
Now you can use V2 together with Vert.x using this project.
* using Vert.x's HTTP client
* `CompletableFuture>`'s are executed in the same Vert.x context that the one that made the request
## Contributing
Tests placed under the `io.vertx.ext.awssdk.integration` package are using `localstack`: a huge set of
utilities (docker images) emulating AWS Services (DynamoDB, Kinesis, S3, etc.).
In order to do so, they require a local docker daemon running on the machine.
They will download docker images from the docker hub, run the appropriate service as a docker container, then test
the code against this local docker container.
They'll only be executed if the system property `tests.integration` is set to `localstack`. They'll be ignored otherwise.
## Documentation
Documentation is `docs/README.md` and visible at https://github.com/reactiverse/aws-sdk/tree/master/docs or https://reactiverse.io/aws-sdk/
Javadoc can be produced (with Java 11 otherwise it does not link Vert.x API docs)
```
> ./gradlew javadocToDocsFolder
```
This will update the docs/javadoc with latest javadocs