Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface LambdaConfigType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<LambdaConfigType.Builder,LambdaConfigType>, SdkBuilder<LambdaConfigType.Builder,LambdaConfigType>, SdkPojo

Enclosing class:

LambdaConfigType

@Mutable
@NotThreadSafe
public static interface LambdaConfigType.Builder
extends SdkPojo, CopyableBuilder<LambdaConfigType.Builder,LambdaConfigType>

Method Summary

Modifier and Type	Method	Description
LambdaConfigType.Builder	createAuthChallenge(String createAuthChallenge)	The configuration of a create auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.
default LambdaConfigType.Builder	customEmailSender(Consumer<CustomEmailLambdaVersionConfigType.Builder> customEmailSender)	The configuration of a custom email sender Lambda trigger.
LambdaConfigType.Builder	customEmailSender(CustomEmailLambdaVersionConfigType customEmailSender)	The configuration of a custom email sender Lambda trigger.
LambdaConfigType.Builder	customMessage(String customMessage)	A custom message Lambda trigger.
default LambdaConfigType.Builder	customSMSSender(Consumer<CustomSMSLambdaVersionConfigType.Builder> customSMSSender)	The configuration of a custom SMS sender Lambda trigger.
LambdaConfigType.Builder	customSMSSender(CustomSMSLambdaVersionConfigType customSMSSender)	The configuration of a custom SMS sender Lambda trigger.
LambdaConfigType.Builder	defineAuthChallenge(String defineAuthChallenge)	The configuration of a define auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.
default LambdaConfigType.Builder	inboundFederation(Consumer<InboundFederationLambdaType.Builder> inboundFederation)	The configuration of an inbound federation Lambda trigger.
LambdaConfigType.Builder	inboundFederation(InboundFederationLambdaType inboundFederation)	The configuration of an inbound federation Lambda trigger.
LambdaConfigType.Builder	kmsKeyID(String kmsKeyID)	The ARN of an KMS key.
LambdaConfigType.Builder	postAuthentication(String postAuthentication)	The configuration of a post authentication Lambda trigger in a user pool.
LambdaConfigType.Builder	postConfirmation(String postConfirmation)	The configuration of a post confirmation Lambda trigger in a user pool.
LambdaConfigType.Builder	preAuthentication(String preAuthentication)	The configuration of a pre authentication trigger in a user pool.
LambdaConfigType.Builder	preSignUp(String preSignUp)	The configuration of a pre sign-up Lambda trigger in a user pool.
LambdaConfigType.Builder	preTokenGeneration(String preTokenGeneration)	The legacy configuration of a pre token generation Lambda trigger in a user pool.
default LambdaConfigType.Builder	preTokenGenerationConfig(Consumer<PreTokenGenerationVersionConfigType.Builder> preTokenGenerationConfig)	The detailed configuration of a pre token generation Lambda trigger in a user pool.
LambdaConfigType.Builder	preTokenGenerationConfig(PreTokenGenerationVersionConfigType preTokenGenerationConfig)	The detailed configuration of a pre token generation Lambda trigger in a user pool.
LambdaConfigType.Builder	userMigration(String userMigration)	The configuration of a migrate user Lambda trigger in a user pool.
LambdaConfigType.Builder	verifyAuthChallengeResponse(String verifyAuthChallengeResponse)	The configuration of a verify auth challenge Lambda trigger, one of three triggers in the sequence of the custom authentication challenge triggers.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

preSignUp

LambdaConfigType.Builder preSignUp(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

customMessage

LambdaConfigType.Builder customMessage(String customMessage)

A custom message Lambda trigger. 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.

Parameters:

customMessage - A custom message Lambda trigger. 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

postConfirmation

LambdaConfigType.Builder postConfirmation(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

preAuthentication

LambdaConfigType.Builder preAuthentication(String preAuthentication)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

postAuthentication

LambdaConfigType.Builder postAuthentication(String postAuthentication)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

defineAuthChallenge

LambdaConfigType.Builder defineAuthChallenge(String defineAuthChallenge)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

createAuthChallenge

LambdaConfigType.Builder createAuthChallenge(String createAuthChallenge)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

verifyAuthChallengeResponse

LambdaConfigType.Builder verifyAuthChallengeResponse(String verifyAuthChallengeResponse)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

preTokenGeneration

LambdaConfigType.Builder preTokenGeneration(String preTokenGeneration)

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

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.

Parameters:

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

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

userMigration

LambdaConfigType.Builder userMigration(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

preTokenGenerationConfig

LambdaConfigType.Builder preTokenGenerationConfig(PreTokenGenerationVersionConfigType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

preTokenGenerationConfig

default LambdaConfigType.Builder preTokenGenerationConfig(Consumer<PreTokenGenerationVersionConfigType.Builder> 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.

This is a convenience method that creates an instance of the PreTokenGenerationVersionConfigType.Builder avoiding the need to create one manually via PreTokenGenerationVersionConfigType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to preTokenGenerationConfig(PreTokenGenerationVersionConfigType).

Parameters:

preTokenGenerationConfig - a consumer that will call methods on PreTokenGenerationVersionConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• preTokenGenerationConfig(PreTokenGenerationVersionConfigType)

customSMSSender

LambdaConfigType.Builder customSMSSender(CustomSMSLambdaVersionConfigType customSMSSender)

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

Parameters:

customSMSSender - The configuration of a custom SMS sender Lambda trigger. This trigger routes all SMS notifications from a user pool to a Lambda function that delivers the message using custom logic.

Returns:

Returns a reference to this object so that method calls can be chained together.

customSMSSender

default LambdaConfigType.Builder customSMSSender(Consumer<CustomSMSLambdaVersionConfigType.Builder> customSMSSender)

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

This is a convenience method that creates an instance of the CustomSMSLambdaVersionConfigType.Builder avoiding the need to create one manually via CustomSMSLambdaVersionConfigType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customSMSSender(CustomSMSLambdaVersionConfigType).

Parameters:

customSMSSender - a consumer that will call methods on CustomSMSLambdaVersionConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customSMSSender(CustomSMSLambdaVersionConfigType)

customEmailSender

LambdaConfigType.Builder customEmailSender(CustomEmailLambdaVersionConfigType customEmailSender)

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

Parameters:

customEmailSender - The configuration of a custom email sender Lambda trigger. This trigger routes all email notifications from a user pool to a Lambda function that delivers the message using custom logic.

Returns:

Returns a reference to this object so that method calls can be chained together.

customEmailSender

default LambdaConfigType.Builder customEmailSender(Consumer<CustomEmailLambdaVersionConfigType.Builder> customEmailSender)

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

This is a convenience method that creates an instance of the CustomEmailLambdaVersionConfigType.Builder avoiding the need to create one manually via CustomEmailLambdaVersionConfigType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to customEmailSender(CustomEmailLambdaVersionConfigType).

Parameters:

customEmailSender - a consumer that will call methods on CustomEmailLambdaVersionConfigType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• customEmailSender(CustomEmailLambdaVersionConfigType)

kmsKeyID

LambdaConfigType.Builder kmsKeyID(String kmsKeyID)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

inboundFederation

LambdaConfigType.Builder inboundFederation(InboundFederationLambdaType inboundFederation)

The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

Parameters:

inboundFederation - The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

Returns:

Returns a reference to this object so that method calls can be chained together.

inboundFederation

default LambdaConfigType.Builder inboundFederation(Consumer<InboundFederationLambdaType.Builder> inboundFederation)

The configuration of an inbound federation Lambda trigger. This trigger can transform federated user attributes during the authentication with external identity providers.

This is a convenience method that creates an instance of the InboundFederationLambdaType.Builder avoiding the need to create one manually via InboundFederationLambdaType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inboundFederation(InboundFederationLambdaType).

Parameters:

inboundFederation - a consumer that will call methods on InboundFederationLambdaType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• inboundFederation(InboundFederationLambdaType)