Class CfnUserPool.LambdaConfigProperty.Builder
java.lang.Object
software.amazon.awscdk.services.cognito.CfnUserPool.LambdaConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPool.LambdaConfigProperty>
- Enclosing interface:
CfnUserPool.LambdaConfigProperty
@Stability(Stable)
public static final class CfnUserPool.LambdaConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPool.LambdaConfigProperty>
A builder for
CfnUserPool.LambdaConfigProperty
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
Builds the configured instance.createAuthChallenge
(String createAuthChallenge) Sets the value ofCfnUserPool.LambdaConfigProperty.getCreateAuthChallenge()
customEmailSender
(IResolvable customEmailSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomEmailSender()
customEmailSender
(CfnUserPool.CustomEmailSenderProperty customEmailSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomEmailSender()
customMessage
(String customMessage) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomMessage()
customSmsSender
(IResolvable customSmsSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomSmsSender()
customSmsSender
(CfnUserPool.CustomSMSSenderProperty customSmsSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomSmsSender()
defineAuthChallenge
(String defineAuthChallenge) Sets the value ofCfnUserPool.LambdaConfigProperty.getDefineAuthChallenge()
Sets the value ofCfnUserPool.LambdaConfigProperty.getKmsKeyId()
postAuthentication
(String postAuthentication) Sets the value ofCfnUserPool.LambdaConfigProperty.getPostAuthentication()
postConfirmation
(String postConfirmation) Sets the value ofCfnUserPool.LambdaConfigProperty.getPostConfirmation()
preAuthentication
(String preAuthentication) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreAuthentication()
Sets the value ofCfnUserPool.LambdaConfigProperty.getPreSignUp()
preTokenGeneration
(String preTokenGeneration) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreTokenGeneration()
preTokenGenerationConfig
(IResolvable preTokenGenerationConfig) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreTokenGenerationConfig()
preTokenGenerationConfig
(CfnUserPool.PreTokenGenerationConfigProperty preTokenGenerationConfig) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreTokenGenerationConfig()
userMigration
(String userMigration) Sets the value ofCfnUserPool.LambdaConfigProperty.getUserMigration()
verifyAuthChallengeResponse
(String verifyAuthChallengeResponse) Sets the value ofCfnUserPool.LambdaConfigProperty.getVerifyAuthChallengeResponse()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
createAuthChallenge
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder createAuthChallenge(String createAuthChallenge) Sets the value ofCfnUserPool.LambdaConfigProperty.getCreateAuthChallenge()
- 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:
this
-
customEmailSender
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder customEmailSender(IResolvable customEmailSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomEmailSender()
- 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:
this
-
customEmailSender
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder customEmailSender(CfnUserPool.CustomEmailSenderProperty customEmailSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomEmailSender()
- 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:
this
-
customMessage
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder customMessage(String customMessage) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomMessage()
- 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:
this
-
customSmsSender
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder customSmsSender(IResolvable customSmsSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomSmsSender()
- 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:
this
-
customSmsSender
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder customSmsSender(CfnUserPool.CustomSMSSenderProperty customSmsSender) Sets the value ofCfnUserPool.LambdaConfigProperty.getCustomSmsSender()
- 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:
this
-
defineAuthChallenge
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder defineAuthChallenge(String defineAuthChallenge) Sets the value ofCfnUserPool.LambdaConfigProperty.getDefineAuthChallenge()
- 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:
this
-
kmsKeyId
Sets the value ofCfnUserPool.LambdaConfigProperty.getKmsKeyId()
- 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:
this
-
postAuthentication
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder postAuthentication(String postAuthentication) Sets the value ofCfnUserPool.LambdaConfigProperty.getPostAuthentication()
- 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:
this
-
postConfirmation
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder postConfirmation(String postConfirmation) Sets the value ofCfnUserPool.LambdaConfigProperty.getPostConfirmation()
- 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:
this
-
preAuthentication
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder preAuthentication(String preAuthentication) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreAuthentication()
- Parameters:
preAuthentication
- The configuration of a pre authentication trigger in a user pool. This trigger can evaluate and modify user sign-in events.- Returns:
this
-
preSignUp
Sets the value ofCfnUserPool.LambdaConfigProperty.getPreSignUp()
- 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:
this
-
preTokenGeneration
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder preTokenGeneration(String preTokenGeneration) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreTokenGeneration()
- 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 inPreTokenGenerationConfig
, its value must be identical toPreTokenGeneration
. For new instances of pre token generation triggers, set theLambdaArn
ofPreTokenGenerationConfig
.- Returns:
this
-
preTokenGenerationConfig
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder preTokenGenerationConfig(IResolvable preTokenGenerationConfig) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreTokenGenerationConfig()
- Parameters:
preTokenGenerationConfig
- The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN inPreTokenGeneration
, its value must be identical toPreTokenGenerationConfig
.- Returns:
this
-
preTokenGenerationConfig
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder preTokenGenerationConfig(CfnUserPool.PreTokenGenerationConfigProperty preTokenGenerationConfig) Sets the value ofCfnUserPool.LambdaConfigProperty.getPreTokenGenerationConfig()
- Parameters:
preTokenGenerationConfig
- The detailed configuration of a pre token generation Lambda trigger in a user pool. If you also set an ARN inPreTokenGeneration
, its value must be identical toPreTokenGenerationConfig
.- Returns:
this
-
userMigration
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder userMigration(String userMigration) Sets the value ofCfnUserPool.LambdaConfigProperty.getUserMigration()
- 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:
this
-
verifyAuthChallengeResponse
@Stability(Stable) public CfnUserPool.LambdaConfigProperty.Builder verifyAuthChallengeResponse(String verifyAuthChallengeResponse) Sets the value ofCfnUserPool.LambdaConfigProperty.getVerifyAuthChallengeResponse()
- 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:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUserPool.LambdaConfigProperty>
- Returns:
- a new instance of
CfnUserPool.LambdaConfigProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-