Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class LambdaConfigType

java.lang.Object
software.amazon.awssdk.services.cognitoidentityprovider.model.LambdaConfigType
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<LambdaConfigType.Builder,LambdaConfigType>
@Generated("software.amazon.awssdk:codegen") public final class LambdaConfigType extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LambdaConfigType.Builder,LambdaConfigType>

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

See Also:

  • Method Details

    • preSignUp

      public final String preSignUp()

      The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile, or block sign-up requests.

      Returns:
      The configuration of a pre sign-up Lambda trigger in a user pool. This trigger evaluates new users and can bypass confirmation, link a federated user profile, or block sign-up requests.

    • customMessage

      public final String customMessage()

      A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.

      Returns:
      A custom message Lambda trigger. This trigger is an opportunity to customize all SMS and email messages from your user pool. When a custom message trigger is active, your user pool routes all messages to a Lambda function that returns a runtime-customized message subject and body for your user pool to deliver to a user.

    • postConfirmation

      public final String postConfirmation()

      The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

      Returns:
      The configuration of a post confirmation Lambda trigger in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.

    • preAuthentication

      public final String preAuthentication()

      The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

      Returns:
      The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

    • postAuthentication

      public final String postAuthentication()

      The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

      Returns:
      The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

    • defineAuthChallenge

      public final String defineAuthChallenge()

      The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

      Returns:
      The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

    • createAuthChallenge

      public final String createAuthChallenge()

      The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

      Returns:
      The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

    • verifyAuthChallengeResponse

      public final String verifyAuthChallengeResponse()

      The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

      Returns:
      The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

    • preTokenGeneration

      public final String preTokenGeneration()

      The legacy configuration of a pre token generation Lambda trigger in a user pool.

      Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig, its value must be identical to PreTokenGeneration. For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig.

      Returns:
      The legacy configuration of a pre token generation Lambda trigger in a user pool.

      Set this parameter for legacy purposes. If you also set an ARN in PreTokenGenerationConfig, its value must be identical to PreTokenGeneration. For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig.

    • userMigration

      public final String userMigration()

      The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

      Returns:
      The configuration of a migrate user Lambda trigger in a user pool. This trigger can create user profiles when users sign in or attempt to reset their password with credentials that don't exist yet.

    • preTokenGenerationConfig

      public final PreTokenGenerationVersionConfigType preTokenGenerationConfig()

      The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration, its value must be identical to PreTokenGenerationConfig.

      Returns:
      The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN in PreTokenGeneration, its value must be identical to PreTokenGenerationConfig.

    • customSMSSender

      public final CustomSMSLambdaVersionConfigType customSMSSender()

      The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

      Returns:
      The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

    • customEmailSender

      public final CustomEmailLambdaVersionConfigType customEmailSender()

      The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

      Returns:
      The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

    • kmsKeyID

      public final String kmsKeyID()

      The ARN of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

      Returns:
      The ARN of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

    • inboundFederation

      public final InboundFederationLambdaType inboundFederation()

      The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

      Returns:
      The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

    • toBuilder

      public LambdaConfigType.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<LambdaConfigType.Builder,LambdaConfigType>

    • builder

      public static LambdaConfigType.Builder builder()

    • serializableBuilderClass

      public static Class<? extends LambdaConfigType.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo