Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface SchemaAttributeType.Builder

    • Method Detail

      • name

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

        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 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..
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • attributeDataType

        SchemaAttributeType.Builder attributeDataType​(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".

        Parameters:
        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".
        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 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 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".
        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.

        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

        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.

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