Package software.amazon.awscdk.services.apigatewayv2

Class HttpIntegration.Builder

java.lang.Object
software.amazon.awscdk.services.apigatewayv2.HttpIntegration.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<HttpIntegration>
Enclosing class:
HttpIntegration
@Stability(Stable) public static final class HttpIntegration.Builder extends Object implements software.amazon.jsii.Builder<HttpIntegration>
A fluent builder for HttpIntegration.

  • Method Details

    • create

      @Stability(Stable) public static HttpIntegration.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of HttpIntegration.Builder.

    • httpApi

      @Stability(Stable) public HttpIntegration.Builder httpApi(IHttpApi httpApi)
      The HTTP API to which this integration should be bound.

      Parameters:
      httpApi - The HTTP API to which this integration should be bound. This parameter is required.
      Returns:
      this

    • integrationType

      @Stability(Stable) public HttpIntegration.Builder integrationType(HttpIntegrationType integrationType)
      Integration type.

      Parameters:
      integrationType - Integration type. This parameter is required.
      Returns:
      this

    • connectionId

      @Stability(Stable) public HttpIntegration.Builder connectionId(String connectionId)
      The ID of the VPC link for a private integration.

      Supported only for HTTP APIs.

      Default: - undefined

      Parameters:
      connectionId - The ID of the VPC link for a private integration. This parameter is required.
      Returns:
      this

    • connectionType

      @Stability(Stable) public HttpIntegration.Builder connectionType(HttpConnectionType connectionType)
      The type of the network connection to the integration endpoint.

      Default: HttpConnectionType.INTERNET

      Parameters:
      connectionType - The type of the network connection to the integration endpoint. This parameter is required.
      Returns:
      this

    • credentials

      @Stability(Stable) public HttpIntegration.Builder credentials(IntegrationCredentials credentials)
      The credentials with which to invoke the integration.

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

      Parameters:
      credentials - The credentials with which to invoke the integration. This parameter is required.
      Returns:
      this

    • integrationSubtype

      @Stability(Stable) public HttpIntegration.Builder integrationSubtype(HttpIntegrationSubtype integrationSubtype)
      Integration subtype.

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

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

      Parameters:
      integrationSubtype - Integration subtype. This parameter is required.
      Returns:
      this

    • integrationUri

      @Stability(Stable) public HttpIntegration.Builder integrationUri(String integrationUri)
      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.

      Parameters:
      integrationUri - Integration URI. This parameter is required.
      Returns:
      this

    • method

      @Stability(Stable) public HttpIntegration.Builder method(HttpMethod method)
      The HTTP method to use when calling the underlying HTTP proxy.

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

      Parameters:
      method - The HTTP method to use when calling the underlying HTTP proxy. This parameter is required.
      Returns:
      this

    • parameterMapping

      @Stability(Stable) public HttpIntegration.Builder parameterMapping(ParameterMapping parameterMapping)
      Specifies how to transform HTTP requests before sending them to the backend.

      Default: undefined requests are sent to the backend unmodified

      Parameters:
      parameterMapping - Specifies how to transform HTTP requests before sending them to the backend. This parameter is required.
      Returns:
      this
      See Also:

    • payloadFormatVersion

      @Stability(Stable) public HttpIntegration.Builder payloadFormatVersion(PayloadFormatVersion payloadFormatVersion)
      The version of the payload format.

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

      Parameters:
      payloadFormatVersion - The version of the payload format. This parameter is required.
      Returns:
      this
      See Also:

    • secureServerName

      @Stability(Stable) public HttpIntegration.Builder secureServerName(String secureServerName)
      Specifies the TLS configuration for a private integration.

      Default: undefined private integration traffic will use HTTP protocol

      Parameters:
      secureServerName - Specifies the TLS configuration for a private integration. This parameter is required.
      Returns:
      this
      See Also:

    • timeout

      @Stability(Stable) public HttpIntegration.Builder timeout(Duration timeout)
      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)

      Parameters:
      timeout - The maximum amount of time an integration will run before it returns without a response. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public HttpIntegration build()
      Specified by:
      build in interface software.amazon.jsii.Builder<HttpIntegration>
      Returns:
      a newly built instance of HttpIntegration.