software.amazon.awscdk.services.apigatewayv2.alpha

Class HttpIntegration.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.alpha.HttpIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpIntegration>

Enclosing class:

HttpIntegration

@Stability(value=Experimental)
public static final class HttpIntegration.Builder
extends Object
implements software.amazon.jsii.Builder<HttpIntegration>

(experimental) A fluent builder for HttpIntegration.

Method Summary

Modifier and Type	Method and Description
HttpIntegration	build()
HttpIntegration.Builder	connectionId(String connectionId) (experimental) The ID of the VPC link for a private integration.
HttpIntegration.Builder	connectionType(HttpConnectionType connectionType) (experimental) The type of the network connection to the integration endpoint.
static HttpIntegration.Builder	create(software.constructs.Construct scope, String id)
HttpIntegration.Builder	credentials(IntegrationCredentials credentials) (experimental) The credentials with which to invoke the integration.
HttpIntegration.Builder	httpApi(IHttpApi httpApi) (experimental) The HTTP API to which this integration should be bound.
HttpIntegration.Builder	integrationSubtype(HttpIntegrationSubtype integrationSubtype) (experimental) Integration subtype.
HttpIntegration.Builder	integrationType(HttpIntegrationType integrationType) (experimental) Integration type.
HttpIntegration.Builder	integrationUri(String integrationUri) (experimental) Integration URI.
HttpIntegration.Builder	method(HttpMethod method) (experimental) The HTTP method to use when calling the underlying HTTP proxy.
HttpIntegration.Builder	parameterMapping(ParameterMapping parameterMapping) (experimental) Specifies how to transform HTTP requests before sending them to the backend.
HttpIntegration.Builder	payloadFormatVersion(PayloadFormatVersion payloadFormatVersion) (experimental) The version of the payload format.
HttpIntegration.Builder	secureServerName(String secureServerName) (experimental) Specifies the TLS configuration for a private integration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
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(value=Experimental)
public HttpIntegration.Builder httpApi(IHttpApi httpApi)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder integrationType(HttpIntegrationType integrationType)

(experimental) Integration type.

Parameters:

integrationType - Integration type. This parameter is required.

Returns:

this

connectionId

@Stability(value=Experimental)
public HttpIntegration.Builder connectionId(String connectionId)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder connectionType(HttpConnectionType connectionType)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder credentials(IntegrationCredentials credentials)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder integrationSubtype(HttpIntegrationSubtype integrationSubtype)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder integrationUri(String integrationUri)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder method(HttpMethod method)

(experimental) 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(value=Experimental)
public HttpIntegration.Builder parameterMapping(ParameterMapping parameterMapping)

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

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

payloadFormatVersion

@Stability(value=Experimental)
public HttpIntegration.Builder payloadFormatVersion(PayloadFormatVersion payloadFormatVersion)

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

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

secureServerName

@Stability(value=Experimental)
public HttpIntegration.Builder secureServerName(String secureServerName)

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

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

build

@Stability(value=Experimental)
public HttpIntegration build()

Specified by:

build in interface software.amazon.jsii.Builder<HttpIntegration>