Struct LambdaConfigType

#[non_exhaustive]
pub struct LambdaConfigType {

    pub pre_sign_up: Option<String>,
    pub custom_message: Option<String>,
    pub post_confirmation: Option<String>,
    pub pre_authentication: Option<String>,
    pub post_authentication: Option<String>,
    pub define_auth_challenge: Option<String>,
    pub create_auth_challenge: Option<String>,
    pub verify_auth_challenge_response: Option<String>,
    pub pre_token_generation: Option<String>,
    pub user_migration: Option<String>,
    pub pre_token_generation_config: Option<PreTokenGenerationVersionConfigType>,
    pub custom_sms_sender: Option<CustomSmsLambdaVersionConfigType>,
    pub custom_email_sender: Option<CustomEmailLambdaVersionConfigType>,
    pub kms_key_id: Option<String>,
}

A collection of user pool Lambda triggers. Amazon Cognito invokes triggers at several possible stages of user pool operations. Triggers can modify the outcome of the operations that invoked them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

pre_sign_up: Option<String>

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.

custom_message: Option<String>

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.

post_confirmation: Option<String>

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: Option<String>

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

post_authentication: Option<String>

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

define_auth_challenge: Option<String>

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

create_auth_challenge: Option<String>

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

verify_auth_challenge_response: Option<String>

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

pre_token_generation: Option<String>

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.

user_migration: Option<String>

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.

pre_token_generation_config: Option<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.

custom_sms_sender: Option<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.

custom_email_sender: Option<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.

kms_key_id: Option<String>

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

Implementations

impl LambdaConfigType

pub fn pre_sign_up(&self) -> Option<&str>

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.

pub fn custom_message(&self) -> Option<&str>

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.

pub fn post_confirmation(&self) -> Option<&str>

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.

pub fn pre_authentication(&self) -> Option<&str>

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

pub fn post_authentication(&self) -> Option<&str>

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

pub fn define_auth_challenge(&self) -> Option<&str>

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

pub fn create_auth_challenge(&self) -> Option<&str>

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

pub fn verify_auth_challenge_response(&self) -> Option<&str>

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

pub fn pre_token_generation(&self) -> Option<&str>

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.

pub fn user_migration(&self) -> Option<&str>

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.

pub fn pre_token_generation_config( &self, ) -> Option<&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.

pub fn custom_sms_sender(&self) -> Option<&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.

pub fn custom_email_sender(&self) -> Option<&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.

pub fn kms_key_id(&self) -> Option<&str>

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

impl LambdaConfigType

pub fn builder() -> LambdaConfigTypeBuilder

Creates a new builder-style object to manufacture LambdaConfigType.

Trait Implementations

impl Clone for LambdaConfigType

fn clone(&self) -> LambdaConfigType

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LambdaConfigType

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for LambdaConfigType

fn eq(&self, other: &LambdaConfigType) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for LambdaConfigType