interface CustomAttributeConfig

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CustomAttributeConfig
Java	software.amazon.awscdk.services.cognito.CustomAttributeConfig
Python	aws_cdk.aws_cognito.CustomAttributeConfig
TypeScript (source)	@aws-cdk/aws-cognito » CustomAttributeConfig

Obtainable from BooleanAttribute.bind(), DateTimeAttribute.bind(), NumberAttribute.bind(), StringAttribute.bind()

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
const customAttributeConfig: cognito.CustomAttributeConfig = {
  dataType: 'dataType',

  // the properties below are optional
  mutable: false,
  numberConstraints: {
    max: 123,
    min: 123,
  },
  stringConstraints: {
    maxLen: 123,
    minLen: 123,
  },
};

Properties

Name	Type	Description
dataType	string	The data type of the custom attribute.
mutable?	boolean	Specifies whether the value of the attribute can be changed.
numberConstraints?	NumberAttributeConstraints	The constraints for a custom attribute of the 'Number' data type.
stringConstraints?	StringAttributeConstraints	The constraints for a custom attribute of 'String' data type.

---

dataType

Type: string

The data type of the custom attribute.

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

---

mutable?

Type: boolean (optional, default: false)

Specifies whether the value of the attribute can be changed.

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.

---

numberConstraints?

Type: NumberAttributeConstraints (optional, default: None.)

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

---

stringConstraints?

Type: StringAttributeConstraints (optional, default: None.)

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