Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.LambdaConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.LambdaConfigProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.LambdaConfigProperty
extends software.amazon.jsii.JsiiSerializable

Specifies the configuration for AWS Lambda triggers.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 LambdaConfigProperty lambdaConfigProperty = LambdaConfigProperty.builder()
         .createAuthChallenge("createAuthChallenge")
         .customEmailSender(CustomEmailSenderProperty.builder()
                 .lambdaArn("lambdaArn")
                 .lambdaVersion("lambdaVersion")
                 .build())
         .customMessage("customMessage")
         .customSmsSender(CustomSMSSenderProperty.builder()
                 .lambdaArn("lambdaArn")
                 .lambdaVersion("lambdaVersion")
                 .build())
         .defineAuthChallenge("defineAuthChallenge")
         .kmsKeyId("kmsKeyId")
         .postAuthentication("postAuthentication")
         .postConfirmation("postConfirmation")
         .preAuthentication("preAuthentication")
         .preSignUp("preSignUp")
         .preTokenGeneration("preTokenGeneration")
         .preTokenGenerationConfig(PreTokenGenerationConfigProperty.builder()
                 .lambdaArn("lambdaArn")
                 .lambdaVersion("lambdaVersion")
                 .build())
         .userMigration("userMigration")
         .verifyAuthChallengeResponse("verifyAuthChallengeResponse")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.LambdaConfigProperty.Builder	A builder for CfnUserPool.LambdaConfigProperty
static final class	CfnUserPool.LambdaConfigProperty.Jsii$Proxy	An implementation for CfnUserPool.LambdaConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.LambdaConfigProperty.Builder	builder()
default String	getCreateAuthChallenge()	Creates an authentication challenge.
default Object	getCustomEmailSender()	A custom email sender AWS Lambda trigger.
default String	getCustomMessage()	A custom Message AWS Lambda trigger.
default Object	getCustomSmsSender()	A custom SMS sender AWS Lambda trigger.
default String	getDefineAuthChallenge()	Defines the authentication challenge.
default String	getKmsKeyId()	The Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key.
default String	getPostAuthentication()	A post-authentication AWS Lambda trigger.
default String	getPostConfirmation()	A post-confirmation AWS Lambda trigger.
default String	getPreAuthentication()	A pre-authentication AWS Lambda trigger.
default String	getPreSignUp()	A pre-registration AWS Lambda trigger.
default String	getPreTokenGeneration()	The Amazon Resource Name (ARN) of the function that you want to assign to your Lambda trigger.
default Object	getPreTokenGenerationConfig()	The detailed configuration of a pre token generation trigger.
default String	getUserMigration()	The user migration Lambda config type.
default String	getVerifyAuthChallengeResponse()	Verifies the authentication challenge response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCreateAuthChallenge

@Stability(Stable)
@Nullable
default String getCreateAuthChallenge()

Creates an authentication challenge.

See Also:

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

getCustomEmailSender

@Stability(Stable)
@Nullable
default Object getCustomEmailSender()

A custom email sender AWS Lambda trigger.

See Also:

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

getCustomMessage

@Stability(Stable)
@Nullable
default String getCustomMessage()

A custom Message AWS Lambda trigger.

See Also:

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

getCustomSmsSender

@Stability(Stable)
@Nullable
default Object getCustomSmsSender()

A custom SMS sender AWS Lambda trigger.

See Also:

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

getDefineAuthChallenge

@Stability(Stable)
@Nullable
default String getDefineAuthChallenge()

Defines the authentication challenge.

See Also:

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

getKmsKeyId

@Stability(Stable)
@Nullable
default String getKmsKeyId()

The Amazon Resource Name of a AWS Key Management Service ( AWS KMS ) key.

Amazon Cognito uses the key to encrypt codes and temporary passwords sent to CustomEmailSender and CustomSMSSender .

See Also:

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

getPostAuthentication

@Stability(Stable)
@Nullable
default String getPostAuthentication()

A post-authentication AWS Lambda trigger.

See Also:

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

getPostConfirmation

@Stability(Stable)
@Nullable
default String getPostConfirmation()

A post-confirmation AWS Lambda trigger.

See Also:

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

getPreAuthentication

@Stability(Stable)
@Nullable
default String getPreAuthentication()

A pre-authentication AWS Lambda trigger.

See Also:

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

getPreSignUp

@Stability(Stable)
@Nullable
default String getPreSignUp()

A pre-registration AWS Lambda trigger.

See Also:

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

getPreTokenGeneration

@Stability(Stable)
@Nullable
default String getPreTokenGeneration()

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 to PreTokenGeneration . For new instances of pre token generation triggers, set the LambdaArn of PreTokenGenerationConfig .

You can set ``

See Also:

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

getPreTokenGenerationConfig

@Stability(Stable)
@Nullable
default Object getPreTokenGenerationConfig()

The detailed configuration of a pre token generation trigger.

If you also set an ARN in PreTokenGeneration , its value must be identical to PreTokenGenerationConfig .

See Also:

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

getUserMigration

@Stability(Stable)
@Nullable
default String getUserMigration()

The user migration Lambda config type.

See Also:

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

getVerifyAuthChallengeResponse

@Stability(Stable)
@Nullable
default String getVerifyAuthChallengeResponse()

Verifies the authentication challenge response.

See Also:

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

builder

@Stability(Stable)
static CfnUserPool.LambdaConfigProperty.Builder builder()

Returns:

a CfnUserPool.LambdaConfigProperty.Builder of CfnUserPool.LambdaConfigProperty