Package software.amazon.awscdk.services.apigatewayv2

Class HttpIntegrationProps.Builder

java.lang.Object

software.amazon.awscdk.services.apigatewayv2.HttpIntegrationProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<HttpIntegrationProps>

Enclosing interface:

HttpIntegrationProps

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

A builder for HttpIntegrationProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HttpIntegrationProps	build()	Builds the configured instance.
HttpIntegrationProps.Builder	connectionId(String connectionId)	Sets the value of HttpIntegrationProps.getConnectionId()
HttpIntegrationProps.Builder	connectionType(HttpConnectionType connectionType)	Sets the value of HttpIntegrationProps.getConnectionType()
HttpIntegrationProps.Builder	credentials(IntegrationCredentials credentials)	Sets the value of HttpIntegrationProps.getCredentials()
HttpIntegrationProps.Builder	httpApi(IHttpApi httpApi)	Sets the value of HttpIntegrationProps.getHttpApi()
HttpIntegrationProps.Builder	integrationSubtype(HttpIntegrationSubtype integrationSubtype)	Sets the value of HttpIntegrationProps.getIntegrationSubtype()
HttpIntegrationProps.Builder	integrationType(HttpIntegrationType integrationType)	Sets the value of HttpIntegrationProps.getIntegrationType()
HttpIntegrationProps.Builder	integrationUri(String integrationUri)	Sets the value of HttpIntegrationProps.getIntegrationUri()
HttpIntegrationProps.Builder	method(HttpMethod method)	Sets the value of HttpIntegrationProps.getMethod()
HttpIntegrationProps.Builder	parameterMapping(ParameterMapping parameterMapping)	Sets the value of HttpIntegrationProps.getParameterMapping()
HttpIntegrationProps.Builder	payloadFormatVersion(PayloadFormatVersion payloadFormatVersion)	Sets the value of HttpIntegrationProps.getPayloadFormatVersion()
HttpIntegrationProps.Builder	secureServerName(String secureServerName)	Sets the value of HttpIntegrationProps.getSecureServerName()
HttpIntegrationProps.Builder	timeout(Duration timeout)	Sets the value of HttpIntegrationProps.getTimeout()

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

httpApi

@Stability(Stable)
public HttpIntegrationProps.Builder httpApi(IHttpApi httpApi)

Sets the value of HttpIntegrationProps.getHttpApi()

Parameters:

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

Returns:

this

integrationType

@Stability(Stable)
public HttpIntegrationProps.Builder integrationType(HttpIntegrationType integrationType)

Sets the value of HttpIntegrationProps.getIntegrationType()

Parameters:

integrationType - Integration type. This parameter is required.

Returns:

this

connectionId

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

Sets the value of HttpIntegrationProps.getConnectionId()

Parameters:

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

Returns:

this

connectionType

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

Sets the value of HttpIntegrationProps.getConnectionType()

Parameters:

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

Returns:

this

credentials

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

Sets the value of HttpIntegrationProps.getCredentials()

Parameters:

credentials - The credentials with which to invoke the integration.

Returns:

this

integrationSubtype

@Stability(Stable)
public HttpIntegrationProps.Builder integrationSubtype(HttpIntegrationSubtype integrationSubtype)

Sets the value of HttpIntegrationProps.getIntegrationSubtype()

Parameters:

integrationSubtype - Integration subtype. Used for AWS Service integrations, specifies the target of the integration.

Returns:

this

integrationUri

@Stability(Stable)
public HttpIntegrationProps.Builder integrationUri(String integrationUri)

Sets the value of HttpIntegrationProps.getIntegrationUri()

Parameters:

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.

Returns:

this

method

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

Sets the value of HttpIntegrationProps.getMethod()

Parameters:

method - The HTTP method to use when calling the underlying HTTP proxy.

Returns:

this

parameterMapping

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

Sets the value of HttpIntegrationProps.getParameterMapping()

Parameters:

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

Returns:

this

payloadFormatVersion

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

Sets the value of HttpIntegrationProps.getPayloadFormatVersion()

Parameters:

payloadFormatVersion - The version of the payload format.

Returns:

this

secureServerName

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

Sets the value of HttpIntegrationProps.getSecureServerName()

Parameters:

secureServerName - Specifies the TLS configuration for a private integration.

Returns:

this

timeout

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

Sets the value of HttpIntegrationProps.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

build

@Stability(Stable)
public HttpIntegrationProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of HttpIntegrationProps

Throws:

NullPointerException - if any required attribute was not provided