cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/SignUpRequest/Builder

Builder

class Builder

Properties

Link copied to clipboard
var analyticsMetadata: AnalyticsMetadataType?

The Amazon Pinpoint analytics metadata that contributes to your metrics for SignUp calls.

Link copied to clipboard
var clientId: String?

The ID of the client associated with the user pool.

Link copied to clipboard
var clientMetadata: Map<String, String>?

A map of custom key-value pairs that you can provide as input for any custom workflows that this action triggers.

Link copied to clipboard
var password: String?

The password of the user you want to register.

Link copied to clipboard
var secretHash: String?

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.

Link copied to clipboard
var userAttributes: List<AttributeType>?

An array of name-value pairs representing user attributes.

Link copied to clipboard
var userContextData: UserContextDataType?

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.

Link copied to clipboard
var username: String?

The username of the user that you want to sign up. The value of this parameter is typically a username, but can be any alias attribute in your user pool.

Link copied to clipboard
var validationData: List<AttributeType>?

Temporary user attributes that contribute to the outcomes of your pre sign-up Lambda trigger. This set of key-value pairs are for custom validation of information that you collect from your users but don't need to retain.