Class CustomAttributeProps
Constraints that can be applied to a custom attribute of any type.
Inheritance
System.Object
CustomAttributeProps
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CustomAttributeProps : Object, ICustomAttributeProps
Syntax (vb)
Public Class CustomAttributeProps
Inherits Object
Implements 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
CustomAttributeProps() |
Properties
Mutable | Specifies whether the value of the attribute can be changed. |
Constructors
CustomAttributeProps()
public CustomAttributeProps()
Properties
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