Interface SchemaAttributeType.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<SchemaAttributeType.Builder,
,SchemaAttributeType> SdkBuilder<SchemaAttributeType.Builder,
,SchemaAttributeType> SdkPojo
- Enclosing class:
SchemaAttributeType
-
Method Summary
Modifier and TypeMethodDescriptionattributeDataType
(String attributeDataType) The data format of the values for your attribute.attributeDataType
(AttributeDataType attributeDataType) The data format of the values for your attribute.developerOnlyAttribute
(Boolean developerOnlyAttribute) Specifies whether the value of the attribute can be changed.The name of your user pool attribute.default SchemaAttributeType.Builder
numberAttributeConstraints
(Consumer<NumberAttributeConstraintsType.Builder> numberAttributeConstraints) Specifies the constraints for an attribute of the number type.numberAttributeConstraints
(NumberAttributeConstraintsType numberAttributeConstraints) Specifies the constraints for an attribute of the number type.Specifies whether a user pool attribute is required.default SchemaAttributeType.Builder
stringAttributeConstraints
(Consumer<StringAttributeConstraintsType.Builder> stringAttributeConstraints) Specifies the constraints for an attribute of the string type.stringAttributeConstraints
(StringAttributeConstraintsType stringAttributeConstraints) Specifies the constraints for an attribute of the string type.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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 ofMyAttribute
, Amazon Cognito creates the custom attributecustom:MyAttribute
. WhenDeveloperOnlyAttribute
istrue
, Amazon Cognito creates your attribute asdev:MyAttribute
. In an operation that describes a user pool, Amazon Cognito returns this value asvalue
for standard attributes,custom:value
for custom attributes, anddev:value
for developer-only attributes..- Parameters:
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 aName
value ofMyAttribute
, Amazon Cognito creates the custom attributecustom:MyAttribute
. WhenDeveloperOnlyAttribute
istrue
, Amazon Cognito creates your attribute asdev:MyAttribute
. In an operation that describes a user pool, Amazon Cognito returns this value asvalue
for standard attributes,custom:value
for custom attributes, anddev:value
for developer-only attributes..- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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"
.- Parameters:
attributeDataType
- The data format of the values for your attribute. When you choose anAttributeDataType
, 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"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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"
.- Parameters:
attributeDataType
- The data format of the values for your attribute. When you choose anAttributeDataType
, 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"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
-
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
numberAttributeConstraints
SchemaAttributeType.Builder numberAttributeConstraints(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.
-
numberAttributeConstraints
default SchemaAttributeType.Builder numberAttributeConstraints(Consumer<NumberAttributeConstraintsType.Builder> numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
This is a convenience method that creates an instance of theNumberAttributeConstraintsType.Builder
avoiding the need to create one manually viaNumberAttributeConstraintsType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tonumberAttributeConstraints(NumberAttributeConstraintsType)
.- Parameters:
numberAttributeConstraints
- a consumer that will call methods onNumberAttributeConstraintsType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
stringAttributeConstraints
SchemaAttributeType.Builder stringAttributeConstraints(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.
-
stringAttributeConstraints
default SchemaAttributeType.Builder stringAttributeConstraints(Consumer<StringAttributeConstraintsType.Builder> stringAttributeConstraints) Specifies the constraints for an attribute of the string type.
This is a convenience method that creates an instance of theStringAttributeConstraintsType.Builder
avoiding the need to create one manually viaStringAttributeConstraintsType.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostringAttributeConstraints(StringAttributeConstraintsType)
.- Parameters:
stringAttributeConstraints
- a consumer that will call methods onStringAttributeConstraintsType.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-