SchemaAttributeType Class | AWS SDK for .NET V3

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 dev: attributes are a legacy feature of user pools, and 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.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

Inheritance Hierarchy

System.Object
Amazon.CognitoIdentityProvider.Model.SchemaAttributeType

Namespace: Amazon.CognitoIdentityProvider.Model
Assembly: AWSSDK.CognitoIdentityProvider.dll
Version: 3.x.y.z

Syntax

public class SchemaAttributeType

The SchemaAttributeType type exposes the following members

Constructors

	Name	Description
	SchemaAttributeType()

Properties

Name	Type	Description
AttributeDataType	Amazon.CognitoIdentityProvider.AttributeDataType	Gets and sets the property 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"`.
DeveloperOnlyAttribute	System.Boolean	Gets and sets the property 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.
Mutable	System.Boolean	Gets and sets the property 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.
Name	System.String	Gets and sets the property 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..
NumberAttributeConstraints	Amazon.CognitoIdentityProvider.Model.NumberAttributeConstraintsType	Gets and sets the property NumberAttributeConstraints. Specifies the constraints for an attribute of the number type.
Required	System.Boolean	Gets and sets the property 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.
StringAttributeConstraints	Amazon.CognitoIdentityProvider.Model.StringAttributeConstraintsType	Gets and sets the property StringAttributeConstraints. Specifies the constraints for an attribute of the string type.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5