Interface ResendConfirmationCodeRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CognitoIdentityProviderRequest.Builder
,CopyableBuilder<ResendConfirmationCodeRequest.Builder,
,ResendConfirmationCodeRequest> SdkBuilder<ResendConfirmationCodeRequest.Builder,
,ResendConfirmationCodeRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
ResendConfirmationCodeRequest
-
Method Summary
Modifier and TypeMethodDescriptionanalyticsMetadata
(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics forResendConfirmationCode
calls.analyticsMetadata
(AnalyticsMetadataType analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics forResendConfirmationCode
calls.The ID of the client associated with the user pool.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.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.userContextData
(Consumer<UserContextDataType.Builder> userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.userContextData
(UserContextDataType userContextData) Contextual data about your user session, such as the device fingerprint, IP address, or location.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 Details
-
clientId
The ID of the client associated with the user pool.
- Parameters:
clientId
- The ID of the client associated with the user pool.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- 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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 ResendConfirmationCodeRequest.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:
-
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.
-
analyticsMetadata
The Amazon Pinpoint analytics metadata that contributes to your metrics for
ResendConfirmationCode
calls.- Parameters:
analyticsMetadata
- The Amazon Pinpoint analytics metadata that contributes to your metrics forResendConfirmationCode
calls.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
analyticsMetadata
default ResendConfirmationCodeRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata) The Amazon Pinpoint analytics metadata that contributes to your metrics for
This is a convenience method that creates an instance of theResendConfirmationCode
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:
-
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 ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message 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 ResendConfirmationCode 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 ResendConfirmationCode API action, Amazon Cognito invokes the function that is assigned to the custom message 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 ResendConfirmationCode 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
ResendConfirmationCodeRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
ResendConfirmationCodeRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-