Skip to content

Commit

Permalink
docs(cognito): minor clarifications (#13732)
Browse files Browse the repository at this point in the history
Minor clarification in the docs.

closes #12932
closes #12931
closes #12930


----

*By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
  • Loading branch information
Niranjan Jayakar committed Mar 22, 2021
1 parent 34bb338 commit 2445b68
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions packages/@aws-cdk/aws-cognito/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ new cognito.UserPool(this, 'myuserpool', {
selfSignUpEnabled: true,
userVerification: {
emailSubject: 'Verify your email for our awesome app!',
emailBody: 'Hello {username}, Thanks for signing up to our awesome app! Your verification code is {####}',
emailBody: 'Thanks for signing up to our awesome app! Your verification code is {####}',
emailStyle: cognito.VerificationEmailStyle.CODE,
smsMessage: 'Hello {username}, Thanks for signing up to our awesome app! Your verification code is {####}',
smsMessage: 'Thanks for signing up to our awesome app! Your verification code is {####}',
}
});
```
Expand Down Expand Up @@ -345,7 +345,7 @@ on the construct, as so -
const authChallengeFn = new lambda.Function(this, 'authChallengeFn', {
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler',
code: lambda.Code.fromInline('auth challenge'),
code: lambda.Code.fromAsset(/* path to lambda asset */),
});

const userpool = new cognito.UserPool(this, 'myuserpool', {
Expand All @@ -359,7 +359,7 @@ const userpool = new cognito.UserPool(this, 'myuserpool', {
userpool.addTrigger(cognito.UserPoolOperation.USER_MIGRATION, new lambda.Function(this, 'userMigrationFn', {
runtime: lambda.Runtime.NODEJS_12_X,
handler: 'index.handler',
code: lambda.Code.fromInline('user migration'),
code: lambda.Code.fromAsset(/* path to lambda asset */),
}));
```

Expand Down
2 changes: 1 addition & 1 deletion packages/@aws-cdk/aws-cognito/lib/user-pool-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ export interface UserPoolClientOptions {
readonly disableOAuth?: boolean;

/**
* OAuth settings for this to client to interact with the app.
* OAuth settings for this client to interact with the app.
* An error is thrown when this is specified and `disableOAuth` is set.
* @default - see defaults in `OAuthSettings`. meaningless if `disableOAuth` is set.
*/
Expand Down

0 comments on commit 2445b68

Please sign in to comment.