Configuration

configobject
Hide Child Parameters
aws_assume_role_arnstring

The target AWS IAM role ARN used to invoke the Lambda function.
This field is encrypted.
This field is referenceable.

aws_imds_protocol_versionstring

Identifier to select the IMDS protocol version to use: v1 or v2.

Allowed values:v1v2

Default:v1

aws_keystring

The AWS key credential to be used when invoking the function.
This field is encrypted.
This field is referenceable.

aws_regionstring

A string representing a host name, such as example.com.

aws_role_session_namestring

The identifier of the assumed role session.

Default:kong

aws_secretstring

The AWS secret credential to be used when invoking the function.
This field is encrypted.
This field is referenceable.

aws_sts_endpoint_urlstring

A string representing a URL, such as https://example.com/path/to/resource?q=search.

awsgateway_compatibleboolean

An optional value that defines whether the plugin should wrap requests into the Amazon API gateway.

Default:false

base64_encode_bodyboolean

An optional value that Base64-encodes the request body.

Default:true

disable_httpsboolean

Default:false

empty_arrays_modestring

An optional value that defines whether Kong should send empty arrays (returned by Lambda function) as [] arrays or {} objects in JSON responses. The value legacy means Kong will send empty arrays as {} objects in response

Allowed values:correctlegacy

Default:legacy

forward_request_bodyboolean

An optional value that defines whether the request body is sent in the request_body field of the JSON-encoded request. If the body arguments can be parsed, they are sent in the separate request_body_args field of the request.

Default:false

forward_request_headersboolean

An optional value that defines whether the original HTTP request headers are sent as a map in the request_headers field of the JSON-encoded request.

Default:false

forward_request_methodboolean

An optional value that defines whether the original HTTP request method verb is sent in the request_method field of the JSON-encoded request.

Default:false

forward_request_uriboolean

An optional value that defines whether the original HTTP request URI is sent in the request_uri field of the JSON-encoded request.

Default:false

function_namestring

The AWS Lambda function to invoke. Both function name and function ARN (including partial) are supported.

hoststring

A string representing a host name, such as example.com.

invocation_typestring

The InvocationType to use when invoking the function. Available types are RequestResponse, Event, DryRun.

Allowed values:DryRunEventRequestResponse

Default:RequestResponse

is_proxy_integrationboolean

An optional value that defines whether the response format to receive from the Lambda to this format.

Default:false

keepalivenumber

An optional value in milliseconds that defines how long an idle connection lives before being closed.

Default:60000

log_typestring

The LogType to use when invoking the function. By default, None and Tail are supported.

Allowed values:NoneTail

Default:Tail

portinteger

An integer representing a port number between 0 and 65535, inclusive.

Default:443

>= 0<= 65535

proxy_urlstring

A string representing a URL, such as https://example.com/path/to/resource?q=search.

qualifierstring

The qualifier to use when invoking the function.

skip_large_bodiesboolean

An optional value that defines whether Kong should send large bodies that are buffered to disk

Default:true

timeoutnumber

An optional timeout in milliseconds when invoking the function.

Default:60000

unhandled_statusinteger

The response status code to use (instead of the default 200, 202, or 204) in the case of an Unhandled Function Error.

>= 100<= 999

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring
serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.
Hide Child Parameters
idstring

Did this doc help?

Something wrong?

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!