HttpRouteIntegrationConfig Struct
Config returned back as a result of the bind.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_apigatewayv2 as apigatewayv2 } from 'aws-cdk-lib';
declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpRouteIntegrationConfig: apigatewayv2.HttpRouteIntegrationConfig = {
payloadFormatVersion: payloadFormatVersion,
type: apigatewayv2.HttpIntegrationType.HTTP_PROXY,
// the properties below are optional
connectionId: 'connectionId',
connectionType: apigatewayv2.HttpConnectionType.VPC_LINK,
credentials: integrationCredentials,
method: apigatewayv2.HttpMethod.ANY,
parameterMapping: parameterMapping,
secureServerName: 'secureServerName',
subtype: apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
timeout: cdk.Duration.minutes(30),
uri: 'uri',
};
Properties
connectionIdoptionalstringconnection_idoptionalstrconnectionIdoptionalStringConnectionIdoptionalstringConnectionIdoptional*string= undefined#The ID of the VPC link for a private integration.
Supported only for HTTP APIs.
connectionTypeoptionalHttpConnectionTypeconnection_typeoptionalHttpConnectionTypeconnectionTypeoptionalHttpConnectionTypeConnectionTypeoptionalHttpConnectionTypeConnectionTypeoptionalHttpConnectionType= HttpConnectionType.INTERNET#The type of the network connection to the integration endpoint.
credentialsoptionalIntegrationCredentialscredentialsoptionalIntegrationCredentialscredentialsoptionalIntegrationCredentialsCredentialsoptionalIntegrationCredentialsCredentialsoptionalIntegrationCredentials#The credentials with which to invoke the integration.
Default: no credentials, use resource-based permissions on supported AWS services
methodoptionalHttpMethodmethodoptionalHttpMethodmethodoptionalHttpMethodMethodoptionalHttpMethodMethodoptionalHttpMethod= undefined#The HTTP method that must be used to invoke the underlying proxy.
Required for HttpIntegrationType.HTTP_PROXY
parameterMappingoptionalParameterMappingparameter_mappingoptionalParameterMappingparameterMappingoptionalParameterMappingParameterMappingoptionalParameterMappingParameterMappingoptionalParameterMapping#Specifies how to transform HTTP requests before sending them to the backend.
Default: undefined requests are sent to the backend unmodified
payloadFormatVersionPayloadFormatVersionpayload_format_versionPayloadFormatVersionpayloadFormatVersionPayloadFormatVersionPayloadFormatVersionPayloadFormatVersionPayloadFormatVersionPayloadFormatVersion= undefinedrequired#Payload format version in the case of lambda proxy integration.
secureServerNameoptionalstringsecure_server_nameoptionalstrsecureServerNameoptionalStringSecureServerNameoptionalstringSecureServerNameoptional*string#Specifies the server name to verified by HTTPS when calling the backend integration.
Default: undefined private integration traffic will use HTTP protocol
subtypeoptionalHttpIntegrationSubtypesubtypeoptionalHttpIntegrationSubtypesubtypeoptionalHttpIntegrationSubtypeSubtypeoptionalHttpIntegrationSubtypeSubtypeoptionalHttpIntegrationSubtype#Integration subtype.
Default: none, required if no integrationUri is defined.
timeoutoptionalDurationtimeoutoptionalDurationtimeoutoptionalDurationTimeoutoptionalDurationTimeoutoptionalDuration= Duration.seconds(29)#The maximum amount of time an integration will run before it returns without a response.
Must be between 50 milliseconds and 29 seconds.
typeHttpIntegrationTypetypeHttpIntegrationTypetypeHttpIntegrationTypeTypeHttpIntegrationTypeTypeHttpIntegrationTyperequired#Integration type.
Integration URI.
Default: none, required if no integrationSubtype is defined.