Skip to content

Add aws-lambda-java-events-sdk-transformer library with DynamodbEvent v2.2.8 support #118

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

Merged
merged 1 commit into from
May 5, 2020
Merged
Show file tree
Hide file tree
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
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ from the packages can result in unexpected behavior.
Check out the per-module release notes:
- [aws-lambda-java-core](aws-lambda-java-core/RELEASE.CHANGELOG.md)
- [aws-lambda-java-events](aws-lambda-java-events/RELEASE.CHANGELOG.md)
- [aws-lambda-java-events-sdk-transformer](aws-lambda-java-events-sdk-transformer/RELEASE.CHANGELOG.md)
- [aws-lambda-java-log4j](aws-lambda-java-log4j/RELEASE.CHANGELOG.md)
- [aws-lambda-java-log4j2](aws-lambda-java-log4j2/RELEASE.CHANGELOG.md)

Expand All @@ -36,6 +37,11 @@ ___
<artifactId>aws-lambda-java-events</artifactId>
<version>2.2.8</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events-sdk-transformer</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-log4j</artifactId>
Expand All @@ -53,6 +59,7 @@ ___
```groovy
'com.amazonaws:aws-lambda-java-core:1.2.1'
'com.amazonaws:aws-lambda-java-events:2.2.8'
'com.amazonaws:aws-lambda-java-events-sdk-transformer:1.0.0'
'com.amazonaws:aws-lambda-java-log4j:1.0.1'
'com.amazonaws:aws-lambda-java-log4j2:1.1.1'
```
Expand All @@ -62,6 +69,7 @@ ___
```clojure
[com.amazonaws/aws-lambda-java-core "1.2.1"]
[com.amazonaws/aws-lambda-java-events "2.2.8"]
[com.amazonaws/aws-lambda-java-events-sdk-transformer "1.0.0"]
[com.amazonaws/aws-lambda-java-log4j "1.0.1"]
[com.amazonaws/aws-lambda-java-log4j2 "1.1.1"]
```
Expand All @@ -71,6 +79,7 @@ ___
```scala
"com.amazonaws" % "aws-lambda-java-core" % "1.2.1"
"com.amazonaws" % "aws-lambda-java-events" % "2.2.8"
"com.amazonaws" % "aws-lambda-java-events-sdk-transformer" % "1.0.0"
"com.amazonaws" % "aws-lambda-java-log4j" % "1.0.1"
"com.amazonaws" % "aws-lambda-java-log4j2" % "1.1.1"
```
Expand All @@ -85,6 +94,12 @@ This package defines the Lambda [Context](http://docs.aws.amazon.com/lambda/late
This package defines [event sources](http://docs.aws.amazon.com/lambda/latest/dg/intro-invocation-modes.html) that AWS Lambda natively accepts.
See the [documentation](aws-lambda-java-events/README.md) for more information.

# Using aws-lambda-java-events-sdk-transformer

This package provides helper classes/methods to use alongside `aws-lambda-java-events` in order to transform
Lambda input event model objects into SDK-compatible output model objects.
See the [documentation](aws-lambda-java-events-sdk-transformer/README.md) for more information.

# Using aws-lambda-java-log4j2

This package defines the Lambda adapter to use with log4j version 2.
Expand Down
121 changes: 121 additions & 0 deletions aws-lambda-java-events-sdk-transformer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# AWS Lambda Java Events SDK Transformer Library

### About

Provides helper classes/methods to use alongside `aws-lambda-java-events` in order to transform Lambda input event model
objects into SDK-compatible output model objects
(eg. DynamodbEvent to a List of records writable back to DynamoDB through the AWS DynamoDB SDK v2).


### Getting started

Add the following Apache Maven dependencies to your `pom.xml` file:

```xml
<dependencies>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events-sdk-transformer</artifactId>
<version>1.0.0</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events</artifactId>
<version>2.2.8</version>
</dependency>
</dependencies>
```

To use this library as a transformer to the AWS DynamoDB Java SDK v2, also add the following dependencies to your `pom.xml` file:

```xml
<dependencies>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>dynamodb</artifactId>
<version>2.11.12</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-dynamodb</artifactId>
<version>1.11.163</version>
</dependency>
</dependencies>
```
*Note that because `aws-lambda-java-events` version 2 requires the DynamoDB v1 SDK, this is also required for this library.*


### Example Usage

To convert a full `DynamodbEvent` object to an SDK v2 compatible `List<Record>`:
```java
import com.amazonaws.services.lambda.runtime.events.transformers.DynamodbEventTransformer;

public class DDBEventProcessor implements RequestHandler<DynamodbEvent, String> {

public String handleRequest(DynamodbEvent ddbEvent, Context context) {
// Process input event
List<Record> convertedRecords = DynamodbEventTransformer.toRecordsV2(ddbEvent);
// Modify records as needed and write back to DynamoDB using the DynamoDB AWS SDK for Java 2.0
}
}
```

To convert a single `DynamodbEvent.DynamodbStreamRecord` object to an SDK v2 compatible `Record`:
```java
import com.amazonaws.services.lambda.runtime.events.transformers.dynamodb.DynamodbRecordTransformer;

public class MyClass {

public void myMethod(DynamodbEvent.DynamodbStreamRecord record) {
// ...
Record convertedRecord = DynamodbRecordTransformer.toRecordV2(record);
// ...
}
}
```

To convert a `StreamRecord` object originating from a `DynamodbEvent` to an SDK v2 compatible `StreamRecord`:
```java
import com.amazonaws.services.lambda.runtime.events.transformers.dynamodb.DynamodbStreamRecordTransformer;

public class MyClass {

public void myMethod(StreamRecord streamRecord) {
// ...
software.amazon.awssdk.services.dynamodb.model.StreamRecord convertedStreamRecord =
DynamodbStreamRecordTransformer.toStreamRecordV2(streamRecord);
// ...
}
}
```

To convert an `AttributeValue` object originating from a `DynamodbEvent` to an SDK v2 compatible `AttributeValue`:
```java
import com.amazonaws.services.lambda.runtime.events.transformers.dynamodb.DynamodbAttributeValueTransformer;

public class MyClass {

public void myMethod(AttributeValue attributeValue) {
// ...
software.amazon.awssdk.services.dynamodb.model.AttributeValue convertedAttributeValue =
DynamodbAttributeValueTransformer.toAttributeValueV2(attributeValue);
// ...
}
}
```

To convert an `Identity` object originating from a `DynamodbEvent` to an SDK v2 compatible `Identity`:
```java
import com.amazonaws.services.lambda.runtime.events.transformers.dynamodb.DynamodbIdentityTransformer;

public class MyClass {

public void myMethod(Identity identity) {
// ...
software.amazon.awssdk.services.dynamodb.model.Identity convertedIdentity =
DynamodbIdentityTransformer.toIdentityV2(identity);
// ...
}
}
```
3 changes: 3 additions & 0 deletions aws-lambda-java-events-sdk-transformer/RELEASE.CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
### Apr 29, 2020
`1.0.0`:
- Added AWS SDK V2 transformers for `DynamodbEvent` in `aws-lambda-java-events` versions up to and including `2.2.8`
175 changes: 175 additions & 0 deletions aws-lambda-java-events-sdk-transformer/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>

<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events-sdk-transformer</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>

<name>AWS Lambda Java Events SDK Transformer Library</name>
<description>
Provides helper classes/methods to use alongside aws-lambda-java-events in order to transform Lambda input event model
objects into SDK-compatible output model objects (eg. DynamodbEvent to a List of records writable back to DynamoDB
through the AWS DynamoDB SDK v2)
</description>
<url>https://aws.amazon.com/lambda/</url>
<licenses>
<license>
<name>Apache License, Version 2.0</name>
<url>https://aws.amazon.com/apache2.0</url>
<distribution>repo</distribution>
</license>
</licenses>
<scm>
<url>https://github.com/aws/aws-lambda-java-libs.git</url>
</scm>
<developers>
<developer>
<name>AWS Lambda team</name>
<organization>Amazon Web Services</organization>
<organizationUrl>https://aws.amazon.com/</organizationUrl>
</developer>
</developers>

<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
</properties>

<distributionManagement>
<repository>
<id>sonatype-nexus-staging</id>
<url>https://oss.sonatype.org/service/local/staging/deploy/maven2/</url>
</repository>
</distributionManagement>

<dependencies>
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>dynamodb</artifactId>
<version>2.11.12</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-dynamodb</artifactId>
<version>1.11.163</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events</artifactId>
<version>2.2.8</version>
<scope>provided</scope>
</dependency>

<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.6.2</version>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
</plugin>
<plugin>
<artifactId>maven-failsafe-plugin</artifactId>
<version>2.22.2</version>
</plugin>
</plugins>
</build>

<profiles>
<profile>
<id>dev</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</profile>
<profile>
<id>release</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>2.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
<goals>
<goal>jar-no-fork</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<additionalparam>-Xdoclint:none</additionalparam>
</configuration>
<executions>
<execution>
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-gpg-plugin</artifactId>
<version>1.5</version>
<executions>
<execution>
<id>sign-artifacts</id>
<phase>verify</phase>
<goals>
<goal>sign</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.3</version>
<extensions>true</extensions>
<configuration>
<serverId>sonatype-nexus-staging</serverId>
<nexusUrl>https://aws.oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>false</autoReleaseAfterClose>
</configuration>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package com.amazonaws.services.lambda.runtime.events.transformers;

import com.amazonaws.services.lambda.runtime.events.DynamodbEvent;
import com.amazonaws.services.lambda.runtime.events.transformers.dynamodb.DynamodbRecordTransformer;
import software.amazon.awssdk.services.dynamodb.model.Record;

import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;

public class DynamodbEventTransformer {

public static List<Record> toRecordsV2(final DynamodbEvent dynamodbEvent) {
return dynamodbEvent
.getRecords()
.stream()
.filter(record -> !Objects.isNull(record))
.map(DynamodbRecordTransformer::toRecordV2)
.collect(Collectors.toList());
}
}
Loading