UserPoolLambdaConfig

data class UserPoolLambdaConfig(val createAuthChallenge: String? = null, val customEmailSender: UserPoolCustomEmailSender? = null, val customMessage: String? = null, val customSmsSender: UserPoolCustomSmsSender? = null, val defineAuthChallenge: String? = null, val kmsKeyId: String? = null, val postAuthentication: String? = null, val postConfirmation: String? = null, val preAuthentication: String? = null, val preSignUp: String? = null, val preTokenGeneration: String? = null, val preTokenGenerationConfig: UserPoolPreTokenGenerationConfig? = null, val userMigration: String? = null, val verifyAuthChallengeResponse: String? = null)

Constructors

Link copied to clipboard
constructor(createAuthChallenge: String? = null, customEmailSender: UserPoolCustomEmailSender? = null, customMessage: String? = null, customSmsSender: UserPoolCustomSmsSender? = null, defineAuthChallenge: String? = null, kmsKeyId: String? = null, postAuthentication: String? = null, postConfirmation: String? = null, preAuthentication: String? = null, preSignUp: String? = null, preTokenGeneration: String? = null, preTokenGenerationConfig: UserPoolPreTokenGenerationConfig? = null, userMigration: String? = null, verifyAuthChallengeResponse: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
val customMessage: String? = null

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
val kmsKeyId: String? = null

The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.

Link copied to clipboard

The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.

Link copied to clipboard

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.

Link copied to clipboard

The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.

Link copied to clipboard
val preSignUp: String? = null

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.

Link copied to clipboard

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 .

Link copied to clipboard

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 .

Link copied to clipboard
val userMigration: String? = null

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.

Link copied to clipboard

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