Skip to content
v2.277.0

WebFunctionCodeCopyOptions Struct ​

Configuration for the Lambda function that copies staged code into its destination bucket.

The function is a stack-level singleton: every copy whose options resolve to the same configuration shares one function. Supplying different options produces a separate function, since a single Lambda cannot hold two conflicting configurations.

Example ​

ts
import * as ec2 from 'aws-cdk-lib/aws-ec2';

declare const vpc: ec2.IVpc;

lambda.WebFunctionCode.fromAssetToManagedBucket(path.join(__dirname, 'my-app'), {
  copyOptions: {
    vpc,
    vpcSubnets: { subnetType: ec2.SubnetType.PRIVATE_WITH_EGRESS },
  },
});
python
import aws_cdk.aws_ec2 as ec2

# vpc: ec2.IVpc


lambda_.WebFunctionCode.from_asset_to_managed_bucket(path.join(__dirname, "my-app"),
    copy_options=lambda.WebFunctionCodeCopyOptions(
        vpc=vpc,
        vpc_subnets=ec2.SubnetSelection(subnet_type=ec2.SubnetType.PRIVATE_WITH_EGRESS)
    )
)
java
import software.amazon.awscdk.services.ec2.*;

IVpc vpc;


WebFunctionCode.fromAssetToManagedBucket(join(__dirname, "my-app"), WebFunctionManagedBucketAssetOptions.builder()
        .copyOptions(WebFunctionCodeCopyOptions.builder()
                .vpc(vpc)
                .vpcSubnets(SubnetSelection.builder().subnetType(SubnetType.PRIVATE_WITH_EGRESS).build())
                .build())
        .build());
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.EC2;

IVpc vpc;


WebFunctionCode.FromAssetToManagedBucket(Join(__dirname, "my-app"), new WebFunctionManagedBucketAssetOptions {
    CopyOptions = new WebFunctionCodeCopyOptions {
        Vpc = vpc,
        VpcSubnets = new SubnetSelection { SubnetType = SubnetType.PRIVATE_WITH_EGRESS }
    }
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import ec2 "github.com/aws/aws-cdk-go/awscdk"

var vpc IVpc


lambda.WebFunctionCode_FromAssetToManagedBucket(path.join(__dirname, jsii.String("my-app")), &WebFunctionManagedBucketAssetOptions{
	CopyOptions: &WebFunctionCodeCopyOptions{
		Vpc: *Vpc,
		VpcSubnets: &SubnetSelection{
			SubnetType: ec2.SubnetType_PRIVATE_WITH_EGRESS,
		},
	},
})

Properties ​

logGroupoptionalILogGroupReflog_groupoptionalILogGroupReflogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRef #
The log group the Lambda function sends logs to.

Default: a log group is created in the stack, shared by every copy that uses the same function

roleoptionalIRoleroleoptionalIRoleroleoptionalIRoleRoleoptionalIRoleRoleoptionalIRole #
Execution role for the Lambda function that performs the copy.

Default: a role is created with permissions to read the source object and write the destination object

securityGroupsoptionalISecurityGroup[]security_groupsoptionaltyping.List[ISecurityGroup]securityGroupsoptionalList<ISecurityGroup>SecurityGroupsoptionalISecurityGroup[]SecurityGroupsoptional*[]ISecurityGroup #
Security groups for the Lambda function.

Default: a dedicated security group is created

Only used if vpc is supplied.

vpcoptionalIVpcvpcoptionalIVpcvpcoptionalIVpcVpcoptionalIVpcVpcoptionalIVpc #
The VPC to run the Lambda function in.

Default: the function is not placed in a VPC

Only needed if your organization requires all functions to run inside a VPC. The function calls S3, so the VPC needs either a NAT gateway or an S3 VPC endpoint.

vpcSubnetsoptionalSubnetSelectionvpc_subnetsoptionalSubnetSelectionvpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelectionVpcSubnetsoptionalSubnetSelection #
Which subnets to place the Lambda function in.

Default: the VPC's private subnets

Only used if vpc is supplied.