Interface CfnUserPool.ISchemaAttributeProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Contains information about the schema attribute.

public interface CfnUserPool.ISchemaAttributeProperty

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"
                 }
             };

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html

ExampleMetadata: fixture=_generated

Properties

AttributeDataType

The attribute data type.

string? AttributeDataType { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-attributedatatype

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 .

object? DeveloperOnlyAttribute { get; }

Property Value

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-developeronlyattribute

Mutable

Specifies whether the value of the attribute can be changed.

object? Mutable { get; }

Property Value

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 .

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-mutable

Name

A schema attribute of the name type.

string? Name { get; }

Property Value

string

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-name

NumberAttributeConstraints

Specifies the constraints for an attribute of the number type.

object? NumberAttributeConstraints { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-numberattributeconstraints

Required

Specifies whether a user pool attribute is required.

object? Required { get; }

Property Value

object

Remarks

If the attribute is required and the user doesn't provide a value, registration or sign-in will fail.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-required

StringAttributeConstraints

Specifies the constraints for an attribute of the string type.

object? StringAttributeConstraints { get; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-schemaattribute.html#cfn-cognito-userpool-schemaattribute-stringattributeconstraints