User Pool Schema Attribute Args
Constructors
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"
.
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 .
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.