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

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.SchemaAttributeProperty.Builder	A builder for CfnUserPool.SchemaAttributeProperty
static final class	CfnUserPool.SchemaAttributeProperty.Jsii$Proxy	An implementation for CfnUserPool.SchemaAttributeProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.SchemaAttributeProperty.Builder	builder()
default String	getAttributeDataType()	The data format of the values for your attribute.
default Object	getDeveloperOnlyAttribute()
default Object	getMutable()	Specifies whether the value of the attribute can be changed.
default String	getName()	The name of your user pool attribute.
default Object	getNumberAttributeConstraints()	Specifies the constraints for an attribute of the number type.
default Object	getRequired()	Specifies whether a user pool attribute is required.
default Object	getStringAttributeConstraints()	Specifies the constraints for an attribute of the string type.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeDataType

@Stability(Stable)
@Nullable
default String getAttributeDataType()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype

getDeveloperOnlyAttribute

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

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute

getMutable

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

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable

getName

@Stability(Stable)
@Nullable
default String getName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name

getNumberAttributeConstraints

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

Specifies the constraints for an attribute of the number type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required

getStringAttributeConstraints

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

Specifies the constraints for an attribute of the string type.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints

builder

@Stability(Stable)
static CfnUserPool.SchemaAttributeProperty.Builder builder()

Returns:

a CfnUserPool.SchemaAttributeProperty.Builder of CfnUserPool.SchemaAttributeProperty