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

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.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

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")
         .preTokenGenerationConfig(PreTokenGenerationConfigProperty.builder()
                 .lambdaArn("lambdaArn")
                 .lambdaVersion("lambdaVersion")
                 .build())
         .userMigration("userMigration")
         .verifyAuthChallengeResponse("verifyAuthChallengeResponse")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnUserPool.LambdaConfigProperty.Builder

A builder for CfnUserPool.LambdaConfigProperty

static final class

CfnUserPool.LambdaConfigProperty.Jsii$Proxy

An implementation for CfnUserPool.LambdaConfigProperty
Method Summary

Modifier and Type

Method

Description

static CfnUserPool.LambdaConfigProperty.Builder

builder()

default String

getCreateAuthChallenge()

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

default Object

getCustomEmailSender()

The configuration of a custom email sender Lambda trigger.

default String

getCustomMessage()

A custom message Lambda trigger.

default Object

getCustomSmsSender()

The configuration of a custom SMS sender Lambda trigger.

default String

getDefineAuthChallenge()

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

default String

getKmsKeyId()

The ARN of an KMS key .

default String

getPostAuthentication()

The configuration of a post authentication Lambda trigger in a user pool.

default String

getPostConfirmation()

The configuration of a post confirmation Lambda trigger in a user pool.

default String

getPreAuthentication()

The configuration of a pre authentication trigger in a user pool.

default String

getPreSignUp()

The configuration of a pre sign-up Lambda trigger in a user pool.

default String

getPreTokenGeneration()

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

default Object

getPreTokenGenerationConfig()

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

default String

getUserMigration()

The configuration of a migrate user Lambda trigger in a user pool.

default String

getVerifyAuthChallengeResponse()

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- getCreateAuthChallenge
  
  @Stability(Stable) @Nullable default String getCreateAuthChallenge()
  
  The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge
- getCustomEmailSender
  
  @Stability(Stable) @Nullable default Object getCustomEmailSender()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-customemailsender
- getCustomMessage
  
  @Stability(Stable) @Nullable default String getCustomMessage()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage
- getCustomSmsSender
  
  @Stability(Stable) @Nullable default Object getCustomSmsSender()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-customsmssender
- getDefineAuthChallenge
  
  @Stability(Stable) @Nullable default String getDefineAuthChallenge()
  
  The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge
- getKmsKeyId
  
  @Stability(Stable) @Nullable default String getKmsKeyId()
  
  The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-kmskeyid
- getPostAuthentication
  
  @Stability(Stable) @Nullable default String getPostAuthentication()
  
  The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication
- getPostConfirmation
  
  @Stability(Stable) @Nullable default String getPostConfirmation()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation
- getPreAuthentication
  
  @Stability(Stable) @Nullable default String getPreAuthentication()
  
  The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication
- getPreSignUp
  
  @Stability(Stable) @Nullable default String getPreSignUp()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup
- getPreTokenGeneration
  
  @Stability(Stable) @Nullable default String getPreTokenGeneration()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration
- getPreTokenGenerationConfig
  
  @Stability(Stable) @Nullable default Object getPreTokenGenerationConfig()
  
  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 .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengenerationconfig
- getUserMigration
  
  @Stability(Stable) @Nullable default String getUserMigration()
  
  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.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration
- getVerifyAuthChallengeResponse
  
  @Stability(Stable) @Nullable default String getVerifyAuthChallengeResponse()
  
  The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse
- builder
  
  @Stability(Stable) static CfnUserPool.LambdaConfigProperty.Builder builder()
  
  Returns:
  
  a CfnUserPool.LambdaConfigProperty.Builder of CfnUserPool.LambdaConfigProperty

Interface CfnUserPool.LambdaConfigProperty

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getCreateAuthChallenge

getCustomEmailSender

getCustomMessage

getCustomSmsSender

getDefineAuthChallenge

getKmsKeyId

getPostAuthentication

getPostConfirmation

getPreAuthentication

getPreSignUp

getPreTokenGeneration

getPreTokenGenerationConfig

getUserMigration

getVerifyAuthChallengeResponse

builder