Package software.amazon.awscdk.aws_apigatewayv2_integrations

Interface HttpPrivateIntegrationOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

HttpAlbIntegrationProps, HttpNlbIntegrationProps, HttpServiceDiscoveryIntegrationProps

All Known Implementing Classes:

HttpAlbIntegrationProps.Jsii$Proxy, HttpNlbIntegrationProps.Jsii$Proxy, HttpPrivateIntegrationOptions.Jsii$Proxy, HttpServiceDiscoveryIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)",
           date="2025-12-18T18:20:04.449Z")
@Stability(Stable)
public interface HttpPrivateIntegrationOptions
extends software.amazon.jsii.JsiiSerializable

Base options for private integration.

Example:

 // 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.*;
 import software.amazon.awscdk.aws_apigatewayv2_integrations.*;
 ParameterMapping parameterMapping;
 VpcLink vpcLink;
 HttpPrivateIntegrationOptions httpPrivateIntegrationOptions = HttpPrivateIntegrationOptions.builder()
         .method(HttpMethod.ANY)
         .parameterMapping(parameterMapping)
         .secureServerName("secureServerName")
         .timeout(Duration.minutes(30))
         .vpcLink(vpcLink)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	HttpPrivateIntegrationOptions.Builder	A builder for HttpPrivateIntegrationOptions
static final class	HttpPrivateIntegrationOptions.Jsii$Proxy	An implementation for HttpPrivateIntegrationOptions

Method Summary

Modifier and Type	Method	Description
static HttpPrivateIntegrationOptions.Builder	builder()
default HttpMethod	getMethod()	The HTTP method that must be used to invoke the underlying HTTP proxy.
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
default String	getSecureServerName()	Specifies the server name to verified by HTTPS when calling the backend integration.
default Duration	getTimeout()	The maximum amount of time an integration will run before it returns without a response.
default IVpcLink	getVpcLink()	The vpc link to be used for the private integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMethod

@Stability(Stable)
@Nullable
default HttpMethod getMethod()

The HTTP method that must be used to invoke the underlying HTTP proxy.

Default: HttpMethod.ANY

getParameterMapping

@Stability(Stable)
@Nullable
default ParameterMapping getParameterMapping()

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

Default: undefined requests are sent to the backend unmodified

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-parameter-mapping.html

getSecureServerName

@Stability(Stable)
@Nullable
default String getSecureServerName()

Specifies the server name to verified by HTTPS when calling the backend integration.

Default: undefined private integration traffic will use HTTP protocol

See Also:

• https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apigatewayv2-integration-tlsconfig.html

getTimeout

@Stability(Stable)
@Nullable
default Duration getTimeout()

The 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)

getVpcLink

@Stability(Stable)
@Nullable
default IVpcLink getVpcLink()

The vpc link to be used for the private integration.

Default: - a new VpcLink is created

builder

@Stability(Stable)
static HttpPrivateIntegrationOptions.Builder builder()

Returns:

a HttpPrivateIntegrationOptions.Builder of HttpPrivateIntegrationOptions