UserPoolSchema

data class UserPoolSchema(val attributeDataType: String, val developerOnlyAttribute: Boolean? = null, val mutable: Boolean? = null, val name: String, val numberAttributeConstraints: UserPoolSchemaNumberAttributeConstraints? = null, val required: Boolean? = null, val stringAttributeConstraints: UserPoolSchemaStringAttributeConstraints? = null)

Constructors

Link copied to clipboard
constructor(attributeDataType: String, developerOnlyAttribute: Boolean? = null, mutable: Boolean? = null, name: String, numberAttributeConstraints: UserPoolSchemaNumberAttributeConstraints? = null, required: Boolean? = null, stringAttributeConstraints: UserPoolSchemaStringAttributeConstraints? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Attribute data type. Must be one of Boolean, Number, String, DateTime.

Link copied to clipboard

Whether the attribute type is developer only.

Link copied to clipboard
val mutable: Boolean? = null

Whether the attribute can be changed once it has been created.

Link copied to clipboard

Name of the attribute.

Link copied to clipboard

Configuration block for the constraints for an attribute of the number type. Detailed below.

Link copied to clipboard
val required: Boolean? = null

Whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in will fail.

Link copied to clipboard

Constraints for an attribute of the string type. Detailed below.