Class: Aws::CognitoIdentityProvider::Types::LambdaConfigType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::LambdaConfigType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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.

This data type is a request and response parameter of

CreateUserPool][1

and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #create_auth_challenge ⇒ String

  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 ⇒ Types::CustomEmailLambdaVersionConfigType

  The configuration of a custom email sender Lambda trigger.

• #custom_message ⇒ String

  A custom message Lambda trigger.

• #custom_sms_sender ⇒ Types::CustomSMSLambdaVersionConfigType

  The configuration of a custom SMS sender Lambda trigger.

• #define_auth_challenge ⇒ String

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

• #kms_key_id ⇒ String

  The ARN of an [KMS key].

• #post_authentication ⇒ String

  The configuration of a [post authentication Lambda trigger] in a user pool.

• #post_confirmation ⇒ String

  The configuration of a [post confirmation Lambda trigger] in a user pool.

• #pre_authentication ⇒ String

  The configuration of a [pre authentication trigger] in a user pool.

• #pre_sign_up ⇒ String

  The configuration of a [pre sign-up Lambda trigger] in a user pool.

• #pre_token_generation ⇒ String

  The legacy configuration of a [pre token generation Lambda trigger] in a user pool.

• #pre_token_generation_config ⇒ Types::PreTokenGenerationVersionConfigType

  The detailed configuration of a [pre token generation Lambda trigger] in a user pool.

• #user_migration ⇒ String

  The configuration of a [migrate user Lambda trigger] in a user pool.

• #verify_auth_challenge_response ⇒ String

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

Instance Attribute Details

#create_auth_challenge ⇒ String

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_email_sender ⇒ Types::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.

Returns:

• (Types::CustomEmailLambdaVersionConfigType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_message ⇒ 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.

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_sms_sender ⇒ Types::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.

Returns:

• (Types::CustomSMSLambdaVersionConfigType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#define_auth_challenge ⇒ String

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

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

[1]: docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#post_authentication ⇒ String

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

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#post_confirmation ⇒ 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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-post-confirmation.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_authentication ⇒ String

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-authentication.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_sign_up ⇒ 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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-pre-sign-up.html [2]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_token_generation ⇒ 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`.

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

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_token_generation_config ⇒ Types::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`.

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

Returns:

• (Types::PreTokenGenerationVersionConfigType)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_migration ⇒ 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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-migrate-user.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#verify_auth_challenge_response ⇒ String

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

[1]: docs.aws.amazon.com/cognito/latest/developerguide/user-pool-lambda-challenge.html

Returns:

• (String)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7558

class LambdaConfigType < Struct.new(
  :pre_sign_up,
  :custom_message,
  :post_confirmation,
  :pre_authentication,
  :post_authentication,
  :define_auth_challenge,
  :create_auth_challenge,
  :verify_auth_challenge_response,
  :pre_token_generation,
  :user_migration,
  :pre_token_generation_config,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end