Package software.amazon.awscdk.services.cognito

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
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 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();

  • Method Details

    • getAttributeDataType

      @Stability(Stable) @Nullable default String getAttributeDataType()
      The attribute data type.

    • getDeveloperOnlyAttribute

      @Stability(Stable) @Nullable default Object getDeveloperOnlyAttribute()

      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.

    • getMutable

      @Stability(Stable) @Nullable default Object getMutable()
      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 .

    • getName

      @Stability(Stable) @Nullable default String getName()
      A schema attribute of the name type.

    • getNumberAttributeConstraints

      @Stability(Stable) @Nullable default Object getNumberAttributeConstraints()
      Specifies the constraints for an attribute of the number type.

    • getRequired

      @Stability(Stable) @Nullable default Object getRequired()
      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.

    • getStringAttributeConstraints

      @Stability(Stable) @Nullable default Object getStringAttributeConstraints()
      Specifies the constraints for an attribute of the string type.

    • builder

      @Stability(Stable) static CfnUserPool.SchemaAttributeProperty.Builder builder()
      Returns:
      a CfnUserPool.SchemaAttributeProperty.Builder of CfnUserPool.SchemaAttributeProperty