software.amazon.awscdk.services.apigateway

Class MockIntegration.Builder

java.lang.Object

software.amazon.awscdk.services.apigateway.MockIntegration.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MockIntegration>

Enclosing class:

MockIntegration

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

(experimental) A fluent builder for MockIntegration.

Method Summary

Modifier and Type	Method and Description
MockIntegration	build()
MockIntegration.Builder	cacheKeyParameters(List<String> cacheKeyParameters) (experimental) A list of request parameters whose values are to be cached.
MockIntegration.Builder	cacheNamespace(String cacheNamespace) (experimental) An API-specific tag group of related cached parameters.
MockIntegration.Builder	connectionType(ConnectionType connectionType) (experimental) The type of network connection to the integration endpoint.
MockIntegration.Builder	contentHandling(ContentHandling contentHandling) (experimental) Specifies how to handle request payload content type conversions.
static MockIntegration.Builder	create()
MockIntegration.Builder	credentialsPassthrough(Boolean credentialsPassthrough) (experimental) Requires that the caller's identity be passed through from the request.
MockIntegration.Builder	credentialsRole(IRole credentialsRole) (experimental) An IAM role that API Gateway assumes.
MockIntegration.Builder	integrationResponses(List<? extends IntegrationResponse> integrationResponses) (experimental) The response that API Gateway provides after a method's backend completes processing a request.
MockIntegration.Builder	passthroughBehavior(PassthroughBehavior passthroughBehavior) (experimental) Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.
MockIntegration.Builder	requestParameters(Map<String,String> requestParameters) (experimental) The request parameters that API Gateway sends with the backend request.
MockIntegration.Builder	requestTemplates(Map<String,String> requestTemplates) (experimental) A map of Apache Velocity templates that are applied on the request payload.
MockIntegration.Builder	timeout(Duration timeout) (experimental) The maximum amount of time an integration will run before it returns without a response.
MockIntegration.Builder	vpcLink(IVpcLink vpcLink) (experimental) The VpcLink used for the 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 MockIntegration.Builder create()

Returns:

a new instance of MockIntegration.Builder.

cacheKeyParameters

@Stability(value=Experimental)
public MockIntegration.Builder cacheKeyParameters(List<String> cacheKeyParameters)

(experimental) A list of request parameters whose values are to be cached.

It determines request parameters that will make it into the cache key.

Parameters:

cacheKeyParameters - A list of request parameters whose values are to be cached. This parameter is required.

Returns:

this

cacheNamespace

@Stability(value=Experimental)
public MockIntegration.Builder cacheNamespace(String cacheNamespace)

(experimental) An API-specific tag group of related cached parameters.

Parameters:

cacheNamespace - An API-specific tag group of related cached parameters. This parameter is required.

Returns:

this

connectionType

@Stability(value=Experimental)
public MockIntegration.Builder connectionType(ConnectionType connectionType)

(experimental) The type of network connection to the integration endpoint.

Default: - ConnectionType.VPC_LINK if `vpcLink` property is configured; ConnectionType.Internet otherwise.

Parameters:

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

Returns:

this

contentHandling

@Stability(value=Experimental)
public MockIntegration.Builder contentHandling(ContentHandling contentHandling)

(experimental) Specifies how to handle request payload content type conversions.

Default: none if this property isn't defined, the request payload is passed through from the method request to the integration request without modification, provided that the `passthroughBehaviors` property is configured to support payload pass-through.

Parameters:

contentHandling - Specifies how to handle request payload content type conversions. This parameter is required.

Returns:

this

credentialsPassthrough

@Stability(value=Experimental)
public MockIntegration.Builder credentialsPassthrough(Boolean credentialsPassthrough)

(experimental) Requires that the caller's identity be passed through from the request.

Default: Caller identity is not passed through

Parameters:

credentialsPassthrough - Requires that the caller's identity be passed through from the request. This parameter is required.

Returns:

this

credentialsRole

@Stability(value=Experimental)
public MockIntegration.Builder credentialsRole(IRole credentialsRole)

(experimental) An IAM role that API Gateway assumes.

Mutually exclusive with credentialsPassThrough.

Default: A role is not assumed

Parameters:

credentialsRole - An IAM role that API Gateway assumes. This parameter is required.

Returns:

this

integrationResponses

@Stability(value=Experimental)
public MockIntegration.Builder integrationResponses(List<? extends IntegrationResponse> integrationResponses)

(experimental) The response that API Gateway provides after a method's backend completes processing a request.

API Gateway intercepts the response from the backend so that you can control how API Gateway surfaces backend responses. For example, you can map the backend status codes to codes that you define.

Parameters:

integrationResponses - The response that API Gateway provides after a method's backend completes processing a request. This parameter is required.

Returns:

this

passthroughBehavior

@Stability(value=Experimental)
public MockIntegration.Builder passthroughBehavior(PassthroughBehavior passthroughBehavior)

(experimental) Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource.

There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

Parameters:

passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. This parameter is required.

Returns:

this

requestParameters

@Stability(value=Experimental)
public MockIntegration.Builder requestParameters(Map<String,String> requestParameters)

(experimental) The request parameters that API Gateway sends with the backend request.

Specify request parameters as key-value pairs (string-to-string mappings), with a destination as the key and a source as the value.

Specify the destination by using the following pattern integration.request.location.name, where location is querystring, path, or header, and name is a valid, unique parameter name.

The source must be an existing method request parameter or a static value. You must enclose static values in single quotation marks and pre-encode these values based on their destination in the request.

Parameters:

requestParameters - The request parameters that API Gateway sends with the backend request. This parameter is required.

Returns:

this

requestTemplates

@Stability(value=Experimental)
public MockIntegration.Builder requestTemplates(Map<String,String> requestTemplates)

(experimental) A map of Apache Velocity templates that are applied on the request payload.

The template that API Gateway uses is based on the value of the Content-Type header that's sent by the client. The content type value is the key, and the template is the value (specified as a string), such as the following snippet:

    { "application/json": "{ \"statusCode\": 200 }" }
 

Parameters:

requestTemplates - A map of Apache Velocity templates that are applied on the request payload. This parameter is required.

Returns:

this

See Also:

http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html

timeout

@Stability(value=Experimental)
public MockIntegration.Builder timeout(Duration timeout)

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

vpcLink

@Stability(value=Experimental)
public MockIntegration.Builder vpcLink(IVpcLink vpcLink)

(experimental) The VpcLink used for the integration.

Required if connectionType is VPC_LINK

Parameters:

vpcLink - The VpcLink used for the integration. This parameter is required.

Returns:

this

build

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

Specified by:

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