UserPoolSchemaAttributeArgs

data class UserPoolSchemaAttributeArgs(val attributeDataType: Output<String>? = null, val developerOnlyAttribute: Output<Boolean>? = null, val mutable: Output<Boolean>? = null, val name: Output<String>? = null, val numberAttributeConstraints: Output<UserPoolNumberAttributeConstraintsArgs>? = null, val required: Output<Boolean>? = null, val stringAttributeConstraints: Output<UserPoolStringAttributeConstraintsArgs>? = null) : ConvertibleToJava<UserPoolSchemaAttributeArgs>

Constructors

Link copied to clipboard
constructor(attributeDataType: Output<String>? = null, developerOnlyAttribute: Output<Boolean>? = null, mutable: Output<Boolean>? = null, name: Output<String>? = null, numberAttributeConstraints: Output<UserPoolNumberAttributeConstraintsArgs>? = null, required: Output<Boolean>? = null, stringAttributeConstraints: Output<UserPoolStringAttributeConstraintsArgs>? = null)

Properties

Link copied to clipboard
val attributeDataType: Output<String>? = null

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
val developerOnlyAttribute: Output<Boolean>? = null
Link copied to clipboard
val mutable: Output<Boolean>? = null

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 .

Link copied to clipboard
val name: Output<String>? = null

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

Specifies the constraints for an attribute of the number type.

Link copied to clipboard
val required: Output<Boolean>? = null

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

Specifies the constraints for an attribute of the string type.

Functions

Link copied to clipboard
open override fun toJava(): UserPoolSchemaAttributeArgs