Interface ICustomAttributeConfig
Configuration that will be fed into CloudFormation for any custom attribute type.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ICustomAttributeConfig
Syntax (vb)
Public Interface 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
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. |
Properties
DataType
The data type of the custom attribute.
string DataType { get; }
Property Value
System.String
Remarks
Mutable
Specifies whether the value of the attribute can be changed.
virtual Nullable<bool> Mutable { get; }
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.
virtual INumberAttributeConstraints NumberConstraints { get; }
Property Value
Remarks
Default: - None.
StringConstraints
The constraints for a custom attribute of 'String' data type.
virtual IStringAttributeConstraints StringConstraints { get; }
Property Value
Remarks
Default: - None.