Skip to content
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

Jump to bottom

docs(lambda): Document recent changes to vpcSubnets property #21572

Merged
merged 2 commits into from
Aug 12, 2022
Merged

docs(lambda): Document recent changes to vpcSubnets property #21572

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f1c970
docs(lambda): Document recent changes to `vpcSubnets` property
laurelmay Aug 12, 2022
a412893
Merge branch 'main' into lambda-vpcSubnets-error
mergify[bot] Aug 12, 2022
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: 6 additions & 2 deletions packages/@aws-cdk/aws-lambda/lib/function.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ export interface FunctionOptions extends EventInvokeConfigOptions {
* VPC network to place Lambda network interfaces
*
* Specify this if the Lambda function needs to access resources in a VPC.
* This is required when `vpcSubnets` is specified.
*
* @default - Function is not placed within a VPC.
*/
Expand All @@ -141,8 +142,11 @@ export interface FunctionOptions extends EventInvokeConfigOptions {
/**
* Where to place the network interfaces within the VPC.
*
* Only used if 'vpc' is supplied. Note: internet access for Lambdas
* requires a NAT gateway, so picking Public subnets is not allowed.
* This requires `vpc` to be specified in order for interfaces to actually be
* placed in the subnets. If `vpc` is not specify, this will raise an error.
*
* Note: Internet access for Lambda Functions requires a NAT Gateway, so picking
* public subnets is not allowed (unless `allowPublicSubnet` is set to `true`).
*
* @default - the Vpc default strategy if not specified
*/
Expand Down