2.169.0

enum IntegrationType

LanguageType name
.NETAmazon.CDK.AWS.APIGateway.IntegrationType
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsapigateway#IntegrationType
Javasoftware.amazon.awscdk.services.apigateway.IntegrationType
Pythonaws_cdk.aws_apigateway.IntegrationType
TypeScript (source)aws-cdk-lib » aws_apigateway » IntegrationType

Example

import * as elbv2 from 'aws-cdk-lib/aws-elasticloadbalancingv2';

const vpc = new ec2.Vpc(this, 'VPC');
const nlb = new elbv2.NetworkLoadBalancer(this, 'NLB', {
  vpc,
});
const link = new apigateway.VpcLink(this, 'link', {
  targets: [nlb],
});

const integration = new apigateway.Integration({
  type: apigateway.IntegrationType.HTTP_PROXY,
  integrationHttpMethod: 'ANY',
  options: {
    connectionType: apigateway.ConnectionType.VPC_LINK,
    vpcLink: link,
  },
});

Members

NameDescription
AWSFor integrating the API method request with an AWS service action, including the Lambda function-invoking action.
AWS_PROXYFor integrating the API method request with the Lambda function-invoking action with the client request passed through as-is.
HTTPFor integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC.
HTTP_PROXYFor integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is.
MOCKFor integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

AWS

For integrating the API method request with an AWS service action, including the Lambda function-invoking action.

With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration.

AWS_PROXY

For integrating the API method request with the Lambda function-invoking action with the client request passed through as-is.

This integration is also referred to as the Lambda proxy integration

HTTP

For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC.

This integration is also referred to as the HTTP custom integration.

HTTP_PROXY

For integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is.

This is also referred to as the HTTP proxy integration

MOCK

For integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend.

← PreviousNext →