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

Interface ConfirmSignUpRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>, SdkBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ConfirmSignUpRequest
public static interface ConfirmSignUpRequest.Builder extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<ConfirmSignUpRequest.Builder,ConfirmSignUpRequest>

  • Method Details

    • clientId

      ConfirmSignUpRequest.Builder clientId(String clientId)

      The ID of the app client associated with the user pool.

      Parameters:
      clientId - The ID of the app client associated with the user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • secretHash

      ConfirmSignUpRequest.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.

      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.

    • username

      ConfirmSignUpRequest.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 the sub 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. If username isn't an alias attribute in your user pool, this value must be the sub 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

      ConfirmSignUpRequest.Builder confirmationCode(String confirmationCode)

      The confirmation code sent by a user's request to confirm registration.

      Parameters:
      confirmationCode - The confirmation code sent by a user's request to confirm registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forceAliasCreation

      ConfirmSignUpRequest.Builder forceAliasCreation(Boolean forceAliasCreation)

      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

      Parameters:
      forceAliasCreation - Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analyticsMetadata

      ConfirmSignUpRequest.Builder analyticsMetadata(AnalyticsMetadataType analyticsMetadata)

      The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

      Parameters:
      analyticsMetadata - The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • analyticsMetadata

      default ConfirmSignUpRequest.Builder analyticsMetadata(Consumer<AnalyticsMetadataType.Builder> analyticsMetadata)

      The Amazon Pinpoint analytics metadata for collecting metrics for ConfirmSignUp calls.

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

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

      Parameters:
      analyticsMetadata - a consumer that will call methods on AnalyticsMetadataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • userContextData

      ConfirmSignUpRequest.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 ConfirmSignUpRequest.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 the UserContextDataType.Builder avoiding the need to create one manually via UserContextDataType.builder().

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

      Parameters:
      userContextData - a consumer that will call methods on UserContextDataType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientMetadata

      ConfirmSignUpRequest.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 ConfirmSignUp 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 ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata 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 ConfirmSignUp 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 ConfirmSignUp request. In your function code in Lambda, you can process the clientMetadata 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

      ConfirmSignUpRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ConfirmSignUpRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.