software.amazon.awscdk.services.lambda

Interface CfnFunction.VpcConfigProperty

All Known Implementing Classes:

CfnFunction.VpcConfigProperty.Jsii$Proxy

Enclosing class:

CfnFunction

public static interface CfnFunction.VpcConfigProperty

The VPC security groups and subnets that are attached to a Lambda function.

When you connect a function to a VPC, Lambda creates an elastic network interface for each combination of security group and subnet in the function's VPC configuration. The function can only access resources and the internet through that VPC. For more information, see VPC Settings .

When you delete a function, AWS CloudFormation monitors the state of its network interfaces and waits for Lambda to delete them before proceeding. If the VPC is defined in the same stack, the network interfaces need to be deleted by Lambda before AWS CloudFormation can delete the VPC's resources.

To monitor network interfaces, AWS CloudFormation needs the ec2:DescribeNetworkInterfaces permission. It obtains this from the user or role that modifies the stack. If you don't provide this permission, AWS CloudFormation does not wait for network interfaces to be deleted.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 VpcConfigProperty vpcConfigProperty = VpcConfigProperty.builder()
         .securityGroupIds(List.of("securityGroupIds"))
         .subnetIds(List.of("subnetIds"))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnFunction.VpcConfigProperty.Builder A builder for CfnFunction.VpcConfigProperty
static class	CfnFunction.VpcConfigProperty.Jsii$Proxy An implementation for CfnFunction.VpcConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnFunction.VpcConfigProperty.Builder	builder()
default java.util.List<java.lang.String>	getSecurityGroupIds() A list of VPC security group IDs.
default java.util.List<java.lang.String>	getSubnetIds() A list of VPC subnet IDs.

Method Detail

getSecurityGroupIds

default java.util.List<java.lang.String> getSecurityGroupIds()

A list of VPC security group IDs.

getSubnetIds

default java.util.List<java.lang.String> getSubnetIds()

A list of VPC subnet IDs.

builder

static CfnFunction.VpcConfigProperty.Builder builder()

Returns:

a CfnFunction.VpcConfigProperty.Builder of CfnFunction.VpcConfigProperty