interface SchemaAttributeProperty

This page is available in another version. Click here for the v2 documentation.

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPool.SchemaAttributeProperty`
Java	`software.amazon.awscdk.services.cognito.CfnUserPool.SchemaAttributeProperty`
Python	`aws_cdk.aws_cognito.CfnUserPool.SchemaAttributeProperty`
TypeScript	`@aws-cdk/aws-cognito` » `CfnUserPool` » `SchemaAttributeProperty`

Contains information about the schema attribute.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
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 attribute data type.
developerOnlyAttribute?	`boolean \|` `IResolvable`	> 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` .
mutable?	`boolean \|` `IResolvable`	Specifies whether the value of the attribute can be changed.
name?	`string`	A schema attribute of the name type.
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 attribute data type.

developerOnlyAttribute?

Type: boolean | IResolvable (optional)

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.

mutable?

Type: boolean | IResolvable (optional)

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 .

name?

Type: string (optional)

A schema attribute of the name type.

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.