Interface CfnUserPool.ISchemaAttributeProperty
Contains information about the schema attribute.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ISchemaAttributeProperty
Syntax (vb)
Public Interface ISchemaAttributeProperty
Remarks
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 attribute data type. |
DeveloperOnlyAttribute | We recommend that you 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 | A schema attribute of the name type. |
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 attribute data type.
virtual string AttributeDataType { get; }
Property Value
System.String
Remarks
DeveloperOnlyAttribute
We recommend that you use WriteAttributes in the user pool client to control how attributes can be mutated for new use cases instead of using
DeveloperOnlyAttribute
.
virtual object DeveloperOnlyAttribute { get; }
Property Value
System.Object
Remarks
Specifies whether the attribute type is developer only. This attribute can only be modified by an administrator. Users will not be able to modify this attribute using their access token.
Mutable
Specifies whether the value of the attribute can be changed.
virtual object Mutable { get; }
Property Value
System.Object
Remarks
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 .
Name
A schema attribute of the name type.
virtual string Name { get; }
Property Value
System.String
Remarks
NumberAttributeConstraints
Specifies the constraints for an attribute of the number type.
virtual object NumberAttributeConstraints { get; }
Property Value
System.Object
Remarks
Required
Specifies whether a user pool attribute is required.
virtual object Required { get; }
Property Value
System.Object
Remarks
If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.
StringAttributeConstraints
Specifies the constraints for an attribute of the string type.
virtual object StringAttributeConstraints { get; }
Property Value
System.Object