interface HttpIntegrationProps

Language	Type name
.NET	Amazon.CDK.AWS.APIGateway.HttpIntegrationProps
Java	software.amazon.awscdk.services.apigateway.HttpIntegrationProps
Python	aws_cdk.aws_apigateway.HttpIntegrationProps
TypeScript (source)	@aws-cdk/aws-apigateway » HttpIntegrationProps

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as apigateway from '@aws-cdk/aws-apigateway';
import * as iam from '@aws-cdk/aws-iam';
import * as cdk from '@aws-cdk/core';

declare const role: iam.Role;
declare const vpcLink: apigateway.VpcLink;
const httpIntegrationProps: apigateway.HttpIntegrationProps = {
  httpMethod: 'httpMethod',
  options: {
    cacheKeyParameters: ['cacheKeyParameters'],
    cacheNamespace: 'cacheNamespace',
    connectionType: apigateway.ConnectionType.INTERNET,
    contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,
    credentialsPassthrough: false,
    credentialsRole: role,
    integrationResponses: [{
      statusCode: 'statusCode',

      // the properties below are optional
      contentHandling: apigateway.ContentHandling.CONVERT_TO_BINARY,
      responseParameters: {
        responseParametersKey: 'responseParameters',
      },
      responseTemplates: {
        responseTemplatesKey: 'responseTemplates',
      },
      selectionPattern: 'selectionPattern',
    }],
    passthroughBehavior: apigateway.PassthroughBehavior.WHEN_NO_MATCH,
    requestParameters: {
      requestParametersKey: 'requestParameters',
    },
    requestTemplates: {
      requestTemplatesKey: 'requestTemplates',
    },
    timeout: cdk.Duration.minutes(30),
    vpcLink: vpcLink,
  },
  proxy: false,
};

Properties

Name	Type	Description
httpMethod?	string	HTTP method to use when invoking the backend URL.
options?	IntegrationOptions	Integration options, such as request/resopnse mapping, content handling, etc.
proxy?	boolean	Determines whether to use proxy integration or custom integration.

---

httpMethod?

Type: string (optional, default: GET)

HTTP method to use when invoking the backend URL.

---

options?

Type: IntegrationOptions (optional, default: defaults based on IntegrationOptions defaults)

Integration options, such as request/resopnse mapping, content handling, etc.

---

proxy?

Type: boolean (optional, default: true)

Determines whether to use proxy integration or custom integration.