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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass LambdaConfigType data as a hash:

{
  pre_sign_up: "ArnType",
  custom_message: "ArnType",
  post_confirmation: "ArnType",
  pre_authentication: "ArnType",
  post_authentication: "ArnType",
  define_auth_challenge: "ArnType",
  create_auth_challenge: "ArnType",
  verify_auth_challenge_response: "ArnType",
  pre_token_generation: "ArnType",
  user_migration: "ArnType",
  custom_sms_sender: {
    lambda_version: "V1_0", # required, accepts V1_0
    lambda_arn: "ArnType", # required
  },
  custom_email_sender: {
    lambda_version: "V1_0", # required, accepts V1_0
    lambda_arn: "ArnType", # required
  },
  kms_key_id: "ArnType",
}

Specifies the configuration for Lambda triggers.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#create_auth_challenge ⇒ String

Creates an authentication challenge.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_email_sender ⇒ Types::CustomEmailLambdaVersionConfigType

A custom email sender Lambda trigger.

Returns:



6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_message ⇒ String

A custom Message Lambda trigger.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#custom_sms_sender ⇒ Types::CustomSMSLambdaVersionConfigType

A custom SMS sender Lambda trigger.

Returns:



6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#define_auth_challenge ⇒ String

Defines the authentication challenge.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_id ⇒ String

The Amazon Resource Name (ARN) of an KMS key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#post_authentication ⇒ String

A post-authentication Lambda trigger.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#post_confirmation ⇒ String

A post-confirmation Lambda trigger.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_authentication ⇒ String

A pre-authentication Lambda trigger.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_sign_up ⇒ String

A pre-registration Lambda trigger.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#pre_token_generation ⇒ String

A Lambda trigger that is invoked before token generation.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_migration ⇒ String

The user migration Lambda config type.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end

#verify_auth_challenge_response ⇒ String

Verifies the authentication challenge response.

Returns:

  • (String) 


6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
 
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6463

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,
  :custom_sms_sender,
  :custom_email_sender,
  :kms_key_id)
  SENSITIVE = []
  include Aws::Structure
end