interface LambdaConfigProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.Cognito.CfnUserPool.LambdaConfigProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_LambdaConfigProperty |
![]() | software.amazon.awscdk.services.cognito.CfnUserPool.LambdaConfigProperty |
![]() | aws_cdk.aws_cognito.CfnUserPool.LambdaConfigProperty |
![]() | aws-cdk-lib » aws_cognito » CfnUserPool » LambdaConfigProperty |
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const lambdaConfigProperty: cognito.CfnUserPool.LambdaConfigProperty = {
createAuthChallenge: 'createAuthChallenge',
customEmailSender: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
customMessage: 'customMessage',
customSmsSender: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
defineAuthChallenge: 'defineAuthChallenge',
kmsKeyId: 'kmsKeyId',
postAuthentication: 'postAuthentication',
postConfirmation: 'postConfirmation',
preAuthentication: 'preAuthentication',
preSignUp: 'preSignUp',
preTokenGeneration: 'preTokenGeneration',
preTokenGenerationConfig: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
userMigration: 'userMigration',
verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
};
Properties
Name | Type | Description |
---|---|---|
create | string | The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers . |
custom | IResolvable | Custom | The configuration of a custom email sender Lambda trigger. |
custom | string | A custom message Lambda trigger. |
custom | IResolvable | Custom | The configuration of a custom SMS sender Lambda trigger. |
define | string | The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers . |
kms | string | The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers. |
post | string | The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in. |
post | string | 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. |
pre | string | The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events. |
pre | string | 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. |
pre | string | The legacy configuration of a pre token generation Lambda trigger in a user pool. |
pre | IResolvable | Pre | 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 . |
user | string | 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. |
verify | string | The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers . |
createAuthChallenge?
Type:
string
(optional)
The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
customEmailSender?
Type:
IResolvable
|
Custom
(optional)
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.
customMessage?
Type:
string
(optional)
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.
customSmsSender?
Type:
IResolvable
|
Custom
(optional)
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.
defineAuthChallenge?
Type:
string
(optional)
The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
kmsKeyId?
Type:
string
(optional)
The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.
postAuthentication?
Type:
string
(optional)
The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.
postConfirmation?
Type:
string
(optional)
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?
Type:
string
(optional)
The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.
preSignUp?
Type:
string
(optional)
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.
preTokenGeneration?
Type:
string
(optional)
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
.
preTokenGenerationConfig?
Type:
IResolvable
|
Pre
(optional)
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
.
userMigration?
Type:
string
(optional)
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.
verifyAuthChallengeResponse?
Type:
string
(optional)
The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .