interface SchemaAttributeProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPool.SchemaAttributeProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_SchemaAttributeProperty`
Java	`software.amazon.awscdk.services.cognito.CfnUserPool.SchemaAttributeProperty`
Python	`aws_cdk.aws_cognito.CfnUserPool.SchemaAttributeProperty`
TypeScript	`aws-cdk-lib` » `aws_cognito` » `CfnUserPool` » `SchemaAttributeProperty`

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.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const schemaAttributeProperty: cognito.CfnUserPool.SchemaAttributeProperty = {
  attributeDataType: 'attributeDataType',
  developerOnlyAttribute: false,
  mutable: false,
  name: 'name',
  numberAttributeConstraints: {
    maxValue: 'maxValue',
    minValue: 'minValue',
  },
  required: false,
  stringAttributeConstraints: {
    maxLength: 'maxLength',
    minLength: 'minLength',
  },
};

Properties

Name	Type	Description
attributeDataType?	`string`	The data format of the values for your attribute.
developerOnlyAttribute?	`boolean \|` `IResolvable`	> You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using `DeveloperOnlyAttribute` .
mutable?	`boolean \|` `IResolvable`	Specifies whether the value of the attribute can be changed.
name?	`string`	The name of your user pool attribute.
numberAttributeConstraints?	`IResolvable` `\|` `NumberAttributeConstraintsProperty`	Specifies the constraints for an attribute of the number type.
required?	`boolean \|` `IResolvable`	Specifies whether a user pool attribute is required.
stringAttributeConstraints?	`IResolvable` `\|` `StringAttributeConstraintsProperty`	Specifies the constraints for an attribute of the string type.

attributeDataType?

Type: string (optional)

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" .

developerOnlyAttribute?

Type: boolean | IResolvable (optional)

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.

mutable?

Type: boolean | IResolvable (optional)

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 .

name?

Type: string (optional)

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..

numberAttributeConstraints?

Type: IResolvable | NumberAttributeConstraintsProperty (optional)

Specifies the constraints for an attribute of the number type.

required?

Type: boolean | IResolvable (optional)

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.

stringAttributeConstraints?

Type: IResolvable | StringAttributeConstraintsProperty (optional)

Specifies the constraints for an attribute of the string type.