cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/SchemaAttributeType/Builder

Builder

class Builder

Properties

Link copied to clipboard
var attributeDataType: AttributeDataType?

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

Link copied to clipboard
var developerOnlyAttribute: Boolean?

You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using DeveloperOnlyAttribute.

Link copied to clipboard
var mutable: Boolean?

Specifies whether the value of the attribute can be changed.

Link copied to clipboard
var name: String?

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

Link copied to clipboard
var numberAttributeConstraints: NumberAttributeConstraintsType?

Specifies the constraints for an attribute of the number type.

Link copied to clipboard
var required: Boolean?

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.

Link copied to clipboard
var stringAttributeConstraints: StringAttributeConstraintsType?

Specifies the constraints for an attribute of the string type.