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 attributes are a legacy feature of user pools, 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
Properties
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"
.
You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute
.
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..
Specifies the constraints for an attribute of the number type.
Specifies the constraints for an attribute of the string type.