Skip to content

LambdaConfigType

Used by
Source code in docs_src/capo_cognito_identity_provider/types/lambda_config_type.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
class LambdaConfigType(TypedDict, closed=True):
    pre_sign_up: NotRequired["capo_cognito_identity_provider.types.arn_type.ArnType"]
    """<p>The configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html">pre sign-up Lambda trigger</a> in a user pool. This trigger evaluates new users and can bypass confirmation, <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link a federated user profile</a>, or block sign-up requests.</p>"""
    custom_message: NotRequired["capo_cognito_identity_provider.types.arn_type.ArnType"]
    """<p>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.</p>"""
    post_confirmation: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html">post confirmation Lambda trigger</a> in a user pool. This trigger can take custom actions after a user confirms their user account and their email address or phone number.</p>"""
    pre_authentication: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html">pre authentication trigger</a> in a user pool. This trigger can evaluate and modify user sign-in events.</p>"""
    post_authentication: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-authentication.html">post authentication Lambda trigger</a> in a user pool. This trigger can take custom actions after a user signs in.</p>"""
    define_auth_challenge: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html">custom authentication challenge triggers</a>.</p>"""
    create_auth_challenge: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html">custom authentication challenge triggers</a>.</p>"""
    verify_auth_challenge_response: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html">custom authentication challenge triggers</a>.</p>"""
    pre_token_generation: NotRequired[
        "capo_cognito_identity_provider.types.arn_type.ArnType"
    ]
    """<p>The legacy configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html">pre token generation Lambda trigger</a> in a user pool.</p> <p>Set this parameter for legacy purposes. If you also set an ARN in <code>PreTokenGenerationConfig</code>, its value must be identical to <code>PreTokenGeneration</code>. For new instances of pre token generation triggers, set the <code>LambdaArn</code> of <code>PreTokenGenerationConfig</code>.</p>"""
    user_migration: NotRequired["capo_cognito_identity_provider.types.arn_type.ArnType"]
    """<p>The configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html">migrate user Lambda trigger</a> 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.</p>"""
    pre_token_generation_config: NotRequired[
        "capo_cognito_identity_provider.types.pre_token_generation_version_config_type.PreTokenGenerationVersionConfigType"
    ]
    """<p>The detailed configuration of a <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-token-generation.html">pre token generation Lambda trigger</a> in a user pool. If you also set an ARN in <code>PreTokenGeneration</code>, its value must be identical to <code>PreTokenGenerationConfig</code>.</p>"""
    custom_sms_sender: NotRequired[
        "capo_cognito_identity_provider.types.custom_sms_lambda_version_config_type.CustomSMSLambdaVersionConfigType"
    ]
    """<p>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.</p>"""
    custom_email_sender: NotRequired[
        "capo_cognito_identity_provider.types.custom_email_lambda_version_config_type.CustomEmailLambdaVersionConfigType"
    ]
    """<p>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.</p>"""
    kms_key_id: NotRequired["capo_cognito_identity_provider.types.arn_type.ArnType"]
    """<p>The ARN of an <a href="https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys">KMS key</a>. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.</p>"""
    inbound_federation: NotRequired[
        "capo_cognito_identity_provider.types.inbound_federation_lambda_type.InboundFederationLambdaType"
    ]
    """<p>The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.</p>"""

create_auth_challenge instance-attribute 

create_auth_challenge: NotRequired[ArnType]

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

custom_email_sender instance-attribute 

custom_email_sender: NotRequired[CustomEmailLambdaVersionConfigType]

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.

custom_message instance-attribute 

custom_message: NotRequired[ArnType]

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.

custom_sms_sender instance-attribute 

custom_sms_sender: NotRequired[CustomSMSLambdaVersionConfigType]

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.

define_auth_challenge instance-attribute 

define_auth_challenge: NotRequired[ArnType]

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

inbound_federation instance-attribute 

inbound_federation: NotRequired[InboundFederationLambdaType]

The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

kms_key_id instance-attribute 

kms_key_id: NotRequired[ArnType]

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

post_authentication instance-attribute 

post_authentication: NotRequired[ArnType]

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

post_confirmation instance-attribute 

post_confirmation: NotRequired[ArnType]

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.

pre_authentication instance-attribute 

pre_authentication: NotRequired[ArnType]

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

pre_sign_up instance-attribute 

pre_sign_up: NotRequired[ArnType]

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.

pre_token_generation instance-attribute 

pre_token_generation: NotRequired[ArnType]

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.

pre_token_generation_config instance-attribute 

pre_token_generation_config: NotRequired[PreTokenGenerationVersionConfigType]

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.

user_migration instance-attribute 

user_migration: NotRequired[ArnType]

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.

verify_auth_challenge_response instance-attribute 

verify_auth_challenge_response: NotRequired[ArnType]

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