Class CfnUserPoolPropsMixin.LambdaConfigProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin.LambdaConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolPropsMixin.LambdaConfigProperty>
- Enclosing interface:
CfnUserPoolPropsMixin.LambdaConfigProperty
@Stability(Stable)
public static final class CfnUserPoolPropsMixin.LambdaConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolPropsMixin.LambdaConfigProperty>
A builder for
CfnUserPoolPropsMixin.LambdaConfigProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.createAuthChallenge(String createAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCreateAuthChallenge()createAuthChallenge(IFunctionRef createAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCreateAuthChallenge()customEmailSender(CfnUserPoolPropsMixin.CustomEmailSenderProperty customEmailSender) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCustomEmailSender()customEmailSender(IResolvable customEmailSender) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCustomEmailSender()customMessage(String customMessage) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCustomMessage()customMessage(IFunctionRef customMessage) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCustomMessage()customSmsSender(CfnUserPoolPropsMixin.CustomSMSSenderProperty customSmsSender) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCustomSmsSender()customSmsSender(IResolvable customSmsSender) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getCustomSmsSender()defineAuthChallenge(String defineAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getDefineAuthChallenge()defineAuthChallenge(IFunctionRef defineAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getDefineAuthChallenge()inboundFederation(CfnUserPoolPropsMixin.InboundFederationProperty inboundFederation) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getInboundFederation()inboundFederation(IResolvable inboundFederation) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getInboundFederation()Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getKmsKeyId()Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getKmsKeyId()postAuthentication(String postAuthentication) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPostAuthentication()postAuthentication(IFunctionRef postAuthentication) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPostAuthentication()postConfirmation(String postConfirmation) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPostConfirmation()postConfirmation(IFunctionRef postConfirmation) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPostConfirmation()preAuthentication(String preAuthentication) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreAuthentication()preAuthentication(IFunctionRef preAuthentication) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreAuthentication()Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreSignUp()preSignUp(IFunctionRef preSignUp) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreSignUp()preTokenGeneration(String preTokenGeneration) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreTokenGeneration()preTokenGeneration(IFunctionRef preTokenGeneration) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreTokenGeneration()preTokenGenerationConfig(CfnUserPoolPropsMixin.PreTokenGenerationConfigProperty preTokenGenerationConfig) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreTokenGenerationConfig()preTokenGenerationConfig(IResolvable preTokenGenerationConfig) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getPreTokenGenerationConfig()userMigration(String userMigration) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getUserMigration()verifyAuthChallengeResponse(String verifyAuthChallengeResponse) verifyAuthChallengeResponse(IFunctionRef verifyAuthChallengeResponse)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
createAuthChallenge
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder createAuthChallenge(String createAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.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
-
createAuthChallenge
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder createAuthChallenge(IFunctionRef createAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder customEmailSender(IResolvable customEmailSender) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder customEmailSender(CfnUserPoolPropsMixin.CustomEmailSenderProperty customEmailSender) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder customMessage(String customMessage) Sets the value ofCfnUserPoolPropsMixin.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
-
customMessage
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder customMessage(IFunctionRef customMessage) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder customSmsSender(IResolvable customSmsSender) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder customSmsSender(CfnUserPoolPropsMixin.CustomSMSSenderProperty customSmsSender) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder defineAuthChallenge(String defineAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.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
-
defineAuthChallenge
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder defineAuthChallenge(IFunctionRef defineAuthChallenge) Sets the value ofCfnUserPoolPropsMixin.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
-
inboundFederation
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder inboundFederation(IResolvable inboundFederation) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getInboundFederation()- Parameters:
inboundFederation- the value to be set.- Returns:
this
-
inboundFederation
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder inboundFederation(CfnUserPoolPropsMixin.InboundFederationProperty inboundFederation) Sets the value ofCfnUserPoolPropsMixin.LambdaConfigProperty.getInboundFederation()- Parameters:
inboundFederation- the value to be set.- Returns:
this
-
kmsKeyId
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder kmsKeyId(String kmsKeyId) Sets the value ofCfnUserPoolPropsMixin.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
-
kmsKeyId
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder kmsKeyId(IKeyRef kmsKeyId) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder postAuthentication(String postAuthentication) Sets the value ofCfnUserPoolPropsMixin.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
-
postAuthentication
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder postAuthentication(IFunctionRef postAuthentication) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder postConfirmation(String postConfirmation) Sets the value ofCfnUserPoolPropsMixin.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
-
postConfirmation
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder postConfirmation(IFunctionRef postConfirmation) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preAuthentication(String preAuthentication) Sets the value ofCfnUserPoolPropsMixin.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
-
preAuthentication
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preAuthentication(IFunctionRef preAuthentication) Sets the value ofCfnUserPoolPropsMixin.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
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preSignUp(String preSignUp) Sets the value ofCfnUserPoolPropsMixin.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
-
preSignUp
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preSignUp(IFunctionRef preSignUp) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preTokenGeneration(String preTokenGeneration) Sets the value ofCfnUserPoolPropsMixin.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 theLambdaArnofPreTokenGenerationConfig.- Returns:
this
-
preTokenGeneration
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preTokenGeneration(IFunctionRef preTokenGeneration) Sets the value ofCfnUserPoolPropsMixin.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 theLambdaArnofPreTokenGenerationConfig.- Returns:
this
-
preTokenGenerationConfig
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preTokenGenerationConfig(IResolvable preTokenGenerationConfig) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder preTokenGenerationConfig(CfnUserPoolPropsMixin.PreTokenGenerationConfigProperty preTokenGenerationConfig) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder userMigration(String userMigration) Sets the value ofCfnUserPoolPropsMixin.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 CfnUserPoolPropsMixin.LambdaConfigProperty.Builder verifyAuthChallengeResponse(String verifyAuthChallengeResponse) - 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
-
verifyAuthChallengeResponse
@Stability(Stable) public CfnUserPoolPropsMixin.LambdaConfigProperty.Builder verifyAuthChallengeResponse(IFunctionRef verifyAuthChallengeResponse) - 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:
buildin interfacesoftware.amazon.jsii.Builder<CfnUserPoolPropsMixin.LambdaConfigProperty>- Returns:
- a new instance of
CfnUserPoolPropsMixin.LambdaConfigProperty - Throws:
NullPointerException- if any required attribute was not provided
-