software.amazon.awscdk.services.apigateway

Class LambdaIntegrationOptions.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions.Jsii$Proxy

All Implemented Interfaces:

IntegrationOptions, LambdaIntegrationOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:

LambdaIntegrationOptions

@Stability(value=Experimental)
 @Internal
public static final class LambdaIntegrationOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements LambdaIntegrationOptions

An implementation for LambdaIntegrationOptions

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions

LambdaIntegrationOptions.Builder, LambdaIntegrationOptions.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Jsii$Proxy(Boolean allowTestInvoke, Boolean proxy, List<String> cacheKeyParameters, String cacheNamespace, ConnectionType connectionType, ContentHandling contentHandling, Boolean credentialsPassthrough, IRole credentialsRole, List<? extends IntegrationResponse> integrationResponses, PassthroughBehavior passthroughBehavior, Map<String,String> requestParameters, Map<String,String> requestTemplates, Duration timeout, IVpcLink vpcLink) Constructor that initializes the object based on literal property values passed by the LambdaIntegrationOptions.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef) Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
Boolean	getAllowTestInvoke() (experimental) Allow invoking method from AWS Console UI (for testing purposes).
List<String>	getCacheKeyParameters() (experimental) A list of request parameters whose values are to be cached.
String	getCacheNamespace() (experimental) An API-specific tag group of related cached parameters.
ConnectionType	getConnectionType() (experimental) The type of network connection to the integration endpoint.
ContentHandling	getContentHandling() (experimental) Specifies how to handle request payload content type conversions.
Boolean	getCredentialsPassthrough() (experimental) Requires that the caller's identity be passed through from the request.
IRole	getCredentialsRole() (experimental) An IAM role that API Gateway assumes.
List<IntegrationResponse>	getIntegrationResponses() (experimental) The response that API Gateway provides after a method's backend completes processing a request.
PassthroughBehavior	getPassthroughBehavior() (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.
Boolean	getProxy() (experimental) Use proxy integration or normal (request/response mapping) integration.
Map<String,String>	getRequestParameters() (experimental) The request parameters that API Gateway sends with the backend request.
Map<String,String>	getRequestTemplates() (experimental) A map of Apache Velocity templates that are applied on the request payload.
Duration	getTimeout() (experimental) The maximum amount of time an integration will run before it returns without a response.
IVpcLink	getVpcLink() (experimental) The VpcLink used for the integration.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awscdk.services.apigateway.LambdaIntegrationOptions

builder

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(Boolean allowTestInvoke,
                     Boolean proxy,
                     List<String> cacheKeyParameters,
                     String cacheNamespace,
                     ConnectionType connectionType,
                     ContentHandling contentHandling,
                     Boolean credentialsPassthrough,
                     IRole credentialsRole,
                     List<? extends IntegrationResponse> integrationResponses,
                     PassthroughBehavior passthroughBehavior,
                     Map<String,String> requestParameters,
                     Map<String,String> requestTemplates,
                     Duration timeout,
                     IVpcLink vpcLink)

Constructor that initializes the object based on literal property values passed by the LambdaIntegrationOptions.Builder.

Method Detail

getAllowTestInvoke

public final Boolean getAllowTestInvoke()

Description copied from interface: LambdaIntegrationOptions

(experimental) Allow invoking method from AWS Console UI (for testing purposes).

This will add another permission to the AWS Lambda resource policy which will allow the test-invoke-stage stage to invoke this handler. If this is set to false, the function will only be usable from the deployment endpoint.

Default: true

Specified by:

getAllowTestInvoke in interface LambdaIntegrationOptions

getProxy

public final Boolean getProxy()

Description copied from interface: LambdaIntegrationOptions

(experimental) Use proxy integration or normal (request/response mapping) integration.

Default: true

Specified by:

getProxy in interface LambdaIntegrationOptions

See Also:

https://docs.aws.amazon.com/apigateway/latest/developerguide/set-up-lambda-proxy-integrations.html#api-gateway-simple-proxy-for-lambda-output-format

getCacheKeyParameters

public final List<String> getCacheKeyParameters()

Description copied from interface: IntegrationOptions

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

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

Specified by:

getCacheKeyParameters in interface IntegrationOptions

getCacheNamespace

public final String getCacheNamespace()

Description copied from interface: IntegrationOptions

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

Specified by:

getCacheNamespace in interface IntegrationOptions

getConnectionType

public final ConnectionType getConnectionType()

Description copied from interface: IntegrationOptions

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

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

Specified by:

getConnectionType in interface IntegrationOptions

getContentHandling

public final ContentHandling getContentHandling()

Description copied from interface: IntegrationOptions

(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.

Specified by:

getContentHandling in interface IntegrationOptions

getCredentialsPassthrough

public final Boolean getCredentialsPassthrough()

Description copied from interface: IntegrationOptions

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

Default: Caller identity is not passed through

Specified by:

getCredentialsPassthrough in interface IntegrationOptions

getCredentialsRole

public final IRole getCredentialsRole()

Description copied from interface: IntegrationOptions

(experimental) An IAM role that API Gateway assumes.

Mutually exclusive with credentialsPassThrough.

Default: A role is not assumed

Specified by:

getCredentialsRole in interface IntegrationOptions

getIntegrationResponses

public final List<IntegrationResponse> getIntegrationResponses()

Description copied from interface: IntegrationOptions

(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.

Specified by:

getIntegrationResponses in interface IntegrationOptions

getPassthroughBehavior

public final PassthroughBehavior getPassthroughBehavior()

Description copied from interface: IntegrationOptions

(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.

Specified by:

getPassthroughBehavior in interface IntegrationOptions

getRequestParameters

public final Map<String,String> getRequestParameters()

Description copied from interface: IntegrationOptions

(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.

Specified by:

getRequestParameters in interface IntegrationOptions

getRequestTemplates

public final Map<String,String> getRequestTemplates()

Description copied from interface: IntegrationOptions

(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 }" }
 

Specified by:

getRequestTemplates in interface IntegrationOptions

See Also:

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

getTimeout

public final Duration getTimeout()

Description copied from interface: IntegrationOptions

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

Specified by:

getTimeout in interface IntegrationOptions

getVpcLink

public final IVpcLink getVpcLink()

Description copied from interface: IntegrationOptions

(experimental) The VpcLink used for the integration.

Required if connectionType is VPC_LINK

Specified by:

getVpcLink in interface IntegrationOptions

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object