Skip to content

docs(s3-deployment): explain EFS networking requirements - #39333

Open
caglarkc wants to merge 2 commits into
aws:mainfrom
caglarkc:docs/s3-deployment-efs-networking-19777
Open

caglarkc wants to merge 2 commits into
aws:mainfrom
caglarkc:docs/s3-deployment-efs-networking-19777

Conversation

@caglarkc

@caglarkc caglarkc commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Issue # (if applicable)

Closes #19777.

Description

EFS-backed deployments still need S3 connectivity. Explain the NAT and S3 gateway endpoint alternatives, the endpoint policy and subnet requirements, and memory/network considerations. Include an isolated-subnet example with an S3 gateway endpoint and an explicit memory allocation.

Validation

  • The README example compiled and translated with jsii-rosetta (1 snippet, no diagnostics).
  • Synthesized the example: no NAT gateways; S3 gateway endpoint route tables match the isolated deployment subnets; deployment Lambda has EFS mounted and 1024 MiB of memory.
  • Checked connectivity requirements against the official Lambda, S3 VPC endpoint, and CloudFormation custom-resource response documentation.

Documentation only; no resources are provisioned automatically by this change.


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

@caglarkc
caglarkc deployed to automation October 16, 2026 13:36 — with GitHub Actions Active
@caglarkc
caglarkc deployed to automation October 16, 2026 13:36 — with GitHub Actions Active
@github-actions github-actions Bot added effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Oct 16, 2026
@aws-cdk-automation
aws-cdk-automation requested a review from a team October 16, 2026 13:37
@caglarkc
caglarkc deployed to automation October 16, 2026 13:37 — with GitHub Actions Active
@maintainer-for-aws

Copy link
Copy Markdown

Automated review

A maintainer will still review this — treat the notes below as a starting point.

📌 Commit 10d36ac

This documentation-only change rewrites the "EFS Support" section of the aws-s3-deployment README to explain the VPC networking and memory requirements for EFS-backed BucketDeployment. It corrects earlier wording to the actual useEfs: true prop and 512 MiB ephemeral storage, explains that the deployment function must reach both source and destination buckets over HTTPS (via a NAT gateway or an S3 gateway endpoint, since the construct creates no S3 endpoint itself), documents the CloudFormation custom-resource response-bucket timeout risk, and rewrites the example to demonstrate the no-NAT path. The prose claims are accurate against the construct code and AWS behavior, and the example's identifiers and API calls resolve correctly. No issues found on this change.

🔴 0 blocking · 🟡 0 recommended · ⚪ 0 optional


Generated automatically. React 👍 or 👎 to tell us whether this review helped, so we can improve these reviews.

@caglarkc
caglarkc deployed to automation October 16, 2026 14:20 — with GitHub Actions Active
@aws-cdk-automation aws-cdk-automation added the pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member. label Oct 16, 2026

This branch was successfully deployed

1 active deployment
automation — 10d36ac8 Deployed Oct 16, 2026 by aws-cdk-automation via validate-pr #372948
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK effort/small Small work item – less than a day of effort feature-request A feature should be added or improved. p2 pr/needs-community-review This PR needs a review from a Trusted Community Member or Core Team Member.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

aws-s3-deployment using EFS does not explain the need of a NAT subnet for mandatory vpc prop

2 participants