Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SchemaAttributeType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.SchemaAttributeType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SchemaAttributeType.Builder,SchemaAttributeType>

@Generated("software.amazon.awssdk:codegen")
public final class SchemaAttributeType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SchemaAttributeType.Builder,SchemaAttributeType>

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SchemaAttributeType.Builder

Method Summary

Modifier and Type	Method	Description
AttributeDataType	attributeDataType()	The data format of the values for your attribute.
String	attributeDataTypeAsString()	The data format of the values for your attribute.
static SchemaAttributeType.Builder	builder()
Boolean	developerOnlyAttribute()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	mutable()	Specifies whether the value of the attribute can be changed.
String	name()	The name of your user pool attribute.
NumberAttributeConstraintsType	numberAttributeConstraints()	Specifies the constraints for an attribute of the number type.
Boolean	required()	Specifies whether a user pool attribute is required.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SchemaAttributeType.Builder>	serializableBuilderClass()
StringAttributeConstraintsType	stringAttributeConstraints()	Specifies the constraints for an attribute of the string type.
SchemaAttributeType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

name

public final String name()

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

Returns:

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

attributeDataType

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

If the service returns an enum value that is not available in the current SDK version, attributeDataType will return AttributeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeDataTypeAsString().

Returns:

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:

AttributeDataType

attributeDataTypeAsString

public final String attributeDataTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, attributeDataType will return AttributeDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from attributeDataTypeAsString().

Returns:

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:

AttributeDataType

developerOnlyAttribute

public final Boolean developerOnlyAttribute()

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.

Returns:

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.

mutable

public final Boolean mutable()

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.

Returns:

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.

required

public final Boolean required()

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.

Returns:

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.

numberAttributeConstraints

public final NumberAttributeConstraintsType numberAttributeConstraints()

Specifies the constraints for an attribute of the number type.

Returns:

Specifies the constraints for an attribute of the number type.

stringAttributeConstraints

public final StringAttributeConstraintsType stringAttributeConstraints()

Specifies the constraints for an attribute of the string type.

Returns:

Specifies the constraints for an attribute of the string type.

toBuilder

public SchemaAttributeType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SchemaAttributeType.Builder,SchemaAttributeType>

builder

public static SchemaAttributeType.Builder builder()

serializableBuilderClass

public static Class<? extends SchemaAttributeType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo