-
Notifications
You must be signed in to change notification settings - Fork 3.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
(@aws-cdk/aws-cognito): SettingAttribute 'fullname' is not consistent with documentation. #17361
Comments
@nija-at can you shed some light on why the StandardAttributes properties don't match the cognito documentation? We should make a note in our documentation somewhere to clarify that there's a mapping |
Thanks for taking a look at this. Any feedback? |
fullname is mapped to name |
@miguelcss The |
This issue has not received a response in a while. If you want to keep this issue open, please leave a comment below and auto-close will be canceled. |
This is noted in the original issue description. CDK cognito attribute documentation does not mention nor explain there is a mapping. Developers need to guess that The request was to add a note in the CDK cognito attribute documentation section stating that the Standard Attributes are mapped in CDK as per mapping. |
What is the problem?
Using aws-cognito to construct a new pool, the SettingAttribute interface is not consistent to the Cognito documentation.
The README.md points to the cognito documentation for a list of standard attributes user-pool-settings-attributes which specifically has 'name' property. Configuring cognito pool in AWS console, users are also familiar with 'name' .
Yet using the
standardAttributes: { name: {...
this option is not available. Diggin on the code one finds the actual mapping here and we can see we need to use 'fullname' for 'name'. This is convoluted and not mentioned anywhere in documentation, which leads to unexpected outcomesNote: same goes for
Why was this mapping created to differ from documentation? It seems odd.
I understand changing the value will now break consumers, but consider making it match Cognito documentation in future major version bump. In the meantime refer to this mapping in documentation/README.md
Reproduction Steps
What did you expect to happen?
Have cognito pool with documented parameter
name
enabled.What actually happened?
Error building construct:
CDK CLI Version
1.129.0
Framework Version
No response
Node.js Version
v17.0.1
OS
MacOS
Language
Typescript
Language Version
TypeScript (3.9.7)
Other information
No response
The text was updated successfully, but these errors were encountered: