aws-cdk-lib.aws_cognito.CfnUserPool.LambdaConfigProperty

interface LambdaConfigProperty

LanguageType name
.NETAmazon.CDK.AWS.Cognito.CfnUserPool.LambdaConfigProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_LambdaConfigProperty
Javasoftware.amazon.awscdk.services.cognito.CfnUserPool.LambdaConfigProperty
Pythonaws_cdk.aws_cognito.CfnUserPool.LambdaConfigProperty
TypeScript aws-cdk-lib » aws_cognito » CfnUserPool » LambdaConfigProperty

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 { 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',
  userMigration: 'userMigration',
  verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
};

Properties

NameTypeDescription
createAuthChallenge?stringCreates an authentication challenge.
customEmailSender?IResolvable | CustomEmailSenderPropertyA custom email sender AWS Lambda trigger.
customMessage?stringA custom Message AWS Lambda trigger.
customSmsSender?IResolvable | CustomSMSSenderPropertyA custom SMS sender AWS Lambda trigger.
defineAuthChallenge?stringDefines the authentication challenge.
kmsKeyId?stringThe Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key.
postAuthentication?stringA post-authentication AWS Lambda trigger.
postConfirmation?stringA post-confirmation AWS Lambda trigger.
preAuthentication?stringA pre-authentication AWS Lambda trigger.
preSignUp?stringA pre-registration AWS Lambda trigger.
preTokenGeneration?stringA Lambda trigger that is invoked before token generation.
userMigration?stringThe user migration Lambda config type.
verifyAuthChallengeResponse?stringVerifies the authentication challenge response.

createAuthChallenge?

Type: string (optional)

Creates an authentication challenge.


customEmailSender?

Type: IResolvable | CustomEmailSenderProperty (optional)

A custom email sender AWS Lambda trigger.


customMessage?

Type: string (optional)

A custom Message AWS Lambda trigger.


customSmsSender?

Type: IResolvable | CustomSMSSenderProperty (optional)

A custom SMS sender AWS Lambda trigger.


defineAuthChallenge?

Type: string (optional)

Defines the authentication challenge.


kmsKeyId?

Type: string (optional)

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 .


postAuthentication?

Type: string (optional)

A post-authentication AWS Lambda trigger.


postConfirmation?

Type: string (optional)

A post-confirmation AWS Lambda trigger.


preAuthentication?

Type: string (optional)

A pre-authentication AWS Lambda trigger.


preSignUp?

Type: string (optional)

A pre-registration AWS Lambda trigger.


preTokenGeneration?

Type: string (optional)

A Lambda trigger that is invoked before token generation.


userMigration?

Type: string (optional)

The user migration Lambda config type.


verifyAuthChallengeResponse?

Type: string (optional)

Verifies the authentication challenge response.