Skip to content

docs(cognito): minor clarifications #13732

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

Merged
mergify merged 3 commits into from
Mar 22, 2021
Merged

docs(cognito): minor clarifications #13732

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dc0c294
docs(cognito): minor clarifications
Mar 22, 2021
379be10
Merge branch 'master' into nija-at/cognito-docs
mergify[bot] Mar 22, 2021
208d8fd
Merge branch 'master' into nija-at/cognito-docs
mergify[bot] Mar 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/@aws-cdk/aws-cognito/README.md
View file
Open in desktop
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
View file
Open in desktop
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