Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.LambdaConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnUserPool.LambdaConfigProperty.Jsii$Proxy
Enclosing class:
CfnUserPool
@Stability(Stable) public static interface CfnUserPool.LambdaConfigProperty extends software.amazon.jsii.JsiiSerializable
Specifies the configuration for AWS Lambda triggers.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 LambdaConfigProperty lambdaConfigProperty = LambdaConfigProperty.builder()
         .createAuthChallenge("createAuthChallenge")
         .customEmailSender(CustomEmailSenderProperty.builder()
                 .lambdaArn("lambdaArn")
                 .lambdaVersion("lambdaVersion")
                 .build())
         .customMessage("customMessage")
         .customSmsSender(CustomSMSSenderProperty.builder()
                 .lambdaArn("lambdaArn")
                 .lambdaVersion("lambdaVersion")
                 .build())
         .defineAuthChallenge("defineAuthChallenge")
         .kmsKeyId("kmsKeyId")
         .postAuthentication("postAuthentication")
         .postConfirmation("postConfirmation")
         .preAuthentication("preAuthentication")
         .preSignUp("preSignUp")
         .preTokenGeneration("preTokenGeneration")
         .userMigration("userMigration")
         .verifyAuthChallengeResponse("verifyAuthChallengeResponse")
         .build();

  • Method Details

    • getCreateAuthChallenge

      @Stability(Stable) @Nullable default String getCreateAuthChallenge()
      Creates an authentication challenge.

    • getCustomEmailSender

      @Stability(Stable) @Nullable default Object getCustomEmailSender()
      A custom email sender AWS Lambda trigger.

    • getCustomMessage

      @Stability(Stable) @Nullable default String getCustomMessage()
      A custom Message AWS Lambda trigger.

    • getCustomSmsSender

      @Stability(Stable) @Nullable default Object getCustomSmsSender()
      A custom SMS sender AWS Lambda trigger.

    • getDefineAuthChallenge

      @Stability(Stable) @Nullable default String getDefineAuthChallenge()
      Defines the authentication challenge.

    • getKmsKeyId

      @Stability(Stable) @Nullable default String getKmsKeyId()
      The Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key.

      Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender .

    • getPostAuthentication

      @Stability(Stable) @Nullable default String getPostAuthentication()
      A post-authentication AWS Lambda trigger.

    • getPostConfirmation

      @Stability(Stable) @Nullable default String getPostConfirmation()
      A post-confirmation AWS Lambda trigger.

    • getPreAuthentication

      @Stability(Stable) @Nullable default String getPreAuthentication()
      A pre-authentication AWS Lambda trigger.

    • getPreSignUp

      @Stability(Stable) @Nullable default String getPreSignUp()
      A pre-registration AWS Lambda trigger.

    • getPreTokenGeneration

      @Stability(Stable) @Nullable default String getPreTokenGeneration()
      A Lambda trigger that is invoked before token generation.

    • getUserMigration

      @Stability(Stable) @Nullable default String getUserMigration()
      The user migration Lambda config type.

    • getVerifyAuthChallengeResponse

      @Stability(Stable) @Nullable default String getVerifyAuthChallengeResponse()
      Verifies the authentication challenge response.

    • builder

      @Stability(Stable) static CfnUserPool.LambdaConfigProperty.Builder builder()
      Returns:
      a CfnUserPool.LambdaConfigProperty.Builder of CfnUserPool.LambdaConfigProperty