README.md

AWS Spring Boot Autoconfigure and Starter

Often when working with AWS and Spring using the aws-java-sdk, we need to create clients for different services. This autoconfigure module when included in the pom, will create the required clients for the AWS services and put it in bean factory ready for injection.

There is already a project spring-cloud-aws from Spring under the Spring Cloud umbrella. However, for some people that can be an overwhelming amount of abstraction and would like to work with the native SDK. This can be useful to those people.

AWS credential management works the same way as the native SDK.

Region selection takes place with the following precedence:

1. Region configured in application.properties / yml file
2. If running on AWS (EC2 / Fargate) then, the region of the EC2 instance / ECS Cluster
3. Default AWS Region

AWS Services Supported

As of now, Supports the following AWS Services (i.e. create AWS Clients bean for the service)

1. Simple Storage Service - S3 (AmazonS3)
2. Simple Queue Service - SQS (AmazonSQS, AmazonSQSAsync)
3. Simple Notification Service - SNS (AmazonSNS, AmazonSNSAsync)
4. Simple Email Service - SES (AmazonSimpleEmailService, AmazonSimpleEmailServiceAsync)

Packaging

This project is managed by maven, run mvn clean install

Using in Project

Just add the starter as a maven dependency:

<dependency>
    <groupId>org.ares</groupId>
    <artifactId>aws-spring-boot-starter</artifactId>
    <version>1.0.0</version>
</dependency>

Then autowire the required bean and use it

public class S3ObjectDownloader {
    
    @Autowired
    private AmazonS3 amazonS3;
    
    public void downloadObj(String bucket, String s3Key) {
        S3Obejct object = amazonS3.getObject(bucket, s3Key);
        // use the object
    }
}