@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SchemaAttributeType extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
SchemaAttributeType() |
Modifier and Type | Method and Description |
---|---|
SchemaAttributeType |
clone() |
boolean |
equals(Object obj) |
String |
getAttributeDataType()
The data format of the values for your attribute.
|
Boolean |
getDeveloperOnlyAttribute()
|
Boolean |
getMutable()
Specifies whether the value of the attribute can be changed.
|
String |
getName()
The name of your user pool attribute.
|
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)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setAttributeDataType(AttributeDataType attributeDataType)
The data format of the values for your attribute.
|
void |
setAttributeDataType(String attributeDataType)
The data format of the values for your attribute.
|
void |
setDeveloperOnlyAttribute(Boolean developerOnlyAttribute)
|
void |
setMutable(Boolean mutable)
Specifies whether the value of the attribute can be changed.
|
void |
setName(String name)
The name of your user pool attribute.
|
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 data format of the values for your attribute.
|
SchemaAttributeType |
withAttributeDataType(String attributeDataType)
The data format of the values for your attribute.
|
SchemaAttributeType |
withDeveloperOnlyAttribute(Boolean developerOnlyAttribute)
|
SchemaAttributeType |
withMutable(Boolean mutable)
Specifies whether the value of the attribute can be changed.
|
SchemaAttributeType |
withName(String name)
The name of your user pool attribute.
|
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.
|
public void setName(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..
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..public String getName()
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..
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..public SchemaAttributeType withName(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..
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..public void setAttributeDataType(String 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"
.
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"
.AttributeDataType
public String getAttributeDataType()
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"
.
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"
.AttributeDataType
public SchemaAttributeType withAttributeDataType(String 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"
.
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"
.AttributeDataType
public void setAttributeDataType(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"
.
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"
.AttributeDataType
public SchemaAttributeType withAttributeDataType(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"
.
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"
.AttributeDataType
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.
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.
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.
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.
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.
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.
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.
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.
public void setMutable(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.
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.
public 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.
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.
public SchemaAttributeType withMutable(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.
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.
public 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.
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.
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.
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.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.
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.
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.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.
public void setNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints)
Specifies the constraints for an attribute of the number type.
numberAttributeConstraints
- Specifies the constraints for an attribute of the number type.public NumberAttributeConstraintsType getNumberAttributeConstraints()
Specifies the constraints for an attribute of the number type.
public SchemaAttributeType withNumberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints)
Specifies the constraints for an attribute of the number type.
numberAttributeConstraints
- Specifies the constraints for an attribute of the number type.public void setStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints)
Specifies the constraints for an attribute of the string type.
stringAttributeConstraints
- Specifies the constraints for an attribute of the string type.public StringAttributeConstraintsType getStringAttributeConstraints()
Specifies the constraints for an attribute of the string type.
public SchemaAttributeType withStringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints)
Specifies the constraints for an attribute of the string type.
stringAttributeConstraints
- Specifies the constraints for an attribute of the string type.public String toString()
toString
in class Object
Object.toString()
public SchemaAttributeType clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.