UserPoolOperation

class aws_cdk.aws_cognito.UserPoolOperation(*args: Any, **kwargs)

Bases: object

User pool operations to which lambda triggers can be attached.

ExampleMetadata

infused

Example:

auth_challenge_fn = lambda_.Function(self, "authChallengeFn",
    runtime=lambda_.Runtime.NODEJS_12_X,
    handler="index.handler",
    code=lambda_.Code.from_asset(path.join(__dirname, "path/to/asset"))
)

userpool = cognito.UserPool(self, "myuserpool",
    # ...
    lambda_triggers=cognito.UserPoolTriggers(
        create_auth_challenge=auth_challenge_fn
    )
)

userpool.add_trigger(cognito.UserPoolOperation.USER_MIGRATION, lambda_.Function(self, "userMigrationFn",
    runtime=lambda_.Runtime.NODEJS_12_X,
    handler="index.handler",
    code=lambda_.Code.from_asset(path.join(__dirname, "path/to/asset"))
))

Attributes

CREATE_AUTH_CHALLENGE = <aws_cdk.aws_cognito.UserPoolOperation object>

CUSTOM_EMAIL_SENDER = <aws_cdk.aws_cognito.UserPoolOperation object>

CUSTOM_MESSAGE = <aws_cdk.aws_cognito.UserPoolOperation object>

CUSTOM_SMS_SENDER = <aws_cdk.aws_cognito.UserPoolOperation object>

DEFINE_AUTH_CHALLENGE = <aws_cdk.aws_cognito.UserPoolOperation object>

POST_AUTHENTICATION = <aws_cdk.aws_cognito.UserPoolOperation object>

POST_CONFIRMATION = <aws_cdk.aws_cognito.UserPoolOperation object>

PRE_AUTHENTICATION = <aws_cdk.aws_cognito.UserPoolOperation object>

PRE_SIGN_UP = <aws_cdk.aws_cognito.UserPoolOperation object>

PRE_TOKEN_GENERATION = <aws_cdk.aws_cognito.UserPoolOperation object>

USER_MIGRATION = <aws_cdk.aws_cognito.UserPoolOperation object>

VERIFY_AUTH_CHALLENGE_RESPONSE = <aws_cdk.aws_cognito.UserPoolOperation object>

operation_name

The key to use in CfnUserPool.LambdaConfigProperty.

Return type

str

Static Methods

classmethod of(name)

A custom user pool operation.

Parameters

name (str) –

Return type

UserPoolOperation