public static interface SignUpRequest.Builder extends CognitoIdentityProviderRequest.Builder, CopyableBuilder<SignUpRequest.Builder,SignUpRequest>
Modifier and Type | Method and Description |
---|---|
SignUpRequest.Builder |
clientId(String clientId)
The ID of the client associated with the user pool.
|
SignUpRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
SignUpRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
SignUpRequest.Builder |
password(String password)
The password of the user you wish to register.
|
SignUpRequest.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.
|
SignUpRequest.Builder |
userAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest.Builder |
userAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest.Builder |
userAttributes(Consumer<AttributeType.Builder>... userAttributes)
An array of name-value pairs representing user attributes.
|
SignUpRequest.Builder |
username(String username)
The user name of the user you wish to register.
|
SignUpRequest.Builder |
validationData(AttributeType... validationData)
The validation data in the request to register a user.
|
SignUpRequest.Builder |
validationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
|
SignUpRequest.Builder |
validationData(Consumer<AttributeType.Builder>... validationData)
The validation data in the request to register a user.
|
build
overrideConfiguration
copy
applyMutation, build
SignUpRequest.Builder clientId(String clientId)
The ID of the client associated with the user pool.
clientId
- The ID of the client associated with the user pool.SignUpRequest.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.
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.SignUpRequest.Builder username(String username)
The user name of the user you wish to register.
username
- The user name of the user you wish to register.SignUpRequest.Builder password(String password)
The password of the user you wish to register.
password
- The password of the user you wish to register.SignUpRequest.Builder userAttributes(Collection<AttributeType> userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
userAttributes
- An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
SignUpRequest.Builder userAttributes(AttributeType... userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
userAttributes
- An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
SignUpRequest.Builder userAttributes(Consumer<AttributeType.Builder>... userAttributes)
An array of name-value pairs representing user attributes.
For custom attributes, you must prepend the custom:
prefix to the attribute name.
List.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #userAttributes(List)
.userAttributes
- a consumer that will call methods on List.Builder
#userAttributes(List)
SignUpRequest.Builder validationData(Collection<AttributeType> validationData)
The validation data in the request to register a user.
validationData
- The validation data in the request to register a user.SignUpRequest.Builder validationData(AttributeType... validationData)
The validation data in the request to register a user.
validationData
- The validation data in the request to register a user.SignUpRequest.Builder validationData(Consumer<AttributeType.Builder>... validationData)
The validation data in the request to register a user.
This is a convenience that creates an instance of theList.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #validationData(List)
.validationData
- a consumer that will call methods on List.Builder
#validationData(List)
SignUpRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.SignUpRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.