Package software.amazon.awscdk.services.apigatewayv2

Interface HttpRouteIntegrationConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpRouteIntegrationConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:24:54.119Z")
@Stability(Stable)
public interface HttpRouteIntegrationConfig
extends software.amazon.jsii.JsiiSerializable

Config returned back as a result of the bind.

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.*;
 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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpRouteIntegrationConfig.Builder	builder()
default String	getConnectionId()	The ID of the VPC link for a private integration.
default HttpConnectionType	getConnectionType()	The type of the network connection to the integration endpoint.
default IntegrationCredentials	getCredentials()	The credentials with which to invoke the integration.
default HttpMethod	getMethod()	The HTTP method that must be used to invoke the underlying proxy.
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
PayloadFormatVersion	getPayloadFormatVersion()	Payload format version in the case of lambda proxy integration.
default String	getSecureServerName()	Specifies the server name to verified by HTTPS when calling the backend integration.
default HttpIntegrationSubtype	getSubtype()	Integration subtype.
default Duration	getTimeout()	The maximum amount of time an integration will run before it returns without a response.
HttpIntegrationType	getType()	Integration type.
default String	getUri()	Integration URI.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPayloadFormatVersion

@Stability(Stable)
@NotNull
PayloadFormatVersion getPayloadFormatVersion()

Payload format version in the case of lambda proxy integration.

Default: - undefined

See Also:

• https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html

getType

@Stability(Stable)
@NotNull
HttpIntegrationType getType()

Integration type.

getConnectionId

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

The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

Default: - undefined

getConnectionType

@Stability(Stable)
@Nullable
default HttpConnectionType getConnectionType()

The type of the network connection to the integration endpoint.

Default: HttpConnectionType.INTERNET

getCredentials

@Stability(Stable)
@Nullable
default IntegrationCredentials getCredentials()

The credentials with which to invoke the integration.

Default: - no credentials, use resource-based permissions on supported AWS services

getMethod

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

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

Required for HttpIntegrationType.HTTP_PROXY

Default: - undefined

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

getSubtype

@Stability(Stable)
@Nullable
default HttpIntegrationSubtype getSubtype()

Integration subtype.

Default: - none, required if no `integrationUri` is defined.

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)

getUri

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

Integration URI.

Default: - none, required if no `integrationSubtype` is defined.

builder

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

Returns:

a HttpRouteIntegrationConfig.Builder of HttpRouteIntegrationConfig