Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cross reference to Micronaut Object Storage #1462

Merged
merged 3 commits into from
Sep 12, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/main/docs/guide/sdkv2/s3.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
To use an S3 client, add the following dependency:
Micronaut provides a high-level, uniform object storage API that works across the major cloud providers: https://micronaut-projects.github.io/micronaut-object-storage/latest/guide/[Micronaut Object Storage].

To get started, select the `object-storage-aws` feature in https://micronaut.io/launch?features=object-storage-aws[Micronaut Launch], or add the following dependency:

dependency:io.micronaut.objectstorage:micronaut-object-storage-aws[]

For more information, check the https://micronaut-projects.github.io/micronaut-object-storage/latest/guide/#aws[Micronaut Object Storage AWS support] documentation.

If you still need the low-level AWS S3 client, add the following dependency:

dependency:s3[groupId="software.amazon.awssdk"]

Expand All @@ -16,4 +24,4 @@ The HTTP client, credentials and region will be configured as per described in t

Additionally, this service accepts the following configuration properties:

include::{includedir}configurationProperties/io.micronaut.aws.sdk.v2.service.s3.S3ConfigurationProperties.adoc[]
include::{includedir}configurationProperties/io.micronaut.aws.sdk.v2.service.s3.S3ConfigurationProperties.adoc[]