Class UserPoolOperation
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cognito.UserPoolOperation
- All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:12.571Z")
@Stability(Stable)
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_LATEST) .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_LATEST) .handler("index.handler") .code(Code.fromAsset(join(__dirname, "path/to/asset"))) .build());
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
-
Field Summary
Modifier and TypeFieldDescriptionstatic final UserPoolOperation
Creates a challenge in a custom auth flow.static final UserPoolOperation
Amazon Cognito invokes this trigger to send email notifications to users.static final UserPoolOperation
Advanced customization and localization of messages.static final UserPoolOperation
Amazon Cognito invokes this trigger to send email notifications to users.static final UserPoolOperation
Determines the next challenge in a custom auth flow.static final UserPoolOperation
Event logging for custom analytics.static final UserPoolOperation
Custom welcome messages or event logging for custom analytics.static final UserPoolOperation
Custom validation to accept or deny the sign-in request.static final UserPoolOperation
Custom validation to accept or deny the sign-up request.static final UserPoolOperation
Add or remove attributes in Id tokens.static final UserPoolOperation
Add or remove attributes in Id tokens.static final UserPoolOperation
Migrate a user from an existing user directory to user pools.static final UserPoolOperation
Determines if a response is correct in a custom auth flow. -
Constructor Summary
ModifierConstructorDescriptionprotected
UserPoolOperation
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
UserPoolOperation
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe key to use inCfnUserPool.LambdaConfigProperty
.static UserPoolOperation
A custom user pool operation.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CREATE_AUTH_CHALLENGE
Creates a challenge in a custom auth flow.- See Also:
-
CUSTOM_EMAIL_SENDER
Amazon Cognito invokes this trigger to send email notifications to users.- See Also:
-
CUSTOM_MESSAGE
Advanced customization and localization of messages.- See Also:
-
CUSTOM_SMS_SENDER
Amazon Cognito invokes this trigger to send email notifications to users.- See Also:
-
DEFINE_AUTH_CHALLENGE
Determines the next challenge in a custom auth flow.- See Also:
-
POST_AUTHENTICATION
Event logging for custom analytics.- See Also:
-
POST_CONFIRMATION
Custom welcome messages or event logging for custom analytics.- See Also:
-
PRE_AUTHENTICATION
Custom validation to accept or deny the sign-in request.- See Also:
-
PRE_SIGN_UP
Custom validation to accept or deny the sign-up request.- See Also:
-
PRE_TOKEN_GENERATION
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:
-
PRE_TOKEN_GENERATION_CONFIG
Add or remove attributes in Id tokens.- See Also:
-
USER_MIGRATION
Migrate a user from an existing user directory to user pools.- See Also:
-
VERIFY_AUTH_CHALLENGE_RESPONSE
Determines if a response is correct in a custom auth flow.- See Also:
-
-
Constructor Details
-
UserPoolOperation
protected UserPoolOperation(software.amazon.jsii.JsiiObjectRef objRef) -
UserPoolOperation
protected UserPoolOperation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
-
-
Method Details
-
of
A custom user pool operation.- Parameters:
name
- This parameter is required.
-
getOperationName
The key to use inCfnUserPool.LambdaConfigProperty
.
-