com.amazonaws.services.lambda.runtime.events.CognitoUserPoolMigrateUserEvent 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.*;

import java.util.Map;

/**
 * Represent the class for the Cognito User Pool Migrate User Lambda Trigger
 *
 * See Migrate User Lambda Trigger
 *
 * @author jvdl 
 */
@Data
@EqualsAndHashCode(callSuper = true)
@NoArgsConstructor
public class CognitoUserPoolMigrateUserEvent extends CognitoUserPoolEvent {
    /**
     * The request from the Amazon Cognito service.
     */
    private Request request;

    /**
     * The response from your Lambda trigger.
     */
    private Response response;

    @Builder(setterPrefix = "with")
    public CognitoUserPoolMigrateUserEvent(
            String version,
            String triggerSource,
            String region,
            String userPoolId,
            String userName,
            CallerContext callerContext,
            Request request,
            Response response) {
        super(version, triggerSource, region, userPoolId, userName, callerContext);
        this.request = request;
        this.response = response;
    }

    @Data
    @EqualsAndHashCode(callSuper = true)
    @NoArgsConstructor
    public static class Request extends CognitoUserPoolEvent.Request {
        /**
         * The username entered by the user.
         */
        private String userName;
        /**
         * The password entered by the user for sign-in. It is not set in the forgot-password flow.
         */
        private String password;
        /**
         * One or more key-value pairs containing the validation data in the user's sign-in request.
         */
        private Map validationData;
        /**
         * One or more key-value pairs that you can provide as custom input to the Lambda function that you specify for the migrate user trigger.
         */
        private Map clientMetadata;

        @Builder(setterPrefix = "with")
        public Request(Map userAttributes, Map validationData, Map clientMetadata, String userName, String password) {
            super(userAttributes);
            this.validationData = validationData;
            this.clientMetadata = clientMetadata;
            this.userName = userName;
            this.password = password;
        }
    }

    @AllArgsConstructor
    @Builder(setterPrefix = "with")
    @Data
    @NoArgsConstructor
    public static class Response {

        /**
         * It must contain one or more name-value pairs representing user attributes to be stored in the user profile in your user pool.
         */
        private Map userAttributes;

        /**
         * During sign-in, this attribute can be set to CONFIRMED, or not set, to auto-confirm your users and allow them to sign-in with their previous passwords.
         */
        private String finalUserStatus;

        /**
         * This attribute can be set to "SUPPRESS" to suppress the welcome message usually sent by Amazon Cognito to new users.
         * If this attribute is not returned, the welcome message will be sent.
         */
        private String messageAction;

        /**
         * This attribute can be set to "EMAIL" to send the welcome message by email, or "SMS" to send the welcome message by SMS.
         * If this attribute is not returned, the welcome message will be sent by SMS.
         */
        private String[] desiredDeliveryMediums;

        /**
         * If this parameter is set to "true" and the phone number or email address specified in the UserAttributes parameter already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user.
         */
        private boolean forceAliasCreation;
    }
}