AWS::Cognito::UserPool SchemaAttribute

Contains information about the schema attribute.

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: String
  DeveloperOnlyAttribute: Boolean
  Mutable: Boolean
  Name: String
  NumberAttributeConstraints: 
    NumberAttributeConstraints
  Required: Boolean
  StringAttributeConstraints: 
    StringAttributeConstraints

Properties

AttributeDataType

The attribute data type.

Required: No

Type: String

Allowed values: Boolean | DateTime | Number | String

Update requires: No interruption

DeveloperOnlyAttribute

Note

We recommend that you 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 will not be able to modify this attribute using their access token.

Required: No

Type: Boolean

Update requires: No interruption

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.

Required: No

Type: Boolean

Update requires: No interruption

Name

A schema attribute of the name type.

Required: No

Type: String

Minimum: 1

Maximum: 20

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Update 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