com.amazonaws.services.cognitoidentityprovider.model

Class SchemaAttributeType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.SchemaAttributeType

All Implemented Interfaces:

java.io.Serializable

public class SchemaAttributeType
extends java.lang.Object
implements java.io.Serializable

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 attributes are a legacy feature of user pools, 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.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaAttributeType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAttributeDataType() The data format of the values for your attribute.
java.lang.Boolean	getDeveloperOnlyAttribute()
java.lang.Boolean	getMutable() Specifies whether the value of the attribute can be changed.
java.lang.String	getName() The name of your user pool attribute, for example username or custom:costcenter.
NumberAttributeConstraintsType	getNumberAttributeConstraints() Specifies the constraints for an attribute of the number type.
java.lang.Boolean	getRequired() Specifies whether a user pool attribute is required.
StringAttributeConstraintsType	getStringAttributeConstraints() Specifies the constraints for an attribute of the string type.
int	hashCode()
java.lang.Boolean	isDeveloperOnlyAttribute()
java.lang.Boolean	isMutable() Specifies whether the value of the attribute can be changed.
java.lang.Boolean	isRequired() Specifies whether a user pool attribute is required.
void	setAttributeDataType(AttributeDataType attributeDataType) The data format of the values for your attribute.
void	setAttributeDataType(java.lang.String attributeDataType) The data format of the values for your attribute.
void	setDeveloperOnlyAttribute(java.lang.Boolean developerOnlyAttribute)
void	setMutable(java.lang.Boolean mutable) Specifies whether the value of the attribute can be changed.
void	setName(java.lang.String name) The name of your user pool attribute, for example username or custom:costcenter.
void	setNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
void	setRequired(java.lang.Boolean required) Specifies whether a user pool attribute is required.
void	setStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints) Specifies the constraints for an attribute of the string type.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SchemaAttributeType	withAttributeDataType(AttributeDataType attributeDataType) The data format of the values for your attribute.
SchemaAttributeType	withAttributeDataType(java.lang.String attributeDataType) The data format of the values for your attribute.
SchemaAttributeType	withDeveloperOnlyAttribute(java.lang.Boolean developerOnlyAttribute)
SchemaAttributeType	withMutable(java.lang.Boolean mutable) Specifies whether the value of the attribute can be changed.
SchemaAttributeType	withName(java.lang.String name) The name of your user pool attribute, for example username or custom:costcenter.
SchemaAttributeType	withNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
SchemaAttributeType	withRequired(java.lang.Boolean required) Specifies whether a user pool attribute is required.
SchemaAttributeType	withStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints) Specifies the constraints for an attribute of the string type.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaAttributeType

public SchemaAttributeType()

Method Detail

getName

public java.lang.String getName()

The name of your user pool attribute, for example username or custom:costcenter.

Constraints:
Length: 1 - 20
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The name of your user pool attribute, for example username or custom:costcenter.

setName

public void setName(java.lang.String name)

The name of your user pool attribute, for example username or custom:costcenter.

Constraints:
Length: 1 - 20
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

name -

The name of your user pool attribute, for example username or custom:costcenter.

withName

public SchemaAttributeType withName(java.lang.String name)

The name of your user pool attribute, for example username or custom:costcenter.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 20
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

name -

The name of your user pool attribute, for example username or custom:costcenter.

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributeDataType

public java.lang.String getAttributeDataType()

The data format of the values for your attribute.

Constraints:
Allowed Values: String, Number, DateTime, Boolean

Returns:

The data format of the values for your attribute.

See Also:

AttributeDataType

setAttributeDataType

public void setAttributeDataType(java.lang.String attributeDataType)

The data format of the values for your attribute.

Constraints:
Allowed Values: String, Number, DateTime, Boolean

Parameters:

attributeDataType -

The data format of the values for your attribute.

See Also:

AttributeDataType

withAttributeDataType

public SchemaAttributeType withAttributeDataType(java.lang.String attributeDataType)

The data format of the values for your attribute.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: String, Number, DateTime, Boolean

Parameters:

attributeDataType -

The data format of the values for your attribute.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AttributeDataType

setAttributeDataType

public void setAttributeDataType(AttributeDataType attributeDataType)

The data format of the values for your attribute.

Constraints:
Allowed Values: String, Number, DateTime, Boolean

Parameters:

attributeDataType -

The data format of the values for your attribute.

See Also:

AttributeDataType

withAttributeDataType

public SchemaAttributeType withAttributeDataType(AttributeDataType attributeDataType)

The data format of the values for your attribute.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Allowed Values: String, Number, DateTime, Boolean

Parameters:

attributeDataType -

The data format of the values for your attribute.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

AttributeDataType

isDeveloperOnlyAttribute

public java.lang.Boolean isDeveloperOnlyAttribute()

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.

getDeveloperOnlyAttribute

public java.lang.Boolean 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.

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.

setDeveloperOnlyAttribute

public void setDeveloperOnlyAttribute(java.lang.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.

Parameters:

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.

withDeveloperOnlyAttribute

public SchemaAttributeType withDeveloperOnlyAttribute(java.lang.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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isMutable

public java.lang.Boolean isMutable()

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.

getMutable

public java.lang.Boolean 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.

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.

setMutable

public void setMutable(java.lang.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.

Parameters:

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.

withMutable

public SchemaAttributeType withMutable(java.lang.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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

isRequired

public java.lang.Boolean isRequired()

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.

getRequired

public java.lang.Boolean 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.

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.

setRequired

public void setRequired(java.lang.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.

Parameters:

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.

withRequired

public SchemaAttributeType withRequired(java.lang.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 a reference to this object so that method calls can be chained together.

Parameters:

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:

A reference to this updated object so that method calls can be chained together.

getNumberAttributeConstraints

public NumberAttributeConstraintsType getNumberAttributeConstraints()

Specifies the constraints for an attribute of the number type.

Returns:

Specifies the constraints for an attribute of the number type.

setNumberAttributeConstraints

public void setNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints)

Specifies the constraints for an attribute of the number type.

Parameters:

numberAttributeConstraints -

Specifies the constraints for an attribute of the number type.

withNumberAttributeConstraints

public SchemaAttributeType withNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints)

Specifies the constraints for an attribute of the number type.

Returns a reference to this object so that method calls can be chained together.

Parameters:

numberAttributeConstraints -

Specifies the constraints for an attribute of the number type.

Returns:

A reference to this updated object so that method calls can be chained together.

getStringAttributeConstraints

public StringAttributeConstraintsType getStringAttributeConstraints()

Specifies the constraints for an attribute of the string type.

Returns:

Specifies the constraints for an attribute of the string type.

setStringAttributeConstraints

public void setStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints)

Specifies the constraints for an attribute of the string type.

Parameters:

stringAttributeConstraints -

Specifies the constraints for an attribute of the string type.

withStringAttributeConstraints

public SchemaAttributeType withStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints)

Specifies the constraints for an attribute of the string type.

Returns a reference to this object so that method calls can be chained together.

Parameters:

stringAttributeConstraints -

Specifies the constraints for an attribute of the string type.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object