cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/SchemaAttributeType

SchemaAttributeType

A list of the user attributes and their properties in your user pool. The attribute schema contains standard attributes, custom attributes with a custom: prefix, and developer attributes with a dev: prefix. For more information, see User pool attributes.

Developer-only dev: attributes are a legacy feature of user pools, and are read-only to all app clients. You can create and update developer-only attributes only with IAM-authenticated API operations. Use app client read/write permissions instead.

Types

Builder

class Builder

Companion

object Companion

Properties

attributeDataType

val attributeDataType: AttributeDataType?

The data format of the values for your attribute. When you choose an AttributeDataType, Amazon Cognito validates the input against the data type. A custom attribute value in your user's ID token is always a string, for example "custom:isMember" : "true" or "custom:YearsAsMember" : "12".

developerOnlyAttribute

val developerOnlyAttribute: Boolean?

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

mutable

val mutable: Boolean?

Specifies whether the value of the attribute can be changed.

name

val name: String?

The name of your user pool attribute. When you create or update a user pool, adding a schema attribute creates a custom or developer-only attribute. When you add an attribute with a Name value of MyAttribute, Amazon Cognito creates the custom attribute custom:MyAttribute. When DeveloperOnlyAttribute is true, Amazon Cognito creates your attribute as dev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value as value for standard attributes, custom:value for custom attributes, and dev:value for developer-only attributes..

numberAttributeConstraints

val numberAttributeConstraints: NumberAttributeConstraintsType?

Specifies the constraints for an attribute of the number type.

required

val required: Boolean?

Specifies whether a user pool attribute is required. If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

stringAttributeConstraints

val stringAttributeConstraints: StringAttributeConstraintsType?

Specifies the constraints for an attribute of the string type.

Functions

copy

inline fun copy(block: SchemaAttributeType.Builder.() -> Unit = {}): SchemaAttributeType

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String