SchemaAttributeType
Contains information about the schema attribute.
Contents
- AttributeDataType
-
The attribute data type.
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.
For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to
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
-
A schema attribute of the name type.
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 AWS SDKs, see the following: