Package software.amazon.awscdk.services.apigatewayv2

Interface HttpIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-09-06T01:36:22.871Z")
@Stability(Stable)
public interface HttpIntegrationProps
extends software.amazon.jsii.JsiiSerializable

The integration properties.

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.*;
 HttpApi httpApi;
 IntegrationCredentials integrationCredentials;
 ParameterMapping parameterMapping;
 PayloadFormatVersion payloadFormatVersion;
 HttpIntegrationProps httpIntegrationProps = HttpIntegrationProps.builder()
         .httpApi(httpApi)
         .integrationType(HttpIntegrationType.HTTP_PROXY)
         // the properties below are optional
         .connectionId("connectionId")
         .connectionType(HttpConnectionType.VPC_LINK)
         .credentials(integrationCredentials)
         .integrationSubtype(HttpIntegrationSubtype.EVENTBRIDGE_PUT_EVENTS)
         .integrationUri("integrationUri")
         .method(HttpMethod.ANY)
         .parameterMapping(parameterMapping)
         .payloadFormatVersion(payloadFormatVersion)
         .secureServerName("secureServerName")
         .timeout(Duration.minutes(30))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpIntegrationProps.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.
IHttpApi	getHttpApi()	The HTTP API to which this integration should be bound.
default HttpIntegrationSubtype	getIntegrationSubtype()	Integration subtype.
HttpIntegrationType	getIntegrationType()	Integration type.
default String	getIntegrationUri()	Integration URI.
default HttpMethod	getMethod()	The HTTP method to use when calling the underlying HTTP proxy.
default ParameterMapping	getParameterMapping()	Specifies how to transform HTTP requests before sending them to the backend.
default PayloadFormatVersion	getPayloadFormatVersion()	The version of the payload format.
default String	getSecureServerName()	Specifies the TLS configuration for a private integration.
default Duration	getTimeout()	The maximum amount of time an integration will run before it returns without a response.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getHttpApi

@Stability(Stable)
@NotNull
IHttpApi getHttpApi()

The HTTP API to which this integration should be bound.

getIntegrationType

@Stability(Stable)
@NotNull
HttpIntegrationType getIntegrationType()

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

getIntegrationSubtype

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

Integration subtype.

Used for AWS Service integrations, specifies the target of the integration.

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

getIntegrationUri

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

Integration URI.

This will be the function ARN in the case of HttpIntegrationType.AWS_PROXY, or HTTP URL in the case of HttpIntegrationType.HTTP_PROXY.

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

getMethod

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

The HTTP method to use when calling the underlying HTTP proxy.

Default: - none. required if the integration type is `HttpIntegrationType.HTTP_PROXY`.

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

getPayloadFormatVersion

@Stability(Stable)
@Nullable
default PayloadFormatVersion getPayloadFormatVersion()

The version of the payload format.

Default: - defaults to latest in the case of HttpIntegrationType.AWS_PROXY`, irrelevant otherwise.

See Also:

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

getSecureServerName

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

Specifies the TLS configuration for a private 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)

builder

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

Returns:

a HttpIntegrationProps.Builder of HttpIntegrationProps