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.101.0 (build b95fe5d)",
           date="2024-07-12T19:33:56.787Z")
@Stability(Stable)
public interface LambdaIntegrationOptions
extends software.amazon.jsii.JsiiSerializable, IntegrationOptions

Example:

 Function backend;
 LambdaRestApi api = LambdaRestApi.Builder.create(this, "myapi")
         .handler(backend)
         .integrationOptions(LambdaIntegrationOptions.builder()
                 .allowTestInvoke(false)
                 .timeout(Duration.seconds(1))
                 .build())
         .build();
 

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.

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.

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

builder

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

Returns:

a LambdaIntegrationOptions.Builder of LambdaIntegrationOptions