aws-cdk-lib.aws_lambda.IWebFunction

IWebFunction Interface Added in v2.276.0

Represents a WebFunction resource, either created in this stack or imported.

IWebFunction

extends

• IResource,
• IWebFunctionRef,
• IGrantable,
• IResourceWithPolicyV2

implemented by

• WebFunction,
• WebFunctionBase

Source

aws-lambda/lib/webfunction.ts

Type last changed

v2.276.0 · 10 Nov 2026

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironment#

The environment this resource belongs to.

notes

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipal#

The principal to grant permissions to.

nodeNodenodeNodenodeNodeNodeNodeNodeNode#

The tree node.

role?may be undefinedIRoleRefrole?may be undefinedIRoleRefrole?may be undefinedIRoleRefRole?may be undefinedIRoleRefRole?may be undefinedIRoleRef#

The execution role of the WebFunction.

Undefined for an imported WebFunction.

stackStackstackStackstackStackStackStackStackStack#

The stack in which this resource is defined.

webFunctionArnstringweb_function_arnstrwebFunctionArnStringWebFunctionArnstringWebFunctionArn*string#

The ARN of the WebFunction.

webFunctionNamestringweb_function_namestrwebFunctionNameStringWebFunctionNamestringWebFunctionName*string#

The name of the WebFunction.

webFunctionRefWebFunctionReferenceweb_function_refWebFunctionReferencewebFunctionRefWebFunctionReferenceWebFunctionRefWebFunctionReferenceWebFunctionRefWebFunctionReference#

A reference to a WebFunction resource.

Methods

addToResourcePolicy(statement: PolicyStatement): AddToResourcePolicyResultdef add_to_resource_policy(self, statement: PolicyStatement) -> AddToResourcePolicyResultpublic AddToResourcePolicyResult addToResourcePolicy(PolicyStatement statement)public AddToResourcePolicyResult AddToResourcePolicy(PolicyStatement statement)func AddToResourcePolicy(Statement PolicyStatement) AddToResourcePolicyResult#

Add a statement to the resource's resource policy.

addToRolePolicy(statement: PolicyStatement): voiddef add_to_role_policy(self, statement: PolicyStatement) -> Nonepublic void addToRolePolicy(PolicyStatement statement)public void AddToRolePolicy(PolicyStatement statement)func AddToRolePolicy(Statement PolicyStatement)#

Adds a statement to the WebFunction's execution role.

For an imported WebFunction the role is unknown, so this adds a warning asking for the permission to be granted manually instead.

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#

Apply the given removal policy to this resource.

notes

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited.

1 parameter · returns

Parameters

• mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining