Interface ConfirmForgotPasswordRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>
,SdkBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- ConfirmForgotPasswordRequest
public static interface ConfirmForgotPasswordRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<ConfirmForgotPasswordRequest.Builder,ConfirmForgotPasswordRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ConfirmForgotPasswordRequest.Builder
analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics forConfirmForgotPassword
calls.ConfirmForgotPasswordRequest.Builder
analyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics forConfirmForgotPassword
calls.ConfirmForgotPasswordRequest.Builder
clientId(String clientId)
The app client ID of the app associated with the user pool.ConfirmForgotPasswordRequest.Builder
clientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.ConfirmForgotPasswordRequest.Builder
confirmationCode(String confirmationCode)
The confirmation code from your user's request to reset their password.ConfirmForgotPasswordRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ConfirmForgotPasswordRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ConfirmForgotPasswordRequest.Builder
password(String password)
The new password that your user wants to set.ConfirmForgotPasswordRequest.Builder
secretHash(String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.default ConfirmForgotPasswordRequest.Builder
userContextData(Consumer<UserContextDataType.Builder> userContextData)
Contextual data about your user session, such as the device fingerprint, IP address, or location.ConfirmForgotPasswordRequest.Builder
userContextData(UserContextDataType userContextData)
Contextual data about your user session, such as the device fingerprint, IP address, or location.ConfirmForgotPasswordRequest.Builder
username(String username)
The username of the user that you want to query or modify.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest.Builder
build
-
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, sdkFields
-
-
-
-
Method Detail
-
clientId
ConfirmForgotPasswordRequest.Builder clientId(String clientId)
The app client ID of the app associated with the user pool.
- Parameters:
clientId
- The app client ID of the app associated with the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
secretHash
ConfirmForgotPasswordRequest.Builder secretHash(String secretHash)
A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information about
SecretHash
, see Computing secret hash values.- Parameters:
secretHash
- A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message. For more information aboutSecretHash
, see Computing secret hash values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
username
ConfirmForgotPasswordRequest.Builder username(String username)
The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If
username
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Parameters:
username
- The username of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. Ifusername
isn't an alias attribute in your user pool, this value must be thesub
of a local user or the username of a user from a third-party IdP.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
confirmationCode
ConfirmForgotPasswordRequest.Builder confirmationCode(String confirmationCode)
The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.
- Parameters:
confirmationCode
- The confirmation code from your user's request to reset their password. For more information, see ForgotPassword.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
password
ConfirmForgotPasswordRequest.Builder password(String password)
The new password that your user wants to set.
- Parameters:
password
- The new password that your user wants to set.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analyticsMetadata
ConfirmForgotPasswordRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
ConfirmForgotPassword
calls.- Parameters:
analyticsMetadata
- The Amazon Pinpoint analytics metadata for collecting metrics forConfirmForgotPassword
calls.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analyticsMetadata
default ConfirmForgotPasswordRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)
The Amazon Pinpoint analytics metadata for collecting metrics for
This is a convenience method that creates an instance of theConfirmForgotPassword
calls.AnalyticsMetadataType.Builder
avoiding the need to create one manually viaAnalyticsMetadataType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toanalyticsMetadata(AnalyticsMetadataType)
.- Parameters:
analyticsMetadata
- a consumer that will call methods onAnalyticsMetadataType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
analyticsMetadata(AnalyticsMetadataType)
-
userContextData
ConfirmForgotPasswordRequest.Builder userContextData(UserContextDataType userContextData)
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
- Parameters:
userContextData
- Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
userContextData
default ConfirmForgotPasswordRequest.Builder userContextData(Consumer<UserContextDataType.Builder> userContextData)
Contextual data about your user session, such as the device fingerprint, IP address, or location. Amazon Cognito advanced security evaluates the risk of an authentication event based on the context that your app generates and passes to Amazon Cognito when it makes API requests.
This is a convenience method that creates an instance of theUserContextDataType.Builder
avoiding the need to create one manually viaUserContextDataType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed touserContextData(UserContextDataType)
.- Parameters:
userContextData
- a consumer that will call methods onUserContextDataType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
userContextData(UserContextDataType)
-
clientMetadata
ConfirmForgotPasswordRequest.Builder clientMetadata(Map<String,String> clientMetadata)
A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.
You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
- Parameters:
clientMetadata
- A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.You create custom workflows by assigning Lambda functions to user pool triggers. When you use the ConfirmForgotPassword API action, Amazon Cognito invokes the function that is assigned to the post confirmation trigger. When Amazon Cognito invokes this function, it passes a JSON payload, which the function receives as input. This payload contains a
clientMetadata
attribute, which provides the data that you assigned to the ClientMetadata parameter in your ConfirmForgotPassword request. In your function code in Lambda, you can process theclientMetadata
value to enhance your workflow for your specific needs.For more information, see Customizing user pool Workflows with Lambda Triggers in the Amazon Cognito Developer Guide.
When you use the ClientMetadata parameter, remember that Amazon Cognito won't do the following:
-
Store the ClientMetadata value. This data is available only to Lambda triggers that are assigned to a user pool to support custom workflows. If your user pool configuration doesn't include triggers, the ClientMetadata parameter serves no purpose.
-
Validate the ClientMetadata value.
-
Encrypt the ClientMetadata value. Don't use Amazon Cognito to provide sensitive information.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
ConfirmForgotPasswordRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ConfirmForgotPasswordRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-