Interface CfnUserPool.ISchemaAttributeProperty
A list of the user attributes and their properties in your user pool.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface CfnUserPool.ISchemaAttributePropertySyntax (vb)
Public Interface CfnUserPool.ISchemaAttributePropertyRemarks
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.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var schemaAttributeProperty = new SchemaAttributeProperty {
AttributeDataType = "attributeDataType",
DeveloperOnlyAttribute = false,
Mutable = false,
Name = "name",
NumberAttributeConstraints = new NumberAttributeConstraintsProperty {
MaxValue = "maxValue",
MinValue = "minValue"
},
Required = false,
StringAttributeConstraints = new StringAttributeConstraintsProperty {
MaxLength = "maxLength",
MinLength = "minLength"
}
};Synopsis
Properties
| AttributeDataType | The data format of the values for your attribute. |
| DeveloperOnlyAttribute | You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using |
| Mutable | Specifies whether the value of the attribute can be changed. |
| Name | The name of your user pool attribute. |
| NumberAttributeConstraints | Specifies the constraints for an attribute of the number type. |
| Required | Specifies whether a user pool attribute is required. |
| StringAttributeConstraints | Specifies the constraints for an attribute of the string type. |
Properties
AttributeDataType
The data format of the values for your attribute.
string? AttributeDataType { get; }Property Value
Remarks
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
You should use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using
DeveloperOnlyAttribute.
object? DeveloperOnlyAttribute { get; }Property Value
Remarks
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.
Type union: either bool or IResolvable
Mutable
Specifies whether the value of the attribute can be changed.
object? Mutable { get; }Property Value
Remarks
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 .
Type union: either bool or IResolvable
Name
The name of your user pool attribute.
string? Name { get; }Property Value
Remarks
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
Specifies the constraints for an attribute of the number type.
object? NumberAttributeConstraints { get; }Property Value
Remarks
Required
Specifies whether a user pool attribute is required.
object? Required { get; }Property Value
Remarks
If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
Type union: either bool or IResolvable
StringAttributeConstraints
Specifies the constraints for an attribute of the string type.
object? StringAttributeConstraints { get; }