com.amazonaws.services.cognitoidp.model

Class SchemaAttributeType

java.lang.Object

com.amazonaws.services.cognitoidp.model.SchemaAttributeType

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SchemaAttributeType
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains information about the schema attribute.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SchemaAttributeType()

Method Summary

Modifier and Type	Method and Description
SchemaAttributeType	clone()
boolean	equals(Object obj)
String	getAttributeDataType() The attribute data type.
Boolean	getDeveloperOnlyAttribute()
Boolean	getMutable() Specifies whether the value of the attribute can be changed.
String	getName() A schema attribute of the name type.
NumberAttributeConstraintsType	getNumberAttributeConstraints() Specifies the constraints for an attribute of the number type.
Boolean	getRequired() Specifies whether a user pool attribute is required.
StringAttributeConstraintsType	getStringAttributeConstraints() Specifies the constraints for an attribute of the string type.
int	hashCode()
Boolean	isDeveloperOnlyAttribute()
Boolean	isMutable() Specifies whether the value of the attribute can be changed.
Boolean	isRequired() Specifies whether a user pool attribute is required.
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAttributeDataType(AttributeDataType attributeDataType) The attribute data type.
void	setAttributeDataType(String attributeDataType) The attribute data type.
void	setDeveloperOnlyAttribute(Boolean developerOnlyAttribute)
void	setMutable(Boolean mutable) Specifies whether the value of the attribute can be changed.
void	setName(String name) A schema attribute of the name type.
void	setNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
void	setRequired(Boolean required) Specifies whether a user pool attribute is required.
void	setStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints) Specifies the constraints for an attribute of the string type.
String	toString() Returns a string representation of this object.
SchemaAttributeType	withAttributeDataType(AttributeDataType attributeDataType) The attribute data type.
SchemaAttributeType	withAttributeDataType(String attributeDataType) The attribute data type.
SchemaAttributeType	withDeveloperOnlyAttribute(Boolean developerOnlyAttribute)
SchemaAttributeType	withMutable(Boolean mutable) Specifies whether the value of the attribute can be changed.
SchemaAttributeType	withName(String name) A schema attribute of the name type.
SchemaAttributeType	withNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
SchemaAttributeType	withRequired(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

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

Constructor Detail

SchemaAttributeType

public SchemaAttributeType()

Method Detail

setName

public void setName(String name)

A schema attribute of the name type.

Parameters:

name - A schema attribute of the name type.

getName

public String getName()

A schema attribute of the name type.

Returns:

A schema attribute of the name type.

withName

public SchemaAttributeType withName(String name)

A schema attribute of the name type.

Parameters:

name - A schema attribute of the name type.

Returns:

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

setAttributeDataType

public void setAttributeDataType(String attributeDataType)

The attribute data type.

Parameters:

attributeDataType - The attribute data type.

See Also:

AttributeDataType

getAttributeDataType

public String getAttributeDataType()

The attribute data type.

Returns:

The attribute data type.

See Also:

AttributeDataType

withAttributeDataType

public SchemaAttributeType withAttributeDataType(String attributeDataType)

The attribute data type.

Parameters:

attributeDataType - The attribute data type.

Returns:

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

See Also:

AttributeDataType

setAttributeDataType

public void setAttributeDataType(AttributeDataType attributeDataType)

The attribute data type.

Parameters:

attributeDataType - The attribute data type.

See Also:

AttributeDataType

withAttributeDataType

public SchemaAttributeType withAttributeDataType(AttributeDataType attributeDataType)

The attribute data type.

Parameters:

attributeDataType - The attribute data type.

Returns:

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

See Also:

AttributeDataType

setDeveloperOnlyAttribute

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

getDeveloperOnlyAttribute

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

withDeveloperOnlyAttribute

public SchemaAttributeType withDeveloperOnlyAttribute(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.

Returns:

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

isDeveloperOnlyAttribute

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

setMutable

public void setMutable(Boolean mutable)

Specifies whether the value of the attribute can be changed.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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 Boolean getMutable()

Specifies whether the value of the attribute can be changed.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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(Boolean mutable)

Specifies whether the value of the attribute can be changed.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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:

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

isMutable

public Boolean isMutable()

Specifies whether the value of the attribute can be changed.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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.

For any user pool attribute that is mapped to an IdP attribute, you must set this parameter to 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.

setRequired

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

getRequired

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

withRequired

public SchemaAttributeType withRequired(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.

Returns:

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

isRequired

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

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.

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.

withNumberAttributeConstraints

public SchemaAttributeType withNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints)

Specifies the constraints for an attribute of the number type.

Parameters:

numberAttributeConstraints - Specifies the constraints for an attribute of the number type.

Returns:

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

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.

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.

withStringAttributeConstraints

public SchemaAttributeType withStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints)

Specifies the constraints for an attribute of the string type.

Parameters:

stringAttributeConstraints - Specifies the constraints for an attribute of the string type.

Returns:

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

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SchemaAttributeType clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo