New serverless pattern - private-apigw-public-custom-domain added #2828
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
Sliiiin
force-pushed
the
nilbrand-feature-private-apigw-public-custom-domain
branch
from
c44c325 to
be4bb6c
Compare
bfreiberg
requested changes
Sep 10, 2025
| This architecture is intended for: | ||
| - **Internal APIs**: APIs that should only be accessible from within your network | ||
| - **Hybrid Connectivity**: APIs accessible from on-premises via VPN/Direct Connect | ||
| - **Public DNS Resolution**: APIs that resolve publicly but are only accessible privately |
There was a problem hiding this comment.
What's the use-case for this?
| - **Hybrid Connectivity**: APIs accessible from on-premises via VPN/Direct Connect | ||
| - **Public DNS Resolution**: APIs that resolve publicly but are only accessible privately | ||
|
|
||
| Learn more about this pattern at Serverless Land Patterns: << Add the live URL here >> |
There was a problem hiding this comment.
Please replace with the actual url using your folder name
| ## Troubleshooting | ||
|
|
||
| ### Certificate Issues | ||
| - Ensure certificate is in the same region as deployment |
There was a problem hiding this comment.
Suggested change
| - Ensure certificate is in the same region as deployment | |
| - Ensure certificate is in the same region |
|
|
||
| ### Lambda Function Issues | ||
| - Check CloudWatch logs for the RegisterVPCEndpointTargets function | ||
| - Verify IAM permissions for EC2 and ELB operations |
There was a problem hiding this comment.
what exactly is necessary here?
Comment on lines
+39
to
+41
| 2. **AWS CDK**: Installed and AWS Account bootstrapped | ||
| 3. **ACM Certificate**: Valid certificate for your domain in the deployment region | ||
| 4. **AWS CLI**: Configured with appropriate permissions |
There was a problem hiding this comment.
Add relevant links to the documentation. Compare to other submissions for style guide
|
|
||
| #### Outputs | ||
|
|
||
| The stack provides these outputs: |
There was a problem hiding this comment.
Are these all necessary?
| "elasticloadbalancing:DeregisterTargets", | ||
| "elasticloadbalancing:DescribeTargetHealth" | ||
| ], | ||
| resources=["*"] |
There was a problem hiding this comment.
can this be restricted to the current account and region?
| # Lambda function to register VPC endpoint IPs as targets | ||
| register_targets_function = _lambda.Function( | ||
| self, "RegisterVPCEndpointTargets", | ||
| runtime=_lambda.Runtime.PYTHON_3_9, |
There was a problem hiding this comment.
Use the most up-to-date version
| ## Security Features | ||
|
|
||
| - API only accessible through VPC endpoint | ||
| - Security groups restrict access to VPC and Client VPN ranges |
There was a problem hiding this comment.
Isn't the ALB Security group allowing traffic from anywhere?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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: #2824
Description of changes:
This pattern creates an Amazon Private API Gateway that is only accessible through VPC endpoints, with public custom domain name resolution for internal only access through an Amazon internal Application Load Balancer.
This architecture is intended for:
Internal APIs: APIs that should only be accessible from within your network
Client VPN Access: APIs accessible via AWS Client VPN connections
Hybrid Connectivity: APIs accessible from on-premises via VPN/Direct Connect
Public DNS Resolution: APIs that resolve publicly but are only accessible privately
This is a joint pattern by http://github.com/bquintas and https://github.com/Sliiiin
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.