AWS::Cognito::UserPool LambdaConfig
Specifies the configuration for Amazon Lambda triggers.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "CreateAuthChallenge" :
String
, "CustomEmailSender" :CustomEmailSender
, "CustomMessage" :String
, "CustomSMSSender" :CustomSMSSender
, "DefineAuthChallenge" :String
, "KMSKeyID" :String
, "PostAuthentication" :String
, "PostConfirmation" :String
, "PreAuthentication" :String
, "PreSignUp" :String
, "PreTokenGeneration" :String
, "PreTokenGenerationConfig" :PreTokenGenerationConfig
, "UserMigration" :String
, "VerifyAuthChallengeResponse" :String
}
YAML
CreateAuthChallenge:
String
CustomEmailSender:CustomEmailSender
CustomMessage:String
CustomSMSSender:CustomSMSSender
DefineAuthChallenge:String
KMSKeyID:String
PostAuthentication:String
PostConfirmation:String
PreAuthentication:String
PreSignUp:String
PreTokenGeneration:String
PreTokenGenerationConfig:PreTokenGenerationConfig
UserMigration:String
VerifyAuthChallengeResponse:String
Properties
CreateAuthChallenge
-
Creates an authentication challenge.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
CustomEmailSender
-
A custom email sender Amazon Lambda trigger.
Required: No
Type: CustomEmailSender
Update requires: No interruption
CustomMessage
-
A custom Message Amazon Lambda trigger.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
CustomSMSSender
-
A custom SMS sender Amazon Lambda trigger.
Required: No
Type: CustomSMSSender
Update requires: No interruption
DefineAuthChallenge
-
Defines the authentication challenge.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
KMSKeyID
-
The Amazon Resource Name of a Amazon Key Management Service (Amazon KMS) key. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to
CustomEmailSender
andCustomSMSSender
.Required: No
Type: String
Update requires: No interruption
PostAuthentication
-
A post-authentication Amazon Lambda trigger.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
PostConfirmation
-
A post-confirmation Amazon Lambda trigger.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
PreAuthentication
-
A pre-authentication Amazon Lambda trigger.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
PreSignUp
-
A pre-registration Amazon Lambda trigger.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
PreTokenGeneration
-
The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
Set this parameter for legacy purposes. If you also set an ARN in
PreTokenGenerationConfig
, its value must be identical toPreTokenGeneration
. For new instances of pre token generation triggers, set theLambdaArn
ofPreTokenGenerationConfig
.You can set
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
PreTokenGenerationConfig
-
The detailed configuration of a pre token generation trigger. If you also set an ARN in
PreTokenGeneration
, its value must be identical toPreTokenGenerationConfig
.Required: No
Type: PreTokenGenerationConfig
Update requires: No interruption
UserMigration
-
The user migration Lambda config type.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption
VerifyAuthChallengeResponse
-
Verifies the authentication challenge response.
Required: No
Type: String
Pattern:
arn:[\w+=/,.@-]+:[\w+=/,.@-]+:([\w+=/,.@-]*)?:[0-9]+:[\w+=/,.@-]+(:[\w+=/,.@-]+)?(:[\w+=/,.@-]+)?
Minimum:
20
Maximum:
2048
Update requires: No interruption