Skip to content
v2.278.0

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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_apigatewayv2 as apigatewayv2

# integration_credentials: apigatewayv2.IntegrationCredentials
# parameter_mapping: apigatewayv2.ParameterMapping
# payload_format_version: apigatewayv2.PayloadFormatVersion

http_route_integration_config = apigatewayv2.HttpRouteIntegrationConfig(
    payload_format_version=payload_format_version,
    type=apigatewayv2.HttpIntegrationType.HTTP_PROXY,

    # the properties below are optional
    connection_id="connectionId",
    connection_type=apigatewayv2.HttpConnectionType.VPC_LINK,
    credentials=integration_credentials,
    method=apigatewayv2.HttpMethod.ANY,
    parameter_mapping=parameter_mapping,
    secure_server_name="secureServerName",
    subtype=apigatewayv2.HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
    timeout=cdk.Duration.minutes(30),
    uri="uri"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.apigatewayv2.*;

IntegrationCredentials integrationCredentials;
ParameterMapping parameterMapping;
PayloadFormatVersion payloadFormatVersion;

HttpRouteIntegrationConfig httpRouteIntegrationConfig = HttpRouteIntegrationConfig.builder()
        .payloadFormatVersion(payloadFormatVersion)
        .type(HttpIntegrationType.HTTP_PROXY)

        // the properties below are optional
        .connectionId("connectionId")
        .connectionType(HttpConnectionType.VPC_LINK)
        .credentials(integrationCredentials)
        .method(HttpMethod.ANY)
        .parameterMapping(parameterMapping)
        .secureServerName("secureServerName")
        .subtype(HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS)
        .timeout(Duration.minutes(30))
        .uri("uri")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.Apigatewayv2;

IntegrationCredentials integrationCredentials;
ParameterMapping parameterMapping;
PayloadFormatVersion payloadFormatVersion;

var httpRouteIntegrationConfig = new HttpRouteIntegrationConfig {
    PayloadFormatVersion = payloadFormatVersion,
    Type = HttpIntegrationType.HTTP_PROXY,

    // the properties below are optional
    ConnectionId = "connectionId",
    ConnectionType = HttpConnectionType.VPC_LINK,
    Credentials = integrationCredentials,
    Method = HttpMethod.ANY,
    ParameterMapping = parameterMapping,
    SecureServerName = "secureServerName",
    Subtype = HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS,
    Timeout = Duration.Minutes(30),
    Uri = "uri"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"

var integrationCredentials IntegrationCredentials
var parameterMapping ParameterMapping
var payloadFormatVersion PayloadFormatVersion

httpRouteIntegrationConfig := &HttpRouteIntegrationConfig{
	PayloadFormatVersion: payloadFormatVersion,
	Type: awscdk.Aws_apigatewayv2.HttpIntegrationType_HTTP_PROXY,

	// the properties below are optional
	ConnectionId: jsii.String("connectionId"),
	ConnectionType: awscdk.*Aws_apigatewayv2.HttpConnectionType_VPC_LINK,
	Credentials: integrationCredentials,
	Method: awscdk.*Aws_apigatewayv2.HttpMethod_ANY,
	ParameterMapping: parameterMapping,
	SecureServerName: jsii.String("secureServerName"),
	Subtype: awscdk.*Aws_apigatewayv2.HttpIntegrationSubtype_EVENTBRIDGE_PUT_EVENTS,
	Timeout: cdk.Duration_Minutes(jsii.Number(30)),
	Uri: jsii.String("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 = undefined required #
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.

urioptionalstringurioptionalstrurioptionalStringUrioptionalstringUrioptional*string #
Integration URI.

Default: none, required if no integrationSubtype is defined.