Interface CfnUserPoolPropsMixin.ILambdaConfigProperty

A collection of user pool Lambda triggers.

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.Cognito

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public interface CfnUserPoolPropsMixin.ILambdaConfigProperty

Syntax (vb)

Public Interface CfnUserPoolPropsMixin.ILambdaConfigProperty

Remarks

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.Cognito;

             var lambdaConfigProperty = new LambdaConfigProperty {
                 CreateAuthChallenge = "createAuthChallenge",
                 CustomEmailSender = new CustomEmailSenderProperty {
                     LambdaArn = "lambdaArn",
                     LambdaVersion = "lambdaVersion"
                 },
                 CustomMessage = "customMessage",
                 CustomSmsSender = new CustomSMSSenderProperty {
                     LambdaArn = "lambdaArn",
                     LambdaVersion = "lambdaVersion"
                 },
                 DefineAuthChallenge = "defineAuthChallenge",
                 InboundFederation = new InboundFederationProperty {
                     LambdaArn = "lambdaArn",
                     LambdaVersion = "lambdaVersion"
                 },
                 KmsKeyId = "kmsKeyId",
                 PostAuthentication = "postAuthentication",
                 PostConfirmation = "postConfirmation",
                 PreAuthentication = "preAuthentication",
                 PreSignUp = "preSignUp",
                 PreTokenGeneration = "preTokenGeneration",
                 PreTokenGenerationConfig = new PreTokenGenerationConfigProperty {
                     LambdaArn = "lambdaArn",
                     LambdaVersion = "lambdaVersion"
                 },
                 UserMigration = "userMigration",
                 VerifyAuthChallengeResponse = "verifyAuthChallengeResponse"
             };

Synopsis

Properties

CreateAuthChallenge	The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
CustomEmailSender	The configuration of a custom email sender Lambda trigger.
CustomMessage	A custom message Lambda trigger.
CustomSmsSender	The configuration of a custom SMS sender Lambda trigger.
DefineAuthChallenge	The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .
InboundFederation	A collection of user pool Lambda triggers.
KmsKeyId	The ARN of an KMS key . Amazon Cognito uses the key to encrypt codes and temporary passwords sent to custom sender Lambda triggers.
PostAuthentication	The configuration of a post authentication Lambda trigger in a user pool. This trigger can take custom actions after a user signs in.
PostConfirmation	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.
PreAuthentication	The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.
PreSignUp	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.
PreTokenGeneration	The legacy configuration of a pre token generation Lambda trigger in a user pool.
PreTokenGenerationConfig	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` .
UserMigration	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.
VerifyAuthChallengeResponse	The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers .

Properties

CreateAuthChallenge

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

object? CreateAuthChallenge { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-createauthchallenge

Type union: either string or IFunctionRef

CustomEmailSender

The configuration of a custom email sender Lambda trigger.

object? CustomEmailSender { get; }

Property Value

object

Remarks

This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-customemailsender

Type union: either IResolvable or CfnUserPoolPropsMixin.ICustomEmailSenderProperty

CustomMessage

A custom message Lambda trigger.

object? CustomMessage { get; }

Property Value

object

Remarks

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-custommessage

Type union: either string or IFunctionRef

CustomSmsSender

The configuration of a custom SMS sender Lambda trigger.

object? CustomSmsSender { get; }

Property Value

object

Remarks

This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-customsmssender

Type union: either IResolvable or CfnUserPoolPropsMixin.ICustomSMSSenderProperty

DefineAuthChallenge

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

object? DefineAuthChallenge { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-defineauthchallenge

Type union: either string or IFunctionRef

InboundFederation

A collection of user pool Lambda triggers.

object? InboundFederation { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-inboundfederation

Type union: either IResolvable or CfnUserPoolPropsMixin.IInboundFederationProperty

KmsKeyId

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

object? KmsKeyId { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-kmskeyid

Type union: either string or IKeyRef

PostAuthentication

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

object? PostAuthentication { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postauthentication

Type union: either string or IFunctionRef

PostConfirmation

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.

object? PostConfirmation { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-postconfirmation

Type union: either string or IFunctionRef

PreAuthentication

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

object? PreAuthentication { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-preauthentication

Type union: either string or IFunctionRef

PreSignUp

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.

object? PreSignUp { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-presignup

Type union: either string or IFunctionRef

PreTokenGeneration

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

object? PreTokenGeneration { get; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengeneration

Type union: either string or IFunctionRef

PreTokenGenerationConfig

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 .

object? PreTokenGenerationConfig { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-pretokengenerationconfig

Type union: either IResolvable or CfnUserPoolPropsMixin.IPreTokenGenerationConfigProperty

UserMigration

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.

string? UserMigration { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-usermigration

VerifyAuthChallengeResponse

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

object? VerifyAuthChallengeResponse { get; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-lambdaconfig.html#cfn-cognito-userpool-lambdaconfig-verifyauthchallengeresponse

Type union: either string or IFunctionRef