Package software.amazon.awscdk.services.apigateway

Interface LambdaIntegrationOptions

All Superinterfaces:

IntegrationOptions, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

LambdaIntegrationOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:09:57.867Z")
@Stability(Stable)
public interface LambdaIntegrationOptions
extends software.amazon.jsii.JsiiSerializable, IntegrationOptions

Example:

 Resource book;
 Function backend;
 LambdaIntegration getBookIntegration = LambdaIntegration.Builder.create(backend)
         .scopePermissionToMethod(false)
         .build();
 LambdaIntegration createBookIntegration = LambdaIntegration.Builder.create(backend)
         .scopePermissionToMethod(false)
         .build();
 book.addMethod("GET", getBookIntegration);
 book.addMethod("POST", createBookIntegration);
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static LambdaIntegrationOptions.Builder	builder()
default Boolean	getAllowTestInvoke()	Allow invoking method from AWS Console UI (for testing purposes).
default Boolean	getProxy()	Use proxy integration or normal (request/response mapping) integration.
default Boolean	getScopePermissionToMethod()	Scope the permission for invoking the AWS Lambda down to the specific method associated with this integration.

Methods inherited from interface software.amazon.awscdk.services.apigateway.IntegrationOptions

getCacheKeyParameters, getCacheNamespace, getConnectionType, getContentHandling, getCredentialsPassthrough, getCredentialsRole, getIntegrationResponses, getPassthroughBehavior, getRequestParameters, getRequestTemplates, getTimeout, getVpcLink

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowTestInvoke

@Stability(Stable)
@Nullable
default Boolean getAllowTestInvoke()

Allow invoking method from AWS Console UI (for testing purposes).

This will add another permission to the AWS Lambda resource policy which will allow the test-invoke-stage stage to invoke this handler. If this is set to false, the function will only be usable from the deployment endpoint.

Note that this property is ignored when scopePermissionToMethod is false.

Default: true

getProxy

@Stability(Stable)
@Nullable
default Boolean getProxy()

Use proxy integration or normal (request/response mapping) integration.

Default: true

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format

getScopePermissionToMethod

@Stability(Stable)
@Nullable
default Boolean getScopePermissionToMethod()

Scope the permission for invoking the AWS Lambda down to the specific method associated with this integration.

If this is set to false, the permission will allow invoking the AWS Lambda from any method. This is useful for reducing the AWS Lambda policy size for cases where the same AWS Lambda function is reused for many integrations.

Note that this will always allow test invocations.

Default: true

builder

@Stability(Stable)
static LambdaIntegrationOptions.Builder builder()

Returns:

a LambdaIntegrationOptions.Builder of LambdaIntegrationOptions