Skip to content
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.

Sign up for GitHub

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

Jump to bottom

(Cognito / UserPool): UserPool MfaSecondFactor Docstring #19375

Closed
d-e-a-n-f opened this issue Mar 13, 2022 · 1 comment
Closed

(Cognito / UserPool): UserPool MfaSecondFactor Docstring #19375

d-e-a-n-f opened this issue Mar 13, 2022 · 1 comment
Assignees
@corymhall
Labels
@aws-cdk/aws-cognito Related to Amazon Cognito documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged.

Comments

@d-e-a-n-f
Copy link
Contributor

link to reference doc page

aws-cdk/packages/@aws-cdk/aws-cognito/lib/user-pool.ts

Line 588 in 5bad3aa

* @default - { sms: true, oneTimePassword: false }, if `mfa` is set to `OPTIONAL` or `REQUIRED`.

Describe your issue?

Summary

In the Cognito UserPool module the doc-strings for the property MfaSecondFactor give an incorrect property for the MfaSecondFactor interface which is changed to otp.

Link To doc-string: HERE
@d-e-a-n-f d-e-a-n-f added documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged. labels Mar 13, 2022
@github-actions github-actions bot added the @aws-cdk/aws-cognito Related to Amazon Cognito label Mar 13, 2022
@d-e-a-n-f d-e-a-n-f mentioned this issue Mar 13, 2022
Merged
mergify bot pushed a commit that referenced this issue Mar 14, 2022
docs(aws-cognito): Docstring naming for userpool interface property (#…
afc70bd 
…19376)

# Summary

Fix the incorrect property name for the **MfaSecondFactor** interface on the UserPool Class doc-strings.

>Fixes the below issue
#19375 
----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@corymhall corymhall

Labels
@aws-cdk/aws-cognito Related to Amazon Cognito documentation This is a problem with documentation. feature-request A feature should be added or improved. needs-triage This issue or PR still needs to be triaged.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@corymhall @d-e-a-n-f