Package software.amazon.awscdk.services.apigateway

Class HttpIntegration.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.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 Summary

Modifier and Type	Method	Description
HttpIntegration	build()
static HttpIntegration.Builder	create(String url)
HttpIntegration.Builder	httpMethod(String httpMethod)	HTTP method to use when invoking the backend URL.
HttpIntegration.Builder	options(IntegrationOptions options)	Integration options, such as request/resopnse mapping, content handling, etc.
HttpIntegration.Builder	proxy(Boolean proxy)	Determines whether to use proxy integration or custom integration.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static HttpIntegration.Builder create(String url)

Parameters:

url - This parameter is required.

Returns:

a new instance of HttpIntegration.Builder.

httpMethod

@Stability(Stable)
public HttpIntegration.Builder httpMethod(String httpMethod)

HTTP method to use when invoking the backend URL.

Default: GET

Parameters:

httpMethod - HTTP method to use when invoking the backend URL. This parameter is required.

Returns:

this

options

@Stability(Stable)
public HttpIntegration.Builder options(IntegrationOptions options)

Integration options, such as request/resopnse mapping, content handling, etc.

Default: defaults based on `IntegrationOptions` defaults

Parameters:

options - Integration options, such as request/resopnse mapping, content handling, etc. This parameter is required.

Returns:

this

proxy

@Stability(Stable)
public HttpIntegration.Builder proxy(Boolean proxy)

Determines whether to use proxy integration or custom integration.

Default: true

Parameters:

proxy - Determines whether to use proxy integration or custom integration. 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.