Class StringAttributeProps
Props for constructing a StringAttr.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class StringAttributeProps : Object, IStringAttributeProps, IStringAttributeConstraints, ICustomAttributeProps
Syntax (vb)
Public Class StringAttributeProps
Inherits Object
Implements IStringAttributeProps, IStringAttributeConstraints, ICustomAttributeProps
Remarks
ExampleMetadata: infused
Examples
new UserPool(this, "myuserpool", new UserPoolProps {
// ...
StandardAttributes = new StandardAttributes {
Fullname = new StandardAttribute {
Required = true,
Mutable = false
},
Address = new StandardAttribute {
Required = false,
Mutable = true
}
},
CustomAttributes = new Dictionary<string, ICustomAttribute> {
{ "myappid", new StringAttribute(new StringAttributeProps { MinLen = 5, MaxLen = 15, Mutable = false }) },
{ "callingcode", new NumberAttribute(new NumberAttributeProps { Min = 1, Max = 3, Mutable = true }) },
{ "isEmployee", new BooleanAttribute(new CustomAttributeProps { Mutable = true }) },
{ "joinedOn", new DateTimeAttribute() }
}
});
Synopsis
Constructors
StringAttributeProps() |
Properties
MaxLen | Maximum length of this attribute. |
MinLen | Minimum length of this attribute. |
Mutable | Specifies whether the value of the attribute can be changed. |
Constructors
StringAttributeProps()
public StringAttributeProps()
Properties
MaxLen
Maximum length of this attribute.
public Nullable<double> MaxLen { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 2048
MinLen
Minimum length of this attribute.
public Nullable<double> MinLen { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 0
Mutable
Specifies whether the value of the attribute can be changed.
public Nullable<bool> Mutable { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For any user pool attribute that's mapped to an identity provider attribute, you must set this parameter to true. Amazon Cognito updates mapped attributes when users sign in to your application through an identity provider. If an attribute is immutable, Amazon Cognito throws an error when it attempts to update the attribute.
Default: false