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

Interface SignUpResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<SignUpResponse.Builder,SignUpResponse>, SdkBuilder<SignUpResponse.Builder,SignUpResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

SignUpResponse

public static interface SignUpResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<SignUpResponse.Builder,SignUpResponse>

Method Summary

Modifier and Type	Method	Description
default SignUpResponse.Builder	codeDeliveryDetails(Consumer<CodeDeliveryDetailsType.Builder> codeDeliveryDetails)	The code delivery details returned by the server response to the user registration request.
SignUpResponse.Builder	codeDeliveryDetails(CodeDeliveryDetailsType codeDeliveryDetails)	The code delivery details returned by the server response to the user registration request.
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.
SignUpResponse.Builder	userConfirmed(Boolean userConfirmed)	A response from the server indicating that a user registration has been confirmed.
SignUpResponse.Builder	userSub(String userSub)	The 128-bit ID of the authenticated user.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build, responseMetadata, responseMetadata

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, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

userConfirmed

SignUpResponse.Builder userConfirmed(Boolean userConfirmed)

A response from the server indicating that a user registration has been confirmed.

Parameters:

userConfirmed - A response from the server indicating that a user registration has been confirmed.

Returns:

Returns a reference to this object so that method calls can be chained together.

codeDeliveryDetails

SignUpResponse.Builder codeDeliveryDetails(CodeDeliveryDetailsType codeDeliveryDetails)

The code delivery details returned by the server response to the user registration request.

Parameters:

codeDeliveryDetails - The code delivery details returned by the server response to the user registration request.

Returns:

Returns a reference to this object so that method calls can be chained together.

codeDeliveryDetails

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

The code delivery details returned by the server response to the user registration request.

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:

codeDeliveryDetails(CodeDeliveryDetailsType)

userSub

SignUpResponse.Builder userSub(String userSub)

The 128-bit ID of the authenticated user. This isn't the same as username.

Parameters:

userSub - The 128-bit ID of the authenticated user. This isn't the same as username.

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.