chore(apigatewayv2): review readme

[sumupitchayan]

API Review Session for aws-apigatewayv2-alpha, aws-apigatewayv2-authorizers-alpha, and aws-apigatewayv2-integrations-alpha.

---

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

[mikewrighton]

Incomplete sentence? Access control for Http APIs is managed by restricting which routes can be invoked via.

[mikewrighton]

What do we mean by 'app client'?

[vinayak-kukreja]

You can set an authorizer to your WebSocket API's $connect route to control access to your API.

Does this also apply to Lambda Authorizers in WebSocket? Or do we have a property that reflects this?

[scanlonp]

General comments:

• We do not explain integrations before we use them in ApiGatewayV2. I do not think linking the other module is enough. We should give a quick run down of what the integrations are used for, and how they help before we use them in the first code example.
• Using routes is not explained in detail. I see many examples of adding routes, but few on using them after creation.b
  • In the authorizers readme, it does a grant method on routes[0] (line 225)
  • Is this how we should reference routes? What if I have 10 routes, do I need to keep track of the array? Could I give them a name instead to reference by?
• IAM authorizers are not consistent between HTTP and Websocket.
  • In the websocket section, we create an IAM user and manually write a policy. This cannot be the preferred way of adding IAM policys (288)
• I would like to see more in-line comments in the code examples, especially the early examples. There is too much unexplained code. I think a short comment on most lines giving the idea of what it does would be helpful to follow along for the rest of the examples.
  • I think apigatewayv1 is sometimes overboard on in-line comments. apigatewayv2 is a little underboard.

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

[aws-cdk-automation]

AWS CodeBuild CI Report

• CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
• Commit ID: 167a832
• Result: SUCCEEDED
• Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

[mergify]

Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).