Interface ICustomAttributeConfig

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Configuration that will be fed into CloudFormation for any custom attribute type.

public interface ICustomAttributeConfig

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

Remarks

ExampleMetadata: fixture=_generated

Properties

DataType

The data type of the custom attribute.

string DataType { get; }

Property Value

string

Remarks

See: https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SchemaAttributeType.html#CognitoUserPools-Type-SchemaAttributeType-AttributeDataType

Mutable

Specifies whether the value of the attribute can be changed.

bool? Mutable { get; }

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

NumberConstraints

The constraints for a custom attribute of the 'Number' data type.

INumberAttributeConstraints? NumberConstraints { get; }

Property Value

INumberAttributeConstraints

Remarks

Default: - None.

StringConstraints

The constraints for a custom attribute of 'String' data type.

IStringAttributeConstraints? StringConstraints { get; }

Property Value

IStringAttributeConstraints

Remarks

Default: - None.