Interface CfnUserPool.SchemaAttributeProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnUserPool.SchemaAttributeProperty.Jsii$Proxy
Enclosing class:
CfnUserPool

@Stability(Stable) public static interface CfnUserPool.SchemaAttributeProperty extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.cognito.*;
 SchemaAttributeProperty schemaAttributeProperty = SchemaAttributeProperty.builder()
         .attributeDataType("attributeDataType")
         .developerOnlyAttribute(false)
         .mutable(false)
         .name("name")
         .numberAttributeConstraints(NumberAttributeConstraintsProperty.builder()
                 .maxValue("maxValue")
                 .minValue("minValue")
                 .build())
         .required(false)
         .stringAttributeConstraints(StringAttributeConstraintsProperty.builder()
                 .maxLength("maxLength")
                 .minLength("minLength")
                 .build())
         .build();
 

See Also: