Spring Boot, DynamoDB, @Configuration 클래스 작성하기

개요

• Spring Boot 기반 프로젝트에서 DynamoDB를 사용하기 위한 @Configuration 클래스를 작성하는 방법을 정리하였다. 별도의 ODM 라이브러리를 쓰지 않고, AWS에서 권장하는 DynamoDB Enhanced Client 라이브러리를 사용하였다.

build.gradle.kts

• 프로젝트의 /build.gradle.kts에 아래 내용을 추가한다.

dependencies {
    implementation("software.amazon.awssdk:dynamodb-enhanced:2.17.101")
}

application.yml

• 프로젝트의 /src/main/resources/application.yml에 아래 내용을 추가한다.

cloud:
  aws:
    credentials:
      access-key: *****
      secret-key: *****

DynamoDbConfig.kts

• 실제 DynamoDB 연결시 @Repository 빈에서 사용할 dynamoDbEnhancedClient 싱글턴 빈을 등록할 차례이다.

import org.springframework.beans.factory.annotation.Qualifier
import org.springframework.beans.factory.annotation.Value
import org.springframework.context.annotation.Bean
import org.springframework.context.annotation.Configuration
import software.amazon.awssdk.auth.credentials.AwsBasicCredentials
import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider
import software.amazon.awssdk.enhanced.dynamodb.DynamoDbEnhancedClient
import software.amazon.awssdk.regions.Region
import software.amazon.awssdk.services.dynamodb.DynamoDbClient

@Configuration
class DynamoDbConfig(

    @Value("\${cloud.aws.credentials.access-key}")
    val accessKey: String,

    @Value("\${cloud.aws.credentials.secret-key}")
    val secretKey: String
) {
    @Bean
    fun dynamoDbClient(): DynamoDbClient {

        return DynamoDbClient.builder()
            .region(Region.US_EAST_1)
            .credentialsProvider(
                StaticCredentialsProvider.create(
                    AwsBasicCredentials.create(accessKey, secretKey)
                )
            )
            .build()
    }

    @Bean
    fun dynamoDbEnhancedClient(
        @Qualifier("dynamoDbClient") dynamoDbClient: DynamoDbClient
    ): DynamoDbEnhancedClient {

        return DynamoDbEnhancedClient.builder()
            .dynamoDbClient(dynamoDbClient)
            .build()
    }
}

참고 글

• AWS - Using the DynamoDB Enhanced Client in the AWS SDK for Java 2.x
• AWS - Introducing enhanced DynamoDB client in the AWS SDK for Java v2
• GitHub - DynamoDB Enhanced Client
• EC2에서 access key 없이 role 활용하여 사용하기(Java aws sdk credential)