class UserPoolOperation

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.UserPoolOperation
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolOperation
Java	software.amazon.awscdk.services.cognito.UserPoolOperation
Python	aws_cdk.aws_cognito.UserPoolOperation
TypeScript (source)	aws-cdk-lib » aws_cognito » UserPoolOperation

User pool operations to which lambda triggers can be attached.

Example

const authChallengeFn = new lambda.Function(this, 'authChallengeFn', {
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.Code.fromAsset(path.join(__dirname, 'path/to/asset')),
});

const userpool = new cognito.UserPool(this, 'myuserpool', {
  // ...
  lambdaTriggers: {
    createAuthChallenge: authChallengeFn,
    // ...
  },
});

userpool.addTrigger(cognito.UserPoolOperation.USER_MIGRATION, new lambda.Function(this, 'userMigrationFn', {
    runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.Code.fromAsset(path.join(__dirname, 'path/to/asset')),
}));

Properties

Name	Type	Description
operationName	string	The key to use in CfnUserPool.LambdaConfigProperty.
static CREATE_AUTH_CHALLENGE	UserPoolOperation	Creates a challenge in a custom auth flow.
static CUSTOM_EMAIL_SENDER	UserPoolOperation	Amazon Cognito invokes this trigger to send email notifications to users.
static CUSTOM_MESSAGE	UserPoolOperation	Advanced customization and localization of messages.
static CUSTOM_SMS_SENDER	UserPoolOperation	Amazon Cognito invokes this trigger to send email notifications to users.
static DEFINE_AUTH_CHALLENGE	UserPoolOperation	Determines the next challenge in a custom auth flow.
static POST_AUTHENTICATION	UserPoolOperation	Event logging for custom analytics.
static POST_CONFIRMATION	UserPoolOperation	Custom welcome messages or event logging for custom analytics.
static PRE_AUTHENTICATION	UserPoolOperation	Custom validation to accept or deny the sign-in request.
static PRE_SIGN_UP	UserPoolOperation	Custom validation to accept or deny the sign-up request.
static PRE_TOKEN_GENERATION	UserPoolOperation	Add or remove attributes in Id tokens.
static PRE_TOKEN_GENERATION_CONFIG	UserPoolOperation	Add or remove attributes in Id tokens.
static USER_MIGRATION	UserPoolOperation	Migrate a user from an existing user directory to user pools.
static VERIFY_AUTH_CHALLENGE_RESPONSE	UserPoolOperation	Determines if a response is correct in a custom auth flow.

---

operationName

Type: string

The key to use in CfnUserPool.LambdaConfigProperty.

---

static CREATE_AUTH_CHALLENGE

Type: UserPoolOperation

Creates a challenge in a custom auth flow.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-create-auth-challenge.html

---

static CUSTOM_EMAIL_SENDER

Type: UserPoolOperation

Amazon Cognito invokes this trigger to send email notifications to users.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-email-sender.html

---

static CUSTOM_MESSAGE

Type: UserPoolOperation

Advanced customization and localization of messages.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-message.html

---

static CUSTOM_SMS_SENDER

Type: UserPoolOperation

Amazon Cognito invokes this trigger to send email notifications to users.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-custom-sms-sender.html

---

static DEFINE_AUTH_CHALLENGE

Type: UserPoolOperation

Determines the next challenge in a custom auth flow.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-define-auth-challenge.html

---

static POST_AUTHENTICATION

Type: UserPoolOperation

Event logging for custom analytics.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html

---

static POST_CONFIRMATION

Type: UserPoolOperation

Custom welcome messages or event logging for custom analytics.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html

---

static PRE_AUTHENTICATION

Type: UserPoolOperation

Custom validation to accept or deny the sign-in request.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html

---

static PRE_SIGN_UP

Type: UserPoolOperation

Custom validation to accept or deny the sign-up request.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html

---

static PRE_TOKEN_GENERATION

Type: UserPoolOperation

Add or remove attributes in Id tokens.

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: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html

---

static PRE_TOKEN_GENERATION_CONFIG

Type: UserPoolOperation

Add or remove attributes in Id tokens.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html

---

static USER_MIGRATION

Type: UserPoolOperation

Migrate a user from an existing user directory to user pools.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html

---

static VERIFY_AUTH_CHALLENGE_RESPONSE

Type: UserPoolOperation

Determines if a response is correct in a custom auth flow.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-verify-auth-challenge-response.html

Methods

Name	Description
static of(name)	A custom user pool operation.

---

static of(name)

public static of(name: string): UserPoolOperation

Parameters

• name string

Returns

• UserPoolOperation

A custom user pool operation.