Package software.amazon.awscdk.services.apigatewayv2

Class HttpRouteIntegrationConfig.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpRouteIntegrationConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpRouteIntegrationConfig>

Enclosing interface:

HttpRouteIntegrationConfig

@Stability(Stable)
public static final class HttpRouteIntegrationConfig.Builder
extends Object
implements software.amazon.jsii.Builder<HttpRouteIntegrationConfig>

A builder for HttpRouteIntegrationConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpRouteIntegrationConfig	build()	Builds the configured instance.
HttpRouteIntegrationConfig.Builder	connectionId(String connectionId)	Sets the value of HttpRouteIntegrationConfig.getConnectionId()
HttpRouteIntegrationConfig.Builder	connectionType(HttpConnectionType connectionType)	Sets the value of HttpRouteIntegrationConfig.getConnectionType()
HttpRouteIntegrationConfig.Builder	credentials(IntegrationCredentials credentials)	Sets the value of HttpRouteIntegrationConfig.getCredentials()
HttpRouteIntegrationConfig.Builder	method(HttpMethod method)	Sets the value of HttpRouteIntegrationConfig.getMethod()
HttpRouteIntegrationConfig.Builder	parameterMapping(ParameterMapping parameterMapping)	Sets the value of HttpRouteIntegrationConfig.getParameterMapping()
HttpRouteIntegrationConfig.Builder	payloadFormatVersion(PayloadFormatVersion payloadFormatVersion)	Sets the value of HttpRouteIntegrationConfig.getPayloadFormatVersion()
HttpRouteIntegrationConfig.Builder	secureServerName(String secureServerName)	Sets the value of HttpRouteIntegrationConfig.getSecureServerName()
HttpRouteIntegrationConfig.Builder	subtype(HttpIntegrationSubtype subtype)	Sets the value of HttpRouteIntegrationConfig.getSubtype()
HttpRouteIntegrationConfig.Builder	timeout(Duration timeout)	Sets the value of HttpRouteIntegrationConfig.getTimeout()
HttpRouteIntegrationConfig.Builder	type(HttpIntegrationType type)	Sets the value of HttpRouteIntegrationConfig.getType()
HttpRouteIntegrationConfig.Builder	uri(String uri)	Sets the value of HttpRouteIntegrationConfig.getUri()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

payloadFormatVersion

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder payloadFormatVersion(PayloadFormatVersion payloadFormatVersion)

Sets the value of HttpRouteIntegrationConfig.getPayloadFormatVersion()

Parameters:

payloadFormatVersion - Payload format version in the case of lambda proxy integration. This parameter is required.

Returns:

this

type

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder type(HttpIntegrationType type)

Sets the value of HttpRouteIntegrationConfig.getType()

Parameters:

type - Integration type. This parameter is required.

Returns:

this

connectionId

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder connectionId(String connectionId)

Sets the value of HttpRouteIntegrationConfig.getConnectionId()

Parameters:

connectionId - The ID of the VPC link for a private integration. Supported only for HTTP APIs.

Returns:

this

connectionType

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder connectionType(HttpConnectionType connectionType)

Sets the value of HttpRouteIntegrationConfig.getConnectionType()

Parameters:

connectionType - The type of the network connection to the integration endpoint.

Returns:

this

credentials

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder credentials(IntegrationCredentials credentials)

Sets the value of HttpRouteIntegrationConfig.getCredentials()

Parameters:

credentials - The credentials with which to invoke the integration.

Returns:

this

method

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder method(HttpMethod method)

Sets the value of HttpRouteIntegrationConfig.getMethod()

Parameters:

method - The HTTP method that must be used to invoke the underlying proxy. Required for HttpIntegrationType.HTTP_PROXY

Returns:

this

parameterMapping

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder parameterMapping(ParameterMapping parameterMapping)

Sets the value of HttpRouteIntegrationConfig.getParameterMapping()

Parameters:

parameterMapping - Specifies how to transform HTTP requests before sending them to the backend.

Returns:

this

secureServerName

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder secureServerName(String secureServerName)

Sets the value of HttpRouteIntegrationConfig.getSecureServerName()

Parameters:

secureServerName - Specifies the server name to verified by HTTPS when calling the backend integration.

Returns:

this

subtype

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder subtype(HttpIntegrationSubtype subtype)

Sets the value of HttpRouteIntegrationConfig.getSubtype()

Parameters:

subtype - Integration subtype.

Returns:

this

timeout

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder timeout(Duration timeout)

Sets the value of HttpRouteIntegrationConfig.getTimeout()

Parameters:

timeout - The maximum amount of time an integration will run before it returns without a response. Must be between 50 milliseconds and 29 seconds.

Returns:

this

uri

@Stability(Stable)
public HttpRouteIntegrationConfig.Builder uri(String uri)

Sets the value of HttpRouteIntegrationConfig.getUri()

Parameters:

uri - Integration URI.

Returns:

this

build

@Stability(Stable)
public HttpRouteIntegrationConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpRouteIntegrationConfig

Throws:

NullPointerException - if any required attribute was not provided