interface IntegrationOptions

Language	Type name
.NET	`Amazon.CDK.AWS.APIGateway.IntegrationOptions`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#IntegrationOptions`
Java	`software.amazon.awscdk.services.apigateway.IntegrationOptions`
Python	`aws_cdk.aws_apigateway.IntegrationOptions`
TypeScript (source)	`aws-cdk-lib` » `aws_apigateway` » `IntegrationOptions`

Example

import * as path from 'path';
import * as lambda from '../../../aws-lambda';
import { App, Stack } from '../../../core';
import { MockIntegration, PassthroughBehavior, RestApi, RequestAuthorizer, IdentitySource } from '../../lib';

// Against the RestApi endpoint from the stack output, run
// `curl -s -o /dev/null -w "%{http_code}" <url>` should return 401
// `curl -s -o /dev/null -w "%{http_code}" -H 'Authorization: deny' <url>?allow=yes` should return 403
// `curl -s -o /dev/null -w "%{http_code}" -H 'Authorization: allow' <url>?allow=yes` should return 200

const app = new App();
const stack = new Stack(app, 'RequestAuthorizerInteg');

const authorizerFn = new lambda.Function(stack, 'MyAuthorizerFunction', {
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.AssetCode.fromAsset(path.join(__dirname, 'integ.request-authorizer.handler')),
});

const restapi = new RestApi(stack, 'MyRestApi', { cloudWatchRole: true });

const authorizer = new RequestAuthorizer(stack, 'MyAuthorizer', {
  handler: authorizerFn,
  identitySources: [IdentitySource.header('Authorization'), IdentitySource.queryString('allow')],
});

const secondAuthorizer = new RequestAuthorizer(stack, 'MySecondAuthorizer', {
  handler: authorizerFn,
  identitySources: [IdentitySource.header('Authorization'), IdentitySource.queryString('allow')],
});

restapi.root.addMethod('ANY', new MockIntegration({
  integrationResponses: [
    { statusCode: '200' },
  ],
  passthroughBehavior: PassthroughBehavior.NEVER,
  requestTemplates: {
    'application/json': '{ "statusCode": 200 }',
  },
}), {
  methodResponses: [
    { statusCode: '200' },
  ],
  authorizer,
});

restapi.root.resourceForPath('auth').addMethod('ANY', new MockIntegration({
  integrationResponses: [
    { statusCode: '200' },
  ],
  passthroughBehavior: PassthroughBehavior.NEVER,
  requestTemplates: {
    'application/json': '{ "statusCode": 200 }',
  },
}), {
  methodResponses: [
    { statusCode: '200' },
  ],
  authorizer: secondAuthorizer,
});

Properties

Name	Type	Description
cacheKeyParameters?	`string[]`	A list of request parameters whose values are to be cached.
cacheNamespace?	`string`	An API-specific tag group of related cached parameters.
connectionType?	`ConnectionType`	The type of network connection to the integration endpoint.
contentHandling?	`ContentHandling`	Specifies how to handle request payload content type conversions.
credentialsPassthrough?	`boolean`	Requires that the caller's identity be passed through from the request.
credentialsRole?	`IRole`	An IAM role that API Gateway assumes.
integrationResponses?	`IntegrationResponse[]`	The response that API Gateway provides after a method's backend completes processing a request.
passthroughBehavior?	`PassthroughBehavior`	Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
requestParameters?	`{ [string]: string }`	The request parameters that API Gateway sends with the backend request.
requestTemplates?	`{ [string]: string }`	A map of Apache Velocity templates that are applied on the request payload.
timeout?	`Duration`	The maximum amount of time an integration will run before it returns without a response.
vpcLink?	`IVpcLink`	The VpcLink used for the integration.

cacheKeyParameters?

Type: string[] (optional)

A list of request parameters whose values are to be cached.

It determines request parameters that will make it into the cache key.

cacheNamespace?

Type: string (optional)

An API-specific tag group of related cached parameters.

connectionType?

Type: ConnectionType (optional, default: ConnectionType.VPC_LINK if vpcLink property is configured; ConnectionType.Internet otherwise.)

The type of network connection to the integration endpoint.

contentHandling?

Type: ContentHandling (optional, default: none if this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the passthroughBehaviors property is configured to support payload pass-through.)

Specifies how to handle request payload content type conversions.

credentialsPassthrough?

Type: boolean (optional, default: Caller identity is not passed through)

Requires that the caller's identity be passed through from the request.

credentialsRole?

Type: IRole (optional, default: A role is not assumed)

An IAM role that API Gateway assumes.

Mutually exclusive with credentialsPassThrough.

integrationResponses?

Type: IntegrationResponse[] (optional)

The response that API Gateway provides after a method's backend completes processing a request.

API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.

passthroughBehavior?

Type: PassthroughBehavior (optional)

Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.

There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

requestParameters?

Type: { [string]: string } (optional)

The request parameters that API Gateway sends with the backend request.

Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.

Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.

The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.

requestTemplates?

Type: { [string]: string } (optional)

A map of Apache Velocity templates that are applied on the request payload.

The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:

  { "application/json": "{ \"statusCode\": 200 }" }

timeout?

Type: Duration (optional, default: Duration.seconds(29))

The maximum amount of time an integration will run before it returns without a response.

By default, the value must be between 50 milliseconds and 29 seconds. The upper bound can be increased for regional and private Rest APIs only, via a quota increase request for your acccount. This increase might require a reduction in your account-level throttle quota limit.

See {@link https://docs.aws.amazon.com/apigateway/latest/developerguide/limits.html Amazon API Gateway quotas} for more details.

vpcLink?

Type: IVpcLink (optional)

The VpcLink used for the integration.

Required if connectionType is VPC_LINK