software.amazon.awssdk.services.cognitoidentityprovider.model

Interface SchemaAttributeType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SchemaAttributeType.Builder,SchemaAttributeType>, SdkBuilder<SchemaAttributeType.Builder,SchemaAttributeType>, SdkPojo

Enclosing class:

SchemaAttributeType

public static interface SchemaAttributeType.Builder
extends SdkPojo, CopyableBuilder<SchemaAttributeType.Builder,SchemaAttributeType>

Method Summary

Modifier and Type	Method and Description
SchemaAttributeType.Builder	attributeDataType(AttributeDataType attributeDataType) The attribute data type.
SchemaAttributeType.Builder	attributeDataType(String attributeDataType) The attribute data type.
SchemaAttributeType.Builder	developerOnlyAttribute(Boolean developerOnlyAttribute)
SchemaAttributeType.Builder	mutable(Boolean mutable) Specifies whether the value of the attribute can be changed.
SchemaAttributeType.Builder	name(String name) A schema attribute of the name type.
default SchemaAttributeType.Builder	numberAttributeConstraints(Consumer<NumberAttributeConstraintsType.Builder> numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
SchemaAttributeType.Builder	numberAttributeConstraints(NumberAttributeConstraintsType numberAttributeConstraints) Specifies the constraints for an attribute of the number type.
SchemaAttributeType.Builder	required(Boolean required) 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.
SchemaAttributeType.Builder	stringAttributeConstraints(StringAttributeConstraintsType stringAttributeConstraints) Specifies the constraints for an attribute of the string type.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

name

SchemaAttributeType.Builder name(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.

attributeDataType

SchemaAttributeType.Builder attributeDataType(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, AttributeDataType

attributeDataType

SchemaAttributeType.Builder attributeDataType(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, AttributeDataType

developerOnlyAttribute

SchemaAttributeType.Builder developerOnlyAttribute(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.

mutable

SchemaAttributeType.Builder mutable(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.

required

SchemaAttributeType.Builder required(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.

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 the NumberAttributeConstraintsType.Builder avoiding the need to create one manually via NumberAttributeConstraintsType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to numberAttributeConstraints(NumberAttributeConstraintsType).

Parameters:

numberAttributeConstraints - a consumer that will call methods on NumberAttributeConstraintsType.Builder

Returns:

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

See Also:

numberAttributeConstraints(NumberAttributeConstraintsType)

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 the StringAttributeConstraintsType.Builder avoiding the need to create one manually via StringAttributeConstraintsType.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to stringAttributeConstraints(StringAttributeConstraintsType).

Parameters:

stringAttributeConstraints - a consumer that will call methods on StringAttributeConstraintsType.Builder

Returns:

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

See Also:

stringAttributeConstraints(StringAttributeConstraintsType)