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 |
password(String password)
The password of the user you wish to register.
|
SignUpRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
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 |
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.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, 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 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 requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.