Interface SignUpResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<SignUpResponse.Builder,SignUpResponse>, SdkBuilder<SignUpResponse.Builder,SignUpResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
SignUpResponse
@Mutable @NotThreadSafe public static interface SignUpResponse.Builder extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<SignUpResponse.Builder,SignUpResponse>

  • Method Details

    • userConfirmed

      SignUpResponse.Builder userConfirmed(Boolean userConfirmed)

      Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.

      Parameters:
      userConfirmed - Indicates whether the user was automatically confirmed. You can auto-confirm users with a pre sign-up Lambda trigger.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeDeliveryDetails

      SignUpResponse.Builder codeDeliveryDetails(CodeDeliveryDetailsType codeDeliveryDetails)

      In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

      Parameters:
      codeDeliveryDetails - In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeDeliveryDetails

      default SignUpResponse.Builder codeDeliveryDetails(Consumer<CodeDeliveryDetailsType.Builder> codeDeliveryDetails)

      In user pools that automatically verify and confirm new users, Amazon Cognito sends users a message with a code or link that confirms ownership of the phone number or email address that they entered. The CodeDeliveryDetails object is information about the delivery destination for that link or code.

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

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

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

    • userSub

      SignUpResponse.Builder userSub(String userSub)

      The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.

      Parameters:
      userSub - The unique identifier of the new user, for example a1b2c3d4-5678-90ab-cdef-EXAMPLE11111.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • session

      SignUpResponse.Builder session(String session)

      A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.

      Parameters:
      session - A session Id that you can pass to ConfirmSignUp when you want to immediately sign in your user with the USER_AUTH flow after they complete sign-up.
      Returns:
      Returns a reference to this object so that method calls can be chained together.