io.aws.lambda.events.dynamodb.DynamodbEvent Maven / Gradle / Ivy

Go to download

package io.aws.lambda.events.dynamodb;

import lombok.Data;
import lombok.experimental.Accessors;
import org.jetbrains.annotations.NotNull;

import java.io.Serializable;
import java.util.Collections;
import java.util.List;

/**
 * Represents an Amazon DynamoDB event
 */
@Data
@Accessors(chain = true)
public class DynamodbEvent implements Serializable {

    private List records;

    public @NotNull List getRecords() {
        return records == null ? Collections.emptyList() : records;
    }

    /**
     * The unit of data of an Amazon DynamoDB event
     */
    @Data
    @Accessors(chain = true)
    public static class DynamodbStreamRecord {

        public enum OperationType {

            INSERT,
            MODIFY,
            REMOVE
        }

        /**
         * A globally unique identifier for the event that was recorded in this stream
         * record.
         */
        private String eventID;

        /**
         * The type of data modification that was performed on the DynamoDB table:
         * INSERT - a new item was added to the table. MODIFY
         * - one or more of an existing item's attributes were modified.
         * REMOVE - the item was deleted from the table
         */
        private OperationType eventName;

        /**
         * The version number of the stream record format. This number is updated
         * whenever the structure of Record is modified. Client
         * applications must not assume that eventVersion will remain at a
         * particular value, as this number is subject to change at any time. In
         * general, eventVersion will only increase as the low-level
         * DynamoDB Streams API evolves.
         */
        private String eventVersion;

        /**
         * The AWS service from which the stream record originated. For DynamoDB
         * Streams, this is aws:dynamodb.
         */
        private String eventSource;

        /**
         * The region in which the GetRecords request was received.
         */
        private String awsRegion;

        /**
         * The main body of the stream record, containing all of the DynamoDB-specific
         * fields.
         */
        private StreamRecord dynamodb;

        /**
         * Items that are deleted by the Time to Live process after expiration have the
         * following fields: Records[].userIdentity.type "Service"
         * Records[].userIdentity.principalId "dynamodb.amazonaws.com"
         */
        private Identity userIdentity;

        private String eventSourceARN;
    }
}