New serverless pattern - appsync-private-api-sam #2367
Closed
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
pputhran
requested changes
Jul 26, 2024
|
|
||
| - Enter a stack name | ||
| - Enter the desired AWS Region | ||
| - Allow SAM CLI to create IAM roles with the required permissions. |
Contributor
There was a problem hiding this comment.
can you provide a clarifying example on how the SubnetIds Parameter need to be passed in? Is it comma separate or something esle?
| { | ||
| "title": "AWS AppSync Private API ", | ||
| "description": "Create an AWS AppSync Private API with a sample API to demonstrate how you can invoke Private API from resources in your private network", | ||
| "language": "Yaml", |
Contributor
There was a problem hiding this comment.
This should be YAML (uppercase)
bfreiberg
requested changes
Sep 11, 2024
appsync-private-api-sam/README.md
Outdated
|
|
||
| This patterns creates and AppSync Interface VPC Endpoint and a sample AppSync Private API backed with a DynamoDB data source. Requests to AppSync Private APIs will go through AWS’s private network without going over the internet. GraphQL requests from your application are routed via the interface VPC endpoint to AppSync Private API. Interface VPC endpoint is powered by [AWS PrivateLink](https://aws.amazon.com/privatelink/), a highly available, scalable technology that enables you to privately connect your VPC to AWS services like AWS AppSync as if the services were in your VPC. | ||
|
|
||
| API Key is used as the authorization mode for the AppSync API however it is not recommended to use API Key for production application, kindly refer to other authorization modes supported by AppSync in the [documentation](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) |
Contributor
There was a problem hiding this comment.
Suggested change
| API Key is used as the authorization mode for the AppSync API however it is not recommended to use API Key for production application, kindly refer to other authorization modes supported by AppSync in the [documentation](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) | |
| API Key is used as the authorization mode for the AppSync API. However it is not recommended to use API Key for production application, please refer to other authorization modes supported by AppSync in the [documentation](https://docs.aws.amazon.com/appsync/latest/devguide/security-authz.html) |
appsync-private-api-sam/README.md
Outdated
|
|
||
| ## Testing | ||
|
|
||
| You can easily test this pattern using any command prompt that supports the `curl` command. Refer to the outputs `AppSyncApiUrl`, `AppSyncApiKey` and `AppSyncVPCEndpointDNS` from deploying the SAM application which will be used for testing. |
Contributor
There was a problem hiding this comment.
Suggested change
| You can easily test this pattern using any command prompt that supports the `curl` command. Refer to the outputs `AppSyncApiUrl`, `AppSyncApiKey` and `AppSyncVPCEndpointDNS` from deploying the SAM application which will be used for testing. | |
| You can test this pattern using any command prompt that supports the `curl` command. Refer to the outputs `AppSyncApiUrl`, `AppSyncApiKey` and `AppSyncVPCEndpointDNS` from deploying the SAM application which will be used for testing. |
appsync-private-api-sam/README.md
Outdated
| -d '{"query": "query MyQuery {listRestaurants {items {name state restaurantId zip cuisine }}}","variables":"{}"}' | ||
| ``` | ||
|
|
||
| -- Using AppSync VPC Interface Endpoint DNS (you will need to pass the`AppSyncGraphQLAPIURL` in the host header, remember to remove suffix `www.`) |
Contributor
There was a problem hiding this comment.
Do you mean prefix instead?
Contributor
|
Hi, do you still plan to address the requested changes? |
Contributor
Author
|
I will be creating a new pull request with the changes |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 #, if available:
Description of changes: This pattern shows how you can deploy an AWS AppSync Private API which can only be invoked by resources within your private network.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.