HttpIntegrationProps Struct
The integration properties.
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 httpApiRef: apigatewayv2.IHttpApiRef;
declare const integrationCredentials: apigatewayv2.IntegrationCredentials;
declare const parameterMapping: apigatewayv2.ParameterMapping;
declare const payloadFormatVersion: apigatewayv2.PayloadFormatVersion;
const httpIntegrationProps: apigatewayv2.HttpIntegrationProps = {
httpApi: httpApiRef,
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',
timeout: cdk.Duration.minutes(30),
};
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
httpApiIHttpApiRefhttp_apiIHttpApiRefhttpApiIHttpApiRefHttpApiIHttpApiRefHttpApiIHttpApiRefrequired#The HTTP API to which this integration should be bound.
integrationSubtypeoptionalHttpIntegrationSubtypeintegration_subtypeoptionalHttpIntegrationSubtypeintegrationSubtypeoptionalHttpIntegrationSubtypeIntegrationSubtypeoptionalHttpIntegrationSubtypeIntegrationSubtypeoptionalHttpIntegrationSubtype#Integration subtype.
Default: none, required if no integrationUri is defined.
Used for AWS Service integrations, specifies the target of the integration.
integrationTypeHttpIntegrationTypeintegration_typeHttpIntegrationTypeintegrationTypeHttpIntegrationTypeIntegrationTypeHttpIntegrationTypeIntegrationTypeHttpIntegrationTyperequired#Integration type.
integrationUrioptionalstringintegration_urioptionalstrintegrationUrioptionalStringIntegrationUrioptionalstringIntegrationUrioptional*string#Integration URI.
Default: none, required if no integrationSubtype is defined.
This will be the function ARN in the case of HttpIntegrationType.AWS_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.
methodoptionalHttpMethodmethodoptionalHttpMethodmethodoptionalHttpMethodMethodoptionalHttpMethodMethodoptionalHttpMethod#The HTTP method to use when calling the underlying HTTP proxy.
Default: none. required if the integration type is 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
payloadFormatVersionoptionalPayloadFormatVersionpayload_format_versionoptionalPayloadFormatVersionpayloadFormatVersionoptionalPayloadFormatVersionPayloadFormatVersionoptionalPayloadFormatVersionPayloadFormatVersionoptionalPayloadFormatVersion#The version of the payload format.
Default: defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.
secureServerNameoptionalstringsecure_server_nameoptionalstrsecureServerNameoptionalStringSecureServerNameoptionalstringSecureServerNameoptional*string#Specifies the TLS configuration for a private integration.
Default: undefined private integration traffic will use HTTP protocol