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.
This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.
Contents
- 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"
.Type: String
Valid Values:
String | Number | DateTime | Boolean
Required: No
- DeveloperOnlyAttribute
-
Note
You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using
DeveloperOnlyAttribute
.Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users won't be able to modify this attribute using their access token. For example,
DeveloperOnlyAttribute
can be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.Type: Boolean
Required: No
- Mutable
-
Specifies whether the value of the attribute can be changed.
Any user pool attribute whose value you map from an IdP attribute must be mutable, with a parameter value of
true
. Amazon Cognito updates mapped attributes when users sign in to your application through an IdP. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute. For more information, see Specifying Identity Provider Attribute Mappings for Your User Pool.Type: Boolean
Required: No
- Name
-
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 ofMyAttribute
, Amazon Cognito creates the custom attributecustom:MyAttribute
. WhenDeveloperOnlyAttribute
istrue
, Amazon Cognito creates your attribute asdev:MyAttribute
. In an operation that describes a user pool, Amazon Cognito returns this value asvalue
for standard attributes,custom:value
for custom attributes, anddev:value
for developer-only attributes..Type: String
Length Constraints: Minimum length of 1. Maximum length of 20.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+
Required: No
- NumberAttributeConstraints
-
Specifies the constraints for an attribute of the number type.
Type: NumberAttributeConstraintsType object
Required: No
- Required
-
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.
Type: Boolean
Required: No
- StringAttributeConstraints
-
Specifies the constraints for an attribute of the string type.
Type: StringAttributeConstraintsType object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: