Class CustomAttributeConfig
Configuration that will be fed into CloudFormation for any custom attribute type.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class CustomAttributeConfig : Object, ICustomAttributeConfig
Syntax (vb)
Public Class CustomAttributeConfig
Inherits Object
Implements ICustomAttributeConfig
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 customAttributeConfig = new CustomAttributeConfig {
DataType = "dataType",
// the properties below are optional
Mutable = false,
NumberConstraints = new NumberAttributeConstraints {
Max = 123,
Min = 123
},
StringConstraints = new StringAttributeConstraints {
MaxLen = 123,
MinLen = 123
}
};
Synopsis
Constructors
CustomAttributeConfig() |
Properties
DataType | The data type of the custom attribute. |
Mutable | Specifies whether the value of the attribute can be changed. |
NumberConstraints | The constraints for a custom attribute of the 'Number' data type. |
StringConstraints | The constraints for a custom attribute of 'String' data type. |
Constructors
CustomAttributeConfig()
public CustomAttributeConfig()
Properties
DataType
The data type of the custom attribute.
public string DataType { get; set; }
Property Value
System.String
Remarks
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
NumberConstraints
The constraints for a custom attribute of the 'Number' data type.
public INumberAttributeConstraints NumberConstraints { get; set; }
Property Value
Remarks
Default: - None.
StringConstraints
The constraints for a custom attribute of 'String' data type.
public IStringAttributeConstraints StringConstraints { get; set; }
Property Value
Remarks
Default: - None.