com.amazonaws.services.lambda.runtime.events.CognitoUserPoolEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aws-lambda-java-events Show documentation

Event interface definitions AWS services supported by AWS Lambda.

There is a newer version: 3.14.0

Show newest version

/*
 * Copyright 2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
 * the License. A copy of the License is located at
 *
 * http://aws.amazon.com/apache2.0
 *
 * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
 * and limitations under the License.
 */
package com.amazonaws.services.lambda.runtime.events;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

import java.util.Map;

/**
 * Represent the base class for all Cognito User Pool Events
 *
 * See Customizing User Pool Workflows with Lambda Triggers
 *
 * @author jvdl 
 */
@AllArgsConstructor
@Data
@NoArgsConstructor
public abstract class CognitoUserPoolEvent {

    /**
     * The version number of your Lambda function.
     */
    private String version;

    /**
     * The name of the event that triggered the Lambda function.
     */
    private String triggerSource;

    /**
     * The AWS Region.
     */
    private String region;

    /**
     * The user pool ID for the user pool.
     */
    private String userPoolId;

    /**
     * The username of the current user.
     */
    private String userName;

    /**
     * The caller context.
     */
    private CallerContext callerContext;

    @AllArgsConstructor
    @Data
    @NoArgsConstructor
    public static abstract class Request {
        /**
         * One or more pairs of user attribute names and values.
         */
        private Map userAttributes;
    }

    @AllArgsConstructor
    @Builder(setterPrefix = "with")
    @Data
    @NoArgsConstructor
    public static class CallerContext {
        /**
         * The AWS SDK version number.
         */
        private String awsSdkVersion;

        /**
         * The ID of the client associated with the user pool.
         */
        private String clientId;
    }
}