Class CustomAttributeProps

Constraints that can be applied to a custom attribute of any type.

Inheritance

object

CustomAttributeProps

Implements

ICustomAttributeProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CustomAttributeProps : ICustomAttributeProps

Syntax (vb)

Public Class CustomAttributeProps 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()

Constraints that can be applied to a custom attribute of any type.

Properties

Mutable

Specifies whether the value of the attribute can be changed.

Constructors

CustomAttributeProps()

Constraints that can be applied to a custom attribute of any type.

public CustomAttributeProps()

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() }
                }
            });

Properties

Mutable

Specifies whether the value of the attribute can be changed.

public bool? Mutable { get; set; }

Property Value

bool?

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

Implements

ICustomAttributeProps