Skip to content

S3 Integration

Integration for CRUD operations on a S3 storage.

Modules

The S3 integration follows the default naming conventions.

Usage

Add the following dependency for using the s3 integration.

xml
<dependencies>
    <dependency>
        <groupId>de.muenchen.oss.refarch</groupId>
        <artifactId>refarch-s3-integration-starter</artifactId>
        <version>...</version>
    </dependency>
</dependencies>

After that the S3OutPort can be used for S3 operations (e.g. via autowiring, as port is available as bean).

Configuration

s3-integration-starter

PropertyDescriptionExample
refarch.s3.urlURL of S3 endpoint to connect to.s3.example.com
refarch.s3.region (optional)Region to use for the connection.us-east-1 (default)
refarch.s3.access-keyAccess key to use for connection.
refarch.s3.secret-keySecret key to use for connection.
refarch.s3.path-style-access-enabled (optional)If bucket is specified via path (subdomain if false).true (default)
refarch.s3.initial-connection-test (optional)Test connection to S3 at startup.true (default)