Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon Cognito UserPool SchemaAttribute

SchemaAttribute is a property of the AWS::Cognito::UserPool resource that defines the schema attributes of an Amazon Cognito User Pool.

Syntax

JSON

Copy
{ "AttributeDataType" : String, "DeveloperOnlyAttribute" : Boolean, "Mutable" : Boolean, "Name" : String, "NumberAttributeConstraints" : NumberAttributeConstraintsType, "StringAttributeConstraints" : StringAttributeConstraintsType, "Required" : Boolean }

YAML

Copy
{ AttributeDataType: String DeveloperOnlyAttribute: Boolean Mutable: Boolean Name: String NumberAttributeConstraints: NumberAttributeConstraints StringAttributeConstraints: StringAttributeConstraints Required: Boolean }

Properties

AttributeDataType

The attribute data type. Can be one of the following: String, Number, DateTime, or Boolean.

Type: String

Required: No

DeveloperOnlyAttribute

Specifies whether the attribute type is developer only.

Type: Boolean

Required: No

Mutable

Specifies whether the attribute can be changed after it has been created. True means mutable and False means immutable.

Type: Boolean

Required: No

Name

A schema attribute of the name type.

Type: String

Required: No

NumberAttributeConstraints

Specifies the constraints for an attribute of the number type.

Type: Amazon Cognito UserPool NumberAttributeConstraints

Required: No

StringAttributeConstraints

Specifies the constraints for an attribute of the string type.

Type: Amazon Cognito UserPool StringAttributeConstraints

Required: No

Required

Specifies whether a user pool attribute is required. If the attribute is required and the user does not provide a value, registration or sign-in fails.

Type: Boolean

Required: No

On this page: