interface HttpIntegrationProps 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.APIGatewayv2.HttpIntegrationProps`
Java	`software.amazon.awscdk.services.apigatewayv2.HttpIntegrationProps`
Python	`aws_cdk.aws_apigatewayv2.HttpIntegrationProps`
TypeScript (source)	`@aws-cdk/aws-apigatewayv2` » `HttpIntegrationProps`

The integration properties.

Example

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

declare const httpApi: apigatewayv2.HttpApi;
declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpIntegrationProps: apigatewayv2.HttpIntegrationProps = {
  httpApi: httpApi,
  integrationType: apigatewayv2.HttpIntegrationType.HTTP_PROXY,

  // the properties below are optional
  connectionId: 'connectionId',
  connectionType: apigatewayv2.HttpConnectionType.VPC_LINK,
  credentials: integrationCredentials,
  integrationSubtype: apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
  integrationUri: 'integrationUri',
  method: apigatewayv2.HttpMethod.ANY,
  parameterMapping: parameterMapping,
  payloadFormatVersion: payloadFormatVersion,
  secureServerName: 'secureServerName',
};

Properties

Name	Type	Description
httpApi🔹	`IHttpApi`	The HTTP API to which this integration should be bound.
integrationType🔹	`HttpIntegrationType`	Integration type.
connectionId?🔹	`string`	The ID of the VPC link for a private integration.
connectionType?🔹	`HttpConnectionType`	The type of the network connection to the integration endpoint.
credentials?🔹	`IntegrationCredentials`	The credentials with which to invoke the integration.
integrationSubtype?🔹	`HttpIntegrationSubtype`	Integration subtype.
integrationUri?🔹	`string`	Integration URI.
method?🔹	`HttpMethod`	The HTTP method to use when calling the underlying HTTP proxy.
parameterMapping?🔹	`ParameterMapping`	Specifies how to transform HTTP requests before sending them to the backend.
payloadFormatVersion?🔹	`PayloadFormatVersion`	The version of the payload format.
secureServerName?🔹	`string`	Specifies the TLS configuration for a private integration.

httpApi🔹

Type: IHttpApi

The HTTP API to which this integration should be bound.

integrationType🔹

Type: HttpIntegrationType

Integration type.

connectionId?🔹

Type: string (optional, default: undefined)

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

connectionType?🔹

Type: HttpConnectionType (optional, default: HttpConnectionType.INTERNET)

The type of the network connection to the integration endpoint.

credentials?🔹

Type: IntegrationCredentials (optional, default: no credentials, use resource-based permissions on supported AWS services)

The credentials with which to invoke the integration.

integrationSubtype?🔹

Type: HttpIntegrationSubtype (optional, default: none, required if no integrationUri is defined.)

Integration subtype.

Used for AWS Service integrations, specifies the target of the integration.

integrationUri?🔹

Type: string (optional, default: none, required if no integrationSubtype is defined.)

Integration URI.

This will be the function ARN in the case of HttpIntegrationType.AWS_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.

method?🔹

Type: HttpMethod (optional, default: none. required if the integration type is HttpIntegrationType.HTTP_PROXY.)

The HTTP method to use when calling the underlying HTTP proxy.

parameterMapping?🔹

Type: ParameterMapping (optional, default: undefined requests are sent to the backend unmodified)

Specifies how to transform HTTP requests before sending them to the backend.

payloadFormatVersion?🔹

Type: PayloadFormatVersion (optional, default: defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.)

The version of the payload format.

secureServerName?🔹

Type: string (optional, default: undefined private integration traffic will use HTTP protocol)

Specifies the TLS configuration for a private integration.