HttpIntegration
The integration for an API route.
Import
import { HttpIntegration } from 'aws-cdk-lib/aws-apigatewayv2';Or use the module namespace:
import * as apigatewayv2 from 'aws-cdk-lib/aws-apigatewayv2';
// apigatewayv2.HttpIntegrationProperties
Configuration passed to the constructor as HttpIntegrationProps.
httpApiRequiredIHttpApiRefThe HTTP API to which this integration should be bound.
integrationTypeRequiredHttpIntegrationTypeIntegration type.
connectionIdOptionalstringThe ID of the VPC link for a private integration. Supported only for HTTP APIs.
Default: - undefined
connectionTypeOptionalHttpConnectionTypeThe type of the network connection to the integration endpoint.
Default: HttpConnectionType.INTERNET
credentialsOptionalIntegrationCredentialsThe credentials with which to invoke the integration.
Default: - no credentials, use resource-based permissions on supported AWS services
integrationSubtypeOptionalHttpIntegrationSubtypeIntegration subtype. Used for AWS Service integrations, specifies the target of the integration.
Default: - none, required if no `integrationUri` is defined.
integrationUriOptionalstringIntegration URI. This will be the function ARN in the case of `HttpIntegrationType.AWS_PROXY`, or HTTP URL in the case of `HttpIntegrationType.HTTP_PROXY`.
Default: - none, required if no `integrationSubtype` is defined.
methodOptionalHttpMethodThe HTTP method to use when calling the underlying HTTP proxy.
Default: - none. required if the integration type is `HttpIntegrationType.HTTP_PROXY`.
parameterMappingOptionalParameterMappingSpecifies how to transform HTTP requests before sending them to the backend.
Default: undefined requests are sent to the backend unmodified
payloadFormatVersionOptionalPayloadFormatVersionThe version of the payload format.
Default: - defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.
secureServerNameOptionalstringSpecifies the TLS configuration for a private integration.
Default: undefined private integration traffic will use HTTP protocol
timeoutOptionalDurationThe maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds.
Default: Duration.seconds(29)
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-apigatewayv2