interface LambdaConfigProperty
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Cognito.CfnUserPool.LambdaConfigProperty |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_LambdaConfigProperty |
Java | software.amazon.awscdk.services.cognito.CfnUserPool.LambdaConfigProperty |
Python | aws_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',
preTokenGenerationConfig: {
lambdaArn: 'lambdaArn',
lambdaVersion: 'lambdaVersion',
},
userMigration: 'userMigration',
verifyAuthChallengeResponse: 'verifyAuthChallengeResponse',
};
Properties
Name | Type | Description |
---|---|---|
create | string | Creates an authentication challenge. |
custom | IResolvable | Custom | A custom email sender AWS Lambda trigger. |
custom | string | A custom Message AWS Lambda trigger. |
custom | IResolvable | Custom | A custom SMS sender AWS Lambda trigger. |
define | string | Defines the authentication challenge. |
kms | string | The Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key. |
post | string | A post-authentication AWS Lambda trigger. |
post | string | A post-confirmation AWS Lambda trigger. |
pre | string | A pre-authentication AWS Lambda trigger. |
pre | string | A pre-registration AWS Lambda trigger. |
pre | string | The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger. |
pre | IResolvable | Pre | The detailed configuration of a pre token generation trigger. |
user | string | The user migration Lambda config type. |
verify | string | Verifies the authentication challenge response. |
createAuthChallenge?
Type:
string
(optional)
Creates an authentication challenge.
customEmailSender?
Type:
IResolvable
|
Custom
(optional)
A custom email sender AWS Lambda trigger.
customMessage?
Type:
string
(optional)
A custom Message AWS Lambda trigger.
customSmsSender?
Type:
IResolvable
|
Custom
(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)
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
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
.
You can set ``
preTokenGenerationConfig?
Type:
IResolvable
|
Pre
(optional)
The detailed configuration of a pre token generation trigger.
If you also set an ARN in PreTokenGeneration
, its value must be identical to PreTokenGenerationConfig
.
userMigration?
Type:
string
(optional)
The user migration Lambda config type.
verifyAuthChallengeResponse?
Type:
string
(optional)
Verifies the authentication challenge response.