docs(cognito): clarify standard attribute name mappings #35072
+4
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
### Issue Closes aws#17361 ### Reason for this change The `StandardAttribute` interface for Cognito User Pools in the CDK includes `profilePicture` and `fullname` attributes that do not exist in the [official list](https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html) of Cognito standard attributes. These attributes are being mapped to the actual Cognito attributes `name` and `picture` internally in [`attr-names.ts`](https://github.com/aws/aws-cdk/blob/v1-main/packages/@aws-cdk/aws-cognito/lib/private/attr-names.ts). This can be confusing for developers who are referencing Cognito's official documentation and expect the attribute names to match exactly. ### Description of changes Added a note in both `fullname` and `profilePicture` docstrings to clarify the mappings. *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
github-actions
bot
added
the
beginning-contributor
github-actions
bot
added
feature-request
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue
Closes #17361
Reason for this change
The
StandardAttributeinterface for Cognito User Pools in the CDK includesprofilePictureandfullnameattributes that do not exist in the official list of Cognito standard attributes. These attributes are being mapped to the actual Cognito attributesnameandpictureinternally inattr-names.ts.This can be confusing for developers who are referencing Cognito's official documentation and expect the attribute names to match exactly.
Description of changes
Added a note in both
fullnameandprofilePicturedocstrings to clarify the mappings.Checklist
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license