Skip to content

Add SDK v1 transformers #195

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
Dec 9, 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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ ___
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events-sdk-transformer</artifactId>
<version>2.0.8</version>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
Expand All @@ -60,7 +60,7 @@ ___
```groovy
'com.amazonaws:aws-lambda-java-core:1.2.1'
'com.amazonaws:aws-lambda-java-events:3.6.0'
'com.amazonaws:aws-lambda-java-events-sdk-transformer:2.0.8'
'com.amazonaws:aws-lambda-java-events-sdk-transformer:3.0.0'
'com.amazonaws:aws-lambda-java-log4j2:1.2.0'
'com.amazonaws:aws-lambda-java-runtime-interface-client:1.0.0'
```
Expand All @@ -70,7 +70,7 @@ ___
```clojure
[com.amazonaws/aws-lambda-java-core "1.2.1"]
[com.amazonaws/aws-lambda-java-events "3.6.0"]
[com.amazonaws/aws-lambda-java-events-sdk-transformer "2.0.8"]
[com.amazonaws/aws-lambda-java-events-sdk-transformer "3.0.0"]
[com.amazonaws/aws-lambda-java-log4j2 "1.2.0"]
[com.amazonaws/aws-lambda-java-runtime-interface-client "1.0.0"]
```
Expand All @@ -80,7 +80,7 @@ ___
```scala
"com.amazonaws" % "aws-lambda-java-core" % "1.2.1"
"com.amazonaws" % "aws-lambda-java-events" % "3.6.0"
"com.amazonaws" % "aws-lambda-java-events-sdk-transformer" % "2.0.8"
"com.amazonaws" % "aws-lambda-java-events-sdk-transformer" % "3.0.0"
"com.amazonaws" % "aws-lambda-java-log4j2" % "1.2.0"
"com.amazonaws" % "aws-lambda-java-runtime-interface-client" % "1.0.0"
```
Expand Down
171 changes: 135 additions & 36 deletions aws-lambda-java-events-sdk-transformer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

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).
(eg. DynamodbEvent to a List of records writable back to DynamoDB through the AWS DynamoDB SDK for Java v1 or v2).


### Getting started
Expand All @@ -16,7 +16,7 @@ Add the following Apache Maven dependencies to your `pom.xml` file:
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events-sdk-transformer</artifactId>
<version>2.0.8</version>
<version>3.0.0</version>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
Expand All @@ -33,83 +33,182 @@ To use this library as a transformer to the AWS DynamoDB Java SDK v2, also add t
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>dynamodb</artifactId>
<version>2.13.18</version>
<version>2.15.40</version>
</dependency>
</dependencies>
```

To use this library as a transformer to the AWS DynamoDB Java SDK v1, add the following dependency to your `pom.xml` file instead:

```xml
<dependencies>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-dynamodb</artifactId>
<version>1.11.914</version>
</dependency>
</dependencies>
```


### Example Usage

#### SDK v2

To convert a full `DynamodbEvent` object to an SDK v2 compatible `List<Record>`:

```java
import com.amazonaws.services.lambda.runtime.events.transformers.DynamodbEventTransformer;
import com.amazonaws.services.lambda.runtime.events.transformers.v2.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
}
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;
import com.amazonaws.services.lambda.runtime.events.transformers.v2.dynamodb.DynamodbRecordTransformer;

public class MyClass {

public void myMethod(DynamodbEvent.DynamodbStreamRecord record) {
// ...
Record convertedRecord = DynamodbRecordTransformer.toRecordV2(record);
// ...
}
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;
import com.amazonaws.services.lambda.runtime.events.transformers.v2.dynamodb.DynamodbStreamRecordTransformer;

public class MyClass {

public void myMethod(StreamRecord streamRecord) {
// ...
software.amazon.awssdk.services.dynamodb.model.StreamRecord convertedStreamRecord =
DynamodbStreamRecordTransformer.toStreamRecordV2(streamRecord);
// ...
}
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;
import com.amazonaws.services.lambda.runtime.events.transformers.v2.dynamodb.DynamodbAttributeValueTransformer;

public class MyClass {

public void myMethod(AttributeValue attributeValue) {
// ...
software.amazon.awssdk.services.dynamodb.model.AttributeValue convertedAttributeValue =
DynamodbAttributeValueTransformer.toAttributeValueV2(attributeValue);
// ...
}
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.v2.dynamodb.DynamodbIdentityTransformer;

public class MyClass {

public void myMethod(Identity identity) {
// ...
software.amazon.awssdk.services.dynamodb.model.Identity convertedIdentity =
DynamodbIdentityTransformer.toIdentityV2(identity);
// ...
}
}
```

#### SDK v1

To convert a full `DynamodbEvent` object to an SDK v1 compatible `List<Record>`:

```java
import com.amazonaws.services.lambda.runtime.events.transformers.v1.DynamodbEventTransformer;

public class DDBEventProcessor implements RequestHandler<DynamodbEvent, String> {

public String handleRequest(DynamodbEvent ddbEvent, Context context) {
// Process input event
List<Record> convertedRecords = DynamodbEventTransformer.toRecordsV1(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 v1 compatible `Record`:

```java
import com.amazonaws.services.lambda.runtime.events.transformers.v1.dynamodb.DynamodbRecordTransformer;

public class MyClass {

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

To convert a `StreamRecord` object originating from a `DynamodbEvent` to an SDK v1 compatible `StreamRecord`:

```java
import com.amazonaws.services.lambda.runtime.events.transformers.v1.dynamodb.DynamodbStreamRecordTransformer;

public class MyClass {

public void myMethod(StreamRecord streamRecord) {
// ...
com.amazonaws.services.dynamodbv2.model.StreamRecord convertedStreamRecord =
DynamodbStreamRecordTransformer.toStreamRecordV1(streamRecord);
// ...
}
}
```

To convert an `AttributeValue` object originating from a `DynamodbEvent` to an SDK v1 compatible `AttributeValue`:

```java
import com.amazonaws.services.lambda.runtime.events.transformers.v1.dynamodb.DynamodbAttributeValueTransformer;

public class MyClass {

public void myMethod(AttributeValue attributeValue) {
// ...
com.amazonaws.services.dynamodbv2.model.AttributeValue convertedAttributeValue =
DynamodbAttributeValueTransformer.toAttributeValueV1(attributeValue);
// ...
}
}
```

To convert an `Identity` object originating from a `DynamodbEvent` to an SDK v1 compatible `Identity`:

```java
import com.amazonaws.services.lambda.runtime.events.transformers.dynamodb.DynamodbIdentityTransformer;
import com.amazonaws.services.lambda.runtime.events.transformers.v1.dynamodb.DynamodbIdentityTransformer;

public class MyClass {

public void myMethod(Identity identity) {
// ...
software.amazon.awssdk.services.dynamodb.model.Identity convertedIdentity =
DynamodbIdentityTransformer.toIdentityV2(identity);
// ...
}
public void myMethod(Identity identity) {
// ...
com.amazonaws.services.dynamodbv2.model.Identity convertedIdentity =
DynamodbIdentityTransformer.toIdentityV1(identity);
// ...
}
}
```
6 changes: 6 additions & 0 deletions aws-lambda-java-events-sdk-transformer/RELEASE.CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
### Upcoming
`3.0.0`:
- Added AWS SDK V1 transformers for `DynamodbEvent` in `aws-lambda-java-events` versions `3.0.0` and up
- Moved existing SDK v2 transformers into `v2` package (from `com.amazonaws.services.lambda.runtime.events.transformers` to `com.amazonaws.services.lambda.runtime.events.transformers.v2`)
- Bumped `software.amazon.awssdk:dynamodb` to version `2.15.40`

### November 06, 2020
`2.0.8`:
- Bumped `aws-lambda-java-events` to version `3.6.0`
Expand Down
14 changes: 11 additions & 3 deletions aws-lambda-java-events-sdk-transformer/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@

<groupId>com.amazonaws</groupId>
<artifactId>aws-lambda-java-events-sdk-transformer</artifactId>
<version>2.0.8</version>
<version>3.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)
through the AWS DynamoDB SDK for Java v1 or v2)
</description>
<url>https://aws.amazon.com/lambda/</url>
<licenses>
Expand All @@ -36,6 +36,8 @@
<properties>
<maven.compiler.source>1.8</maven.compiler.source>
<maven.compiler.target>1.8</maven.compiler.target>
<sdk.v1.version>1.11.914</sdk.v1.version>
<sdk.v2.version>2.15.40</sdk.v2.version>
</properties>

<distributionManagement>
Expand All @@ -49,7 +51,13 @@
<dependency>
<groupId>software.amazon.awssdk</groupId>
<artifactId>dynamodb</artifactId>
<version>2.13.18</version>
<version>${sdk.v2.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.amazonaws</groupId>
<artifactId>aws-java-sdk-dynamodb</artifactId>
<version>${sdk.v1.version}</version>
<scope>provided</scope>
</dependency>
<dependency>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package com.amazonaws.services.lambda.runtime.events.transformers.v1;

import com.amazonaws.services.dynamodbv2.model.Record;
import com.amazonaws.services.lambda.runtime.events.DynamodbEvent;
import com.amazonaws.services.lambda.runtime.events.transformers.v1.dynamodb.DynamodbRecordTransformer;

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

public class DynamodbEventTransformer {

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