This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Cognito::UserPool SchemaAttribute
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.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "AttributeDataType" :String, "DeveloperOnlyAttribute" :Boolean, "Mutable" :Boolean, "Name" :String, "NumberAttributeConstraints" :NumberAttributeConstraints, "Required" :Boolean, "StringAttributeConstraints" :StringAttributeConstraints}
YAML
AttributeDataType:StringDeveloperOnlyAttribute:BooleanMutable:BooleanName:StringNumberAttributeConstraints:NumberAttributeConstraintsRequired:BooleanStringAttributeConstraints:StringAttributeConstraints
Properties
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".Required: No
Type: String
Allowed values:
String | Number | DateTime | BooleanUpdate requires: No interruption
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,
DeveloperOnlyAttributecan be modified using AdminUpdateUserAttributes but can't be updated using UpdateUserAttributes.Required: No
Type: Boolean
Update requires: No interruption
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.Required: No
Type: Boolean
Update requires: No interruption
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
Namevalue ofMyAttribute, Amazon Cognito creates the custom attributecustom:MyAttribute. WhenDeveloperOnlyAttributeistrue, Amazon Cognito creates your attribute asdev:MyAttribute. In an operation that describes a user pool, Amazon Cognito returns this value asvaluefor standard attributes,custom:valuefor custom attributes, anddev:valuefor developer-only attributes..Required: No
Type: String
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}]+Minimum:
1Maximum:
20Update requires: No interruption
NumberAttributeConstraints-
Specifies the constraints for an attribute of the number type.
Required: No
Type: NumberAttributeConstraints
Update requires: No interruption
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.
Required: No
Type: Boolean
Update requires: No interruption
StringAttributeConstraints-
Specifies the constraints for an attribute of the string type.
Required: No
Type: StringAttributeConstraints
Update requires: No interruption
