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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#create_auth_challengeString

Creates an authentication challenge.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_senderTypes::CustomEmailLambdaVersionConfigType

A custom email sender Lambda trigger.



6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_messageString

A custom Message Lambda trigger.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_senderTypes::CustomSMSLambdaVersionConfigType

A custom SMS sender Lambda trigger.



6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_challengeString

Defines the authentication challenge.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_idString

The Amazon Resource Name of Key Management Service Customer master keys . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_authenticationString

A post-authentication Lambda trigger.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_confirmationString

A post-confirmation Lambda trigger.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_authenticationString

A pre-authentication Lambda trigger.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_upString

A pre-registration Lambda trigger.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_generationString

A Lambda trigger that is invoked before token generation.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_migrationString

The user migration Lambda config type.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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_responseString

Verifies the authentication challenge response.

Returns:

  • (String)


6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6199

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