software.amazon.awscdk.services.apigatewayv2.alpha

Interface HttpIntegrationProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpIntegrationProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.39.0 (build 8af72c2)",
           date="2021-10-13T21:02:01.201Z")
 @Stability(value=Experimental)
public interface HttpIntegrationProps
extends software.amazon.jsii.JsiiSerializable

(experimental) The integration properties.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static HttpIntegrationProps.Builder	builder()
default String	getConnectionId() (experimental) The ID of the VPC link for a private integration.
default HttpConnectionType	getConnectionType() (experimental) The type of the network connection to the integration endpoint.
IHttpApi	getHttpApi() (experimental) The HTTP API to which this integration should be bound.
HttpIntegrationType	getIntegrationType() (experimental) Integration type.
String	getIntegrationUri() (experimental) Integration URI.
default HttpMethod	getMethod() (experimental) The HTTP method to use when calling the underlying HTTP proxy.
default PayloadFormatVersion	getPayloadFormatVersion() (experimental) The version of the payload format.
default String	getSecureServerName() (experimental) Specifies the TLS configuration for a private integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getHttpApi

@Stability(value=Experimental)
 @NotNull
IHttpApi getHttpApi()

(experimental) The HTTP API to which this integration should be bound.

getIntegrationType

@Stability(value=Experimental)
 @NotNull
HttpIntegrationType getIntegrationType()

(experimental) Integration type.

getIntegrationUri

@Stability(value=Experimental)
 @NotNull
String getIntegrationUri()

(experimental) Integration URI.

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

getConnectionId

@Stability(value=Experimental)
 @Nullable
default String getConnectionId()

(experimental) The ID of the VPC link for a private integration.

Supported only for HTTP APIs.

Default: - undefined

getConnectionType

@Stability(value=Experimental)
 @Nullable
default HttpConnectionType getConnectionType()

(experimental) The type of the network connection to the integration endpoint.

Default: HttpConnectionType.INTERNET

getMethod

@Stability(value=Experimental)
 @Nullable
default HttpMethod getMethod()

(experimental) The HTTP method to use when calling the underlying HTTP proxy.

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

getPayloadFormatVersion

@Stability(value=Experimental)
 @Nullable
default PayloadFormatVersion getPayloadFormatVersion()

(experimental) The version of the payload format.

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

See Also:

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

getSecureServerName

@Stability(value=Experimental)
 @Nullable
default String getSecureServerName()

(experimental) 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

builder

@Stability(value=Experimental)
static HttpIntegrationProps.Builder builder()

Returns:

a HttpIntegrationProps.Builder of HttpIntegrationProps