software.amazon.awscdk.services.cognito

Class UserPoolOperation

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cognito.UserPoolOperation

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:32.635Z")
public class UserPoolOperation
extends software.amazon.jsii.JsiiObject

User pool operations to which lambda triggers can be attached.

Example:

 Function authChallengeFn = Function.Builder.create(this, "authChallengeFn")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "path/to/asset")))
         .build();
 UserPool userpool = UserPool.Builder.create(this, "myuserpool")
         // ...
         .lambdaTriggers(UserPoolTriggers.builder()
                 .createAuthChallenge(authChallengeFn)
                 .build())
         .build();
 userpool.addTrigger(UserPoolOperation.USER_MIGRATION, Function.Builder.create(this, "userMigrationFn")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "path/to/asset")))
         .build());
 

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserPoolOperation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	UserPoolOperation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOperationName() The key to use in `CfnUserPool.LambdaConfigProperty`.
static UserPoolOperation	of(java.lang.String name) A custom user pool operation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CREATE_AUTH_CHALLENGE

public static final UserPoolOperation CREATE_AUTH_CHALLENGE

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

CUSTOM_EMAIL_SENDER

public static final UserPoolOperation CUSTOM_EMAIL_SENDER

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

CUSTOM_MESSAGE

public static final UserPoolOperation CUSTOM_MESSAGE

Advanced customization and localization of messages.

See Also:

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

CUSTOM_SMS_SENDER

public static final UserPoolOperation CUSTOM_SMS_SENDER

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

DEFINE_AUTH_CHALLENGE

public static final UserPoolOperation DEFINE_AUTH_CHALLENGE

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

POST_AUTHENTICATION

public static final UserPoolOperation POST_AUTHENTICATION

Event logging for custom analytics.

See Also:

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

POST_CONFIRMATION

public static final UserPoolOperation POST_CONFIRMATION

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

PRE_AUTHENTICATION

public static final UserPoolOperation PRE_AUTHENTICATION

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

PRE_SIGN_UP

public static final UserPoolOperation PRE_SIGN_UP

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

PRE_TOKEN_GENERATION

public static final UserPoolOperation PRE_TOKEN_GENERATION

Add or remove attributes in Id tokens.

See Also:

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

USER_MIGRATION

public static final UserPoolOperation USER_MIGRATION

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

VERIFY_AUTH_CHALLENGE_RESPONSE

public static final UserPoolOperation VERIFY_AUTH_CHALLENGE_RESPONSE

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

Constructor Detail

UserPoolOperation

protected UserPoolOperation(software.amazon.jsii.JsiiObjectRef objRef)

UserPoolOperation

protected UserPoolOperation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

of

public static UserPoolOperation of(java.lang.String name)

A custom user pool operation.

Parameters:

name - This parameter is required.

getOperationName

public java.lang.String getOperationName()

The key to use in `CfnUserPool.LambdaConfigProperty`.