Docs Home
konnect 2.7.4 published on Wednesday, May 14, 2025 by kong
konnect.GatewayPluginRequestCallout
Explore with Pulumi AI
GatewayPluginRequestCallout Resource
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginRequestCallout;
import com.pulumi.konnect.GatewayPluginRequestCalloutArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigCacheArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigCacheMemoryArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigCacheRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigUpstreamArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigUpstreamBodyArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigUpstreamHeadersArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConfigUpstreamQueryArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginRequestCalloutServiceArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myGatewaypluginrequestcallout = new GatewayPluginRequestCallout("myGatewaypluginrequestcallout", GatewayPluginRequestCalloutArgs.builder()
.config(GatewayPluginRequestCalloutConfigArgs.builder()
.cache(GatewayPluginRequestCalloutConfigCacheArgs.builder()
.cacheTtl(7)
.memory(GatewayPluginRequestCalloutConfigCacheMemoryArgs.builder()
.dictionaryName("...my_dictionary_name...")
.build())
.redis(GatewayPluginRequestCalloutConfigCacheRedisArgs.builder()
.clusterMaxRedirections(10)
.clusterNodes(GatewayPluginRequestCalloutConfigCacheRedisClusterNodeArgs.builder()
.ip("...my_ip...")
.port(12116)
.build())
.connectTimeout(221492024)
.connectionIsProxied(false)
.database(0)
.host("...my_host...")
.keepaliveBacklog(2070085081)
.keepalivePoolSize(254346691)
.password("...my_password...")
.port(2887)
.readTimeout(1913162680)
.sendTimeout(27958014)
.sentinelMaster("...my_sentinel_master...")
.sentinelNodes(GatewayPluginRequestCalloutConfigCacheRedisSentinelNodeArgs.builder()
.host("...my_host...")
.port(48331)
.build())
.sentinelPassword("...my_sentinel_password...")
.sentinelRole("master")
.sentinelUsername("...my_sentinel_username...")
.serverName("...my_server_name...")
.ssl(true)
.sslVerify(false)
.username("...my_username...")
.build())
.strategy("redis")
.build())
.callouts(GatewayPluginRequestCalloutConfigCalloutArgs.builder()
.cache(GatewayPluginRequestCalloutConfigCalloutCacheArgs.builder()
.bypass(true)
.build())
.dependsOn("...")
.name("...my_name...")
.request(GatewayPluginRequestCalloutConfigCalloutRequestArgs.builder()
.body(GatewayPluginRequestCalloutConfigCalloutRequestBodyArgs.builder()
.custom(Map.of("key", serializeJson(
"value")))
.decode(true)
.forward(false)
.build())
.byLua("...my_by_lua...")
.error(GatewayPluginRequestCalloutConfigCalloutRequestErrorArgs.builder()
.errorResponseCode(5)
.errorResponseMsg("...my_error_response_msg...")
.httpStatuses(791)
.onError("fail")
.retries(4)
.build())
.headers(GatewayPluginRequestCalloutConfigCalloutRequestHeadersArgs.builder()
.custom(Map.of("key", serializeJson(
"value")))
.forward(false)
.build())
.httpOpts(GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsArgs.builder()
.proxy(GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxyArgs.builder()
.authPassword("...my_auth_password...")
.authUsername("...my_auth_username...")
.httpProxy("...my_http_proxy...")
.httpsProxy("...my_https_proxy...")
.build())
.sslServerName("...my_ssl_server_name...")
.sslVerify(true)
.timeouts(GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeoutsArgs.builder()
.connect(396369045)
.read(2097982023)
.write(1346258560)
.build())
.build())
.method("...my_method...")
.query(GatewayPluginRequestCalloutConfigCalloutRequestQueryArgs.builder()
.custom(Map.of("key", serializeJson(
"value")))
.forward(true)
.build())
.url("...my_url...")
.build())
.response(GatewayPluginRequestCalloutConfigCalloutResponseArgs.builder()
.body(GatewayPluginRequestCalloutConfigCalloutResponseBodyArgs.builder()
.decode(false)
.store(true)
.build())
.byLua("...my_by_lua...")
.headers(GatewayPluginRequestCalloutConfigCalloutResponseHeadersArgs.builder()
.store(false)
.build())
.build())
.build())
.upstream(GatewayPluginRequestCalloutConfigUpstreamArgs.builder()
.body(GatewayPluginRequestCalloutConfigUpstreamBodyArgs.builder()
.custom(Map.of("key", serializeJson(
"value")))
.decode(true)
.forward(false)
.build())
.byLua("...my_by_lua...")
.headers(GatewayPluginRequestCalloutConfigUpstreamHeadersArgs.builder()
.custom(Map.of("key", serializeJson(
"value")))
.forward(true)
.build())
.query(GatewayPluginRequestCalloutConfigUpstreamQueryArgs.builder()
.custom(Map.of("key", serializeJson(
"value")))
.forward(false)
.build())
.build())
.build())
.consumer(GatewayPluginRequestCalloutConsumerArgs.builder()
.id("...my_id...")
.build())
.consumerGroup(GatewayPluginRequestCalloutConsumerGroupArgs.builder()
.id("...my_id...")
.build())
.controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
.createdAt(4)
.enabled(true)
.gatewayPluginRequestCalloutId("...my_id...")
.instanceName("...my_instance_name...")
.ordering(GatewayPluginRequestCalloutOrderingArgs.builder()
.after(GatewayPluginRequestCalloutOrderingAfterArgs.builder()
.access("...")
.build())
.before(GatewayPluginRequestCalloutOrderingBeforeArgs.builder()
.access("...")
.build())
.build())
.protocols("grpcs")
.route(GatewayPluginRequestCalloutRouteArgs.builder()
.id("...my_id...")
.build())
.service(GatewayPluginRequestCalloutServiceArgs.builder()
.id("...my_id...")
.build())
.tags("...")
.updatedAt(1)
.build());
}
}
resources:
myGatewaypluginrequestcallout:
type: konnect:GatewayPluginRequestCallout
properties:
config:
cache:
cacheTtl: 7
memory:
dictionaryName: '...my_dictionary_name...'
redis:
clusterMaxRedirections: 10
clusterNodes:
- ip: '...my_ip...'
port: 12116
connectTimeout: 2.21492024e+08
connectionIsProxied: false
database: 0
host: '...my_host...'
keepaliveBacklog: 2.070085081e+09
keepalivePoolSize: 2.54346691e+08
password: '...my_password...'
port: 2887
readTimeout: 1.91316268e+09
sendTimeout: 2.7958014e+07
sentinelMaster: '...my_sentinel_master...'
sentinelNodes:
- host: '...my_host...'
port: 48331
sentinelPassword: '...my_sentinel_password...'
sentinelRole: master
sentinelUsername: '...my_sentinel_username...'
serverName: '...my_server_name...'
ssl: true
sslVerify: false
username: '...my_username...'
strategy: redis
callouts:
- cache:
bypass: true
dependsOn:
- '...'
name: '...my_name...'
request:
body:
custom:
key:
fn::toJSON: value
decode: true
forward: false
byLua: '...my_by_lua...'
error:
errorResponseCode: 5
errorResponseMsg: '...my_error_response_msg...'
httpStatuses:
- 791
onError: fail
retries: 4
headers:
custom:
key:
fn::toJSON: value
forward: false
httpOpts:
proxy:
authPassword: '...my_auth_password...'
authUsername: '...my_auth_username...'
httpProxy: '...my_http_proxy...'
httpsProxy: '...my_https_proxy...'
sslServerName: '...my_ssl_server_name...'
sslVerify: true
timeouts:
connect: 3.96369045e+08
read: 2.097982023e+09
write: 1.34625856e+09
method: '...my_method...'
query:
custom:
key:
fn::toJSON: value
forward: true
url: '...my_url...'
response:
body:
decode: false
store: true
byLua: '...my_by_lua...'
headers:
store: false
upstream:
body:
custom:
key:
fn::toJSON: value
decode: true
forward: false
byLua: '...my_by_lua...'
headers:
custom:
key:
fn::toJSON: value
forward: true
query:
custom:
key:
fn::toJSON: value
forward: false
consumer:
id: '...my_id...'
consumerGroup:
id: '...my_id...'
controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
createdAt: 4
enabled: true
gatewayPluginRequestCalloutId: '...my_id...'
instanceName: '...my_instance_name...'
ordering:
after:
access:
- '...'
before:
access:
- '...'
protocols:
- grpcs
route:
id: '...my_id...'
service:
id: '...my_id...'
tags:
- '...'
updatedAt: 1
Create GatewayPluginRequestCallout Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayPluginRequestCallout(name: string, args: GatewayPluginRequestCalloutArgs, opts?: CustomResourceOptions);@overload
def GatewayPluginRequestCallout(resource_name: str,
args: GatewayPluginRequestCalloutArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayPluginRequestCallout(resource_name: str,
opts: Optional[ResourceOptions] = None,
control_plane_id: Optional[str] = None,
gateway_plugin_request_callout_id: Optional[str] = None,
consumer_group: Optional[GatewayPluginRequestCalloutConsumerGroupArgs] = None,
consumer: Optional[GatewayPluginRequestCalloutConsumerArgs] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
config: Optional[GatewayPluginRequestCalloutConfigArgs] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginRequestCalloutOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginRequestCalloutRouteArgs] = None,
service: Optional[GatewayPluginRequestCalloutServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None)func NewGatewayPluginRequestCallout(ctx *Context, name string, args GatewayPluginRequestCalloutArgs, opts ...ResourceOption) (*GatewayPluginRequestCallout, error)public GatewayPluginRequestCallout(string name, GatewayPluginRequestCalloutArgs args, CustomResourceOptions? opts = null)
public GatewayPluginRequestCallout(String name, GatewayPluginRequestCalloutArgs args)
public GatewayPluginRequestCallout(String name, GatewayPluginRequestCalloutArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginRequestCallout
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayPluginRequestCalloutArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayPluginRequestCalloutArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayPluginRequestCalloutArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayPluginRequestCalloutArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayPluginRequestCalloutArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayPluginRequestCalloutResource = new Konnect.GatewayPluginRequestCallout("gatewayPluginRequestCalloutResource", new()
{
ControlPlaneId = "string",
GatewayPluginRequestCalloutId = "string",
ConsumerGroup = new Konnect.Inputs.GatewayPluginRequestCalloutConsumerGroupArgs
{
Id = "string",
},
Consumer = new Konnect.Inputs.GatewayPluginRequestCalloutConsumerArgs
{
Id = "string",
},
CreatedAt = 0,
Enabled = false,
Config = new Konnect.Inputs.GatewayPluginRequestCalloutConfigArgs
{
Cache = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCacheArgs
{
CacheTtl = 0,
Memory = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCacheMemoryArgs
{
DictionaryName = "string",
},
Redis = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCacheRedisArgs
{
ClusterMaxRedirections = 0,
ClusterNodes = new[]
{
new Konnect.Inputs.GatewayPluginRequestCalloutConfigCacheRedisClusterNodeArgs
{
Ip = "string",
Port = 0,
},
},
ConnectTimeout = 0,
ConnectionIsProxied = false,
Database = 0,
Host = "string",
KeepaliveBacklog = 0,
KeepalivePoolSize = 0,
Password = "string",
Port = 0,
ReadTimeout = 0,
SendTimeout = 0,
SentinelMaster = "string",
SentinelNodes = new[]
{
new Konnect.Inputs.GatewayPluginRequestCalloutConfigCacheRedisSentinelNodeArgs
{
Host = "string",
Port = 0,
},
},
SentinelPassword = "string",
SentinelRole = "string",
SentinelUsername = "string",
ServerName = "string",
Ssl = false,
SslVerify = false,
Username = "string",
},
Strategy = "string",
},
Callouts = new[]
{
new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutArgs
{
Cache = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutCacheArgs
{
Bypass = false,
},
DependsOns = new[]
{
"string",
},
Name = "string",
Request = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestArgs
{
Body = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestBodyArgs
{
Custom =
{
{ "string", "string" },
},
Decode = false,
Forward = false,
},
ByLua = "string",
Error = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestErrorArgs
{
ErrorResponseCode = 0,
ErrorResponseMsg = "string",
HttpStatuses = new[]
{
0,
},
OnError = "string",
Retries = 0,
},
Headers = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestHeadersArgs
{
Custom =
{
{ "string", "string" },
},
Forward = false,
},
HttpOpts = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsArgs
{
Proxy = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxyArgs
{
AuthPassword = "string",
AuthUsername = "string",
HttpProxy = "string",
HttpsProxy = "string",
},
SslServerName = "string",
SslVerify = false,
Timeouts = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeoutsArgs
{
Connect = 0,
Read = 0,
Write = 0,
},
},
Method = "string",
Query = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutRequestQueryArgs
{
Custom =
{
{ "string", "string" },
},
Forward = false,
},
Url = "string",
},
Response = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutResponseArgs
{
Body = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutResponseBodyArgs
{
Decode = false,
Store = false,
},
ByLua = "string",
Headers = new Konnect.Inputs.GatewayPluginRequestCalloutConfigCalloutResponseHeadersArgs
{
Store = false,
},
},
},
},
Upstream = new Konnect.Inputs.GatewayPluginRequestCalloutConfigUpstreamArgs
{
Body = new Konnect.Inputs.GatewayPluginRequestCalloutConfigUpstreamBodyArgs
{
Custom =
{
{ "string", "string" },
},
Decode = false,
Forward = false,
},
ByLua = "string",
Headers = new Konnect.Inputs.GatewayPluginRequestCalloutConfigUpstreamHeadersArgs
{
Custom =
{
{ "string", "string" },
},
Forward = false,
},
Query = new Konnect.Inputs.GatewayPluginRequestCalloutConfigUpstreamQueryArgs
{
Custom =
{
{ "string", "string" },
},
Forward = false,
},
},
},
InstanceName = "string",
Ordering = new Konnect.Inputs.GatewayPluginRequestCalloutOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginRequestCalloutOrderingAfterArgs
{
Accesses = new[]
{
"string",
},
},
Before = new Konnect.Inputs.GatewayPluginRequestCalloutOrderingBeforeArgs
{
Accesses = new[]
{
"string",
},
},
},
Protocols = new[]
{
"string",
},
Route = new Konnect.Inputs.GatewayPluginRequestCalloutRouteArgs
{
Id = "string",
},
Service = new Konnect.Inputs.GatewayPluginRequestCalloutServiceArgs
{
Id = "string",
},
Tags = new[]
{
"string",
},
UpdatedAt = 0,
});
example, err := konnect.NewGatewayPluginRequestCallout(ctx, "gatewayPluginRequestCalloutResource", &konnect.GatewayPluginRequestCalloutArgs{
ControlPlaneId: pulumi.String("string"),
GatewayPluginRequestCalloutId: pulumi.String("string"),
ConsumerGroup: &konnect.GatewayPluginRequestCalloutConsumerGroupArgs{
Id: pulumi.String("string"),
},
Consumer: &konnect.GatewayPluginRequestCalloutConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
Config: &konnect.GatewayPluginRequestCalloutConfigArgs{
Cache: &konnect.GatewayPluginRequestCalloutConfigCacheArgs{
CacheTtl: pulumi.Float64(0),
Memory: &konnect.GatewayPluginRequestCalloutConfigCacheMemoryArgs{
DictionaryName: pulumi.String("string"),
},
Redis: &konnect.GatewayPluginRequestCalloutConfigCacheRedisArgs{
ClusterMaxRedirections: pulumi.Float64(0),
ClusterNodes: konnect.GatewayPluginRequestCalloutConfigCacheRedisClusterNodeArray{
&konnect.GatewayPluginRequestCalloutConfigCacheRedisClusterNodeArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ConnectTimeout: pulumi.Float64(0),
ConnectionIsProxied: pulumi.Bool(false),
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
KeepaliveBacklog: pulumi.Float64(0),
KeepalivePoolSize: pulumi.Float64(0),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ReadTimeout: pulumi.Float64(0),
SendTimeout: pulumi.Float64(0),
SentinelMaster: pulumi.String("string"),
SentinelNodes: konnect.GatewayPluginRequestCalloutConfigCacheRedisSentinelNodeArray{
&konnect.GatewayPluginRequestCalloutConfigCacheRedisSentinelNodeArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
SentinelPassword: pulumi.String("string"),
SentinelRole: pulumi.String("string"),
SentinelUsername: pulumi.String("string"),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Username: pulumi.String("string"),
},
Strategy: pulumi.String("string"),
},
Callouts: konnect.GatewayPluginRequestCalloutConfigCalloutArray{
&konnect.GatewayPluginRequestCalloutConfigCalloutArgs{
Cache: &konnect.GatewayPluginRequestCalloutConfigCalloutCacheArgs{
Bypass: pulumi.Bool(false),
},
DependsOns: pulumi.StringArray{
pulumi.String("string"),
},
Name: pulumi.String("string"),
Request: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestArgs{
Body: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestBodyArgs{
Custom: pulumi.StringMap{
"string": pulumi.String("string"),
},
Decode: pulumi.Bool(false),
Forward: pulumi.Bool(false),
},
ByLua: pulumi.String("string"),
Error: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestErrorArgs{
ErrorResponseCode: pulumi.Float64(0),
ErrorResponseMsg: pulumi.String("string"),
HttpStatuses: pulumi.Float64Array{
pulumi.Float64(0),
},
OnError: pulumi.String("string"),
Retries: pulumi.Float64(0),
},
Headers: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestHeadersArgs{
Custom: pulumi.StringMap{
"string": pulumi.String("string"),
},
Forward: pulumi.Bool(false),
},
HttpOpts: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsArgs{
Proxy: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxyArgs{
AuthPassword: pulumi.String("string"),
AuthUsername: pulumi.String("string"),
HttpProxy: pulumi.String("string"),
HttpsProxy: pulumi.String("string"),
},
SslServerName: pulumi.String("string"),
SslVerify: pulumi.Bool(false),
Timeouts: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeoutsArgs{
Connect: pulumi.Float64(0),
Read: pulumi.Float64(0),
Write: pulumi.Float64(0),
},
},
Method: pulumi.String("string"),
Query: &konnect.GatewayPluginRequestCalloutConfigCalloutRequestQueryArgs{
Custom: pulumi.StringMap{
"string": pulumi.String("string"),
},
Forward: pulumi.Bool(false),
},
Url: pulumi.String("string"),
},
Response: &konnect.GatewayPluginRequestCalloutConfigCalloutResponseArgs{
Body: &konnect.GatewayPluginRequestCalloutConfigCalloutResponseBodyArgs{
Decode: pulumi.Bool(false),
Store: pulumi.Bool(false),
},
ByLua: pulumi.String("string"),
Headers: &konnect.GatewayPluginRequestCalloutConfigCalloutResponseHeadersArgs{
Store: pulumi.Bool(false),
},
},
},
},
Upstream: &konnect.GatewayPluginRequestCalloutConfigUpstreamArgs{
Body: &konnect.GatewayPluginRequestCalloutConfigUpstreamBodyArgs{
Custom: pulumi.StringMap{
"string": pulumi.String("string"),
},
Decode: pulumi.Bool(false),
Forward: pulumi.Bool(false),
},
ByLua: pulumi.String("string"),
Headers: &konnect.GatewayPluginRequestCalloutConfigUpstreamHeadersArgs{
Custom: pulumi.StringMap{
"string": pulumi.String("string"),
},
Forward: pulumi.Bool(false),
},
Query: &konnect.GatewayPluginRequestCalloutConfigUpstreamQueryArgs{
Custom: pulumi.StringMap{
"string": pulumi.String("string"),
},
Forward: pulumi.Bool(false),
},
},
},
InstanceName: pulumi.String("string"),
Ordering: &konnect.GatewayPluginRequestCalloutOrderingArgs{
After: &konnect.GatewayPluginRequestCalloutOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &konnect.GatewayPluginRequestCalloutOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &konnect.GatewayPluginRequestCalloutRouteArgs{
Id: pulumi.String("string"),
},
Service: &konnect.GatewayPluginRequestCalloutServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
var gatewayPluginRequestCalloutResource = new GatewayPluginRequestCallout("gatewayPluginRequestCalloutResource", GatewayPluginRequestCalloutArgs.builder()
.controlPlaneId("string")
.gatewayPluginRequestCalloutId("string")
.consumerGroup(GatewayPluginRequestCalloutConsumerGroupArgs.builder()
.id("string")
.build())
.consumer(GatewayPluginRequestCalloutConsumerArgs.builder()
.id("string")
.build())
.createdAt(0.0)
.enabled(false)
.config(GatewayPluginRequestCalloutConfigArgs.builder()
.cache(GatewayPluginRequestCalloutConfigCacheArgs.builder()
.cacheTtl(0.0)
.memory(GatewayPluginRequestCalloutConfigCacheMemoryArgs.builder()
.dictionaryName("string")
.build())
.redis(GatewayPluginRequestCalloutConfigCacheRedisArgs.builder()
.clusterMaxRedirections(0.0)
.clusterNodes(GatewayPluginRequestCalloutConfigCacheRedisClusterNodeArgs.builder()
.ip("string")
.port(0.0)
.build())
.connectTimeout(0.0)
.connectionIsProxied(false)
.database(0.0)
.host("string")
.keepaliveBacklog(0.0)
.keepalivePoolSize(0.0)
.password("string")
.port(0.0)
.readTimeout(0.0)
.sendTimeout(0.0)
.sentinelMaster("string")
.sentinelNodes(GatewayPluginRequestCalloutConfigCacheRedisSentinelNodeArgs.builder()
.host("string")
.port(0.0)
.build())
.sentinelPassword("string")
.sentinelRole("string")
.sentinelUsername("string")
.serverName("string")
.ssl(false)
.sslVerify(false)
.username("string")
.build())
.strategy("string")
.build())
.callouts(GatewayPluginRequestCalloutConfigCalloutArgs.builder()
.cache(GatewayPluginRequestCalloutConfigCalloutCacheArgs.builder()
.bypass(false)
.build())
.dependsOns("string")
.name("string")
.request(GatewayPluginRequestCalloutConfigCalloutRequestArgs.builder()
.body(GatewayPluginRequestCalloutConfigCalloutRequestBodyArgs.builder()
.custom(Map.of("string", "string"))
.decode(false)
.forward(false)
.build())
.byLua("string")
.error(GatewayPluginRequestCalloutConfigCalloutRequestErrorArgs.builder()
.errorResponseCode(0.0)
.errorResponseMsg("string")
.httpStatuses(0.0)
.onError("string")
.retries(0.0)
.build())
.headers(GatewayPluginRequestCalloutConfigCalloutRequestHeadersArgs.builder()
.custom(Map.of("string", "string"))
.forward(false)
.build())
.httpOpts(GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsArgs.builder()
.proxy(GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxyArgs.builder()
.authPassword("string")
.authUsername("string")
.httpProxy("string")
.httpsProxy("string")
.build())
.sslServerName("string")
.sslVerify(false)
.timeouts(GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeoutsArgs.builder()
.connect(0.0)
.read(0.0)
.write(0.0)
.build())
.build())
.method("string")
.query(GatewayPluginRequestCalloutConfigCalloutRequestQueryArgs.builder()
.custom(Map.of("string", "string"))
.forward(false)
.build())
.url("string")
.build())
.response(GatewayPluginRequestCalloutConfigCalloutResponseArgs.builder()
.body(GatewayPluginRequestCalloutConfigCalloutResponseBodyArgs.builder()
.decode(false)
.store(false)
.build())
.byLua("string")
.headers(GatewayPluginRequestCalloutConfigCalloutResponseHeadersArgs.builder()
.store(false)
.build())
.build())
.build())
.upstream(GatewayPluginRequestCalloutConfigUpstreamArgs.builder()
.body(GatewayPluginRequestCalloutConfigUpstreamBodyArgs.builder()
.custom(Map.of("string", "string"))
.decode(false)
.forward(false)
.build())
.byLua("string")
.headers(GatewayPluginRequestCalloutConfigUpstreamHeadersArgs.builder()
.custom(Map.of("string", "string"))
.forward(false)
.build())
.query(GatewayPluginRequestCalloutConfigUpstreamQueryArgs.builder()
.custom(Map.of("string", "string"))
.forward(false)
.build())
.build())
.build())
.instanceName("string")
.ordering(GatewayPluginRequestCalloutOrderingArgs.builder()
.after(GatewayPluginRequestCalloutOrderingAfterArgs.builder()
.accesses("string")
.build())
.before(GatewayPluginRequestCalloutOrderingBeforeArgs.builder()
.accesses("string")
.build())
.build())
.protocols("string")
.route(GatewayPluginRequestCalloutRouteArgs.builder()
.id("string")
.build())
.service(GatewayPluginRequestCalloutServiceArgs.builder()
.id("string")
.build())
.tags("string")
.updatedAt(0.0)
.build());
gateway_plugin_request_callout_resource = konnect.GatewayPluginRequestCallout("gatewayPluginRequestCalloutResource",
control_plane_id="string",
gateway_plugin_request_callout_id="string",
consumer_group={
"id": "string",
},
consumer={
"id": "string",
},
created_at=0,
enabled=False,
config={
"cache": {
"cache_ttl": 0,
"memory": {
"dictionary_name": "string",
},
"redis": {
"cluster_max_redirections": 0,
"cluster_nodes": [{
"ip": "string",
"port": 0,
}],
"connect_timeout": 0,
"connection_is_proxied": False,
"database": 0,
"host": "string",
"keepalive_backlog": 0,
"keepalive_pool_size": 0,
"password": "string",
"port": 0,
"read_timeout": 0,
"send_timeout": 0,
"sentinel_master": "string",
"sentinel_nodes": [{
"host": "string",
"port": 0,
}],
"sentinel_password": "string",
"sentinel_role": "string",
"sentinel_username": "string",
"server_name": "string",
"ssl": False,
"ssl_verify": False,
"username": "string",
},
"strategy": "string",
},
"callouts": [{
"cache": {
"bypass": False,
},
"depends_ons": ["string"],
"name": "string",
"request": {
"body": {
"custom": {
"string": "string",
},
"decode": False,
"forward": False,
},
"by_lua": "string",
"error": {
"error_response_code": 0,
"error_response_msg": "string",
"http_statuses": [0],
"on_error": "string",
"retries": 0,
},
"headers": {
"custom": {
"string": "string",
},
"forward": False,
},
"http_opts": {
"proxy": {
"auth_password": "string",
"auth_username": "string",
"http_proxy": "string",
"https_proxy": "string",
},
"ssl_server_name": "string",
"ssl_verify": False,
"timeouts": {
"connect": 0,
"read": 0,
"write": 0,
},
},
"method": "string",
"query": {
"custom": {
"string": "string",
},
"forward": False,
},
"url": "string",
},
"response": {
"body": {
"decode": False,
"store": False,
},
"by_lua": "string",
"headers": {
"store": False,
},
},
}],
"upstream": {
"body": {
"custom": {
"string": "string",
},
"decode": False,
"forward": False,
},
"by_lua": "string",
"headers": {
"custom": {
"string": "string",
},
"forward": False,
},
"query": {
"custom": {
"string": "string",
},
"forward": False,
},
},
},
instance_name="string",
ordering={
"after": {
"accesses": ["string"],
},
"before": {
"accesses": ["string"],
},
},
protocols=["string"],
route={
"id": "string",
},
service={
"id": "string",
},
tags=["string"],
updated_at=0)
const gatewayPluginRequestCalloutResource = new konnect.GatewayPluginRequestCallout("gatewayPluginRequestCalloutResource", {
controlPlaneId: "string",
gatewayPluginRequestCalloutId: "string",
consumerGroup: {
id: "string",
},
consumer: {
id: "string",
},
createdAt: 0,
enabled: false,
config: {
cache: {
cacheTtl: 0,
memory: {
dictionaryName: "string",
},
redis: {
clusterMaxRedirections: 0,
clusterNodes: [{
ip: "string",
port: 0,
}],
connectTimeout: 0,
connectionIsProxied: false,
database: 0,
host: "string",
keepaliveBacklog: 0,
keepalivePoolSize: 0,
password: "string",
port: 0,
readTimeout: 0,
sendTimeout: 0,
sentinelMaster: "string",
sentinelNodes: [{
host: "string",
port: 0,
}],
sentinelPassword: "string",
sentinelRole: "string",
sentinelUsername: "string",
serverName: "string",
ssl: false,
sslVerify: false,
username: "string",
},
strategy: "string",
},
callouts: [{
cache: {
bypass: false,
},
dependsOns: ["string"],
name: "string",
request: {
body: {
custom: {
string: "string",
},
decode: false,
forward: false,
},
byLua: "string",
error: {
errorResponseCode: 0,
errorResponseMsg: "string",
httpStatuses: [0],
onError: "string",
retries: 0,
},
headers: {
custom: {
string: "string",
},
forward: false,
},
httpOpts: {
proxy: {
authPassword: "string",
authUsername: "string",
httpProxy: "string",
httpsProxy: "string",
},
sslServerName: "string",
sslVerify: false,
timeouts: {
connect: 0,
read: 0,
write: 0,
},
},
method: "string",
query: {
custom: {
string: "string",
},
forward: false,
},
url: "string",
},
response: {
body: {
decode: false,
store: false,
},
byLua: "string",
headers: {
store: false,
},
},
}],
upstream: {
body: {
custom: {
string: "string",
},
decode: false,
forward: false,
},
byLua: "string",
headers: {
custom: {
string: "string",
},
forward: false,
},
query: {
custom: {
string: "string",
},
forward: false,
},
},
},
instanceName: "string",
ordering: {
after: {
accesses: ["string"],
},
before: {
accesses: ["string"],
},
},
protocols: ["string"],
route: {
id: "string",
},
service: {
id: "string",
},
tags: ["string"],
updatedAt: 0,
});
type: konnect:GatewayPluginRequestCallout
properties:
config:
cache:
cacheTtl: 0
memory:
dictionaryName: string
redis:
clusterMaxRedirections: 0
clusterNodes:
- ip: string
port: 0
connectTimeout: 0
connectionIsProxied: false
database: 0
host: string
keepaliveBacklog: 0
keepalivePoolSize: 0
password: string
port: 0
readTimeout: 0
sendTimeout: 0
sentinelMaster: string
sentinelNodes:
- host: string
port: 0
sentinelPassword: string
sentinelRole: string
sentinelUsername: string
serverName: string
ssl: false
sslVerify: false
username: string
strategy: string
callouts:
- cache:
bypass: false
dependsOns:
- string
name: string
request:
body:
custom:
string: string
decode: false
forward: false
byLua: string
error:
errorResponseCode: 0
errorResponseMsg: string
httpStatuses:
- 0
onError: string
retries: 0
headers:
custom:
string: string
forward: false
httpOpts:
proxy:
authPassword: string
authUsername: string
httpProxy: string
httpsProxy: string
sslServerName: string
sslVerify: false
timeouts:
connect: 0
read: 0
write: 0
method: string
query:
custom:
string: string
forward: false
url: string
response:
body:
decode: false
store: false
byLua: string
headers:
store: false
upstream:
body:
custom:
string: string
decode: false
forward: false
byLua: string
headers:
custom:
string: string
forward: false
query:
custom:
string: string
forward: false
consumer:
id: string
consumerGroup:
id: string
controlPlaneId: string
createdAt: 0
enabled: false
gatewayPluginRequestCalloutId: string
instanceName: string
ordering:
after:
accesses:
- string
before:
accesses:
- string
protocols:
- string
route:
id: string
service:
id: string
tags:
- string
updatedAt: 0
GatewayPluginRequestCallout Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayPluginRequestCallout resource accepts the following input properties:
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Config
Gateway
Plugin Request Callout Config - Consumer
Gateway
Plugin Request Callout Consumer - 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.
- Consumer
Group GatewayPlugin Request Callout Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRequest Callout Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Request Callout Ordering - Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Request Callout Route - 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.
- Service
Gateway
Plugin Request Callout Service - 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.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Config
Gateway
Plugin Request Callout Config Args - Consumer
Gateway
Plugin Request Callout Consumer Args - 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.
- Consumer
Group GatewayPlugin Request Callout Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRequest Callout Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Request Callout Ordering Args - Protocols []string
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Request Callout Route Args - 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.
- Service
Gateway
Plugin Request Callout Service Args - 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.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config
Gateway
Plugin Request Callout Config - consumer
Gateway
Plugin Request Callout Consumer - 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.
- consumer
Group GatewayPlugin Request Callout Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRequest Callout Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Request Callout Ordering - protocols List<String>
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Request Callout Route - 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.
- service
Gateway
Plugin Request Callout Service - 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config
Gateway
Plugin Request Callout Config - consumer
Gateway
Plugin Request Callout Consumer - 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.
- consumer
Group GatewayPlugin Request Callout Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringRequest Callout Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Request Callout Ordering - protocols string[]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Request Callout Route - 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.
- service
Gateway
Plugin Request Callout Service - 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.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config
Gateway
Plugin Request Callout Config Args - consumer
Gateway
Plugin Request Callout Consumer Args - 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.
- consumer_
group GatewayPlugin Request Callout Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strrequest_ callout_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Request Callout Ordering Args - protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Request Callout Route Args - 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.
- service
Gateway
Plugin Request Callout Service Args - 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.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_
at float - Unix epoch when the resource was last updated.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- config Property Map
- consumer Property Map
- 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.
- consumer
Group Property Map - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRequest Callout Id - The ID of this resource.
- instance
Name String - ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- 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.
- service Property Map
- 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayPluginRequestCallout resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing GatewayPluginRequestCallout Resource
Get an existing GatewayPluginRequestCallout resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayPluginRequestCalloutState, opts?: CustomResourceOptions): GatewayPluginRequestCallout@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginRequestCalloutConfigArgs] = None,
consumer: Optional[GatewayPluginRequestCalloutConsumerArgs] = None,
consumer_group: Optional[GatewayPluginRequestCalloutConsumerGroupArgs] = None,
control_plane_id: Optional[str] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_request_callout_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginRequestCalloutOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginRequestCalloutRouteArgs] = None,
service: Optional[GatewayPluginRequestCalloutServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None) -> GatewayPluginRequestCalloutfunc GetGatewayPluginRequestCallout(ctx *Context, name string, id IDInput, state *GatewayPluginRequestCalloutState, opts ...ResourceOption) (*GatewayPluginRequestCallout, error)public static GatewayPluginRequestCallout Get(string name, Input<string> id, GatewayPluginRequestCalloutState? state, CustomResourceOptions? opts = null)public static GatewayPluginRequestCallout get(String name, Output<String> id, GatewayPluginRequestCalloutState state, CustomResourceOptions options)resources: _: type: konnect:GatewayPluginRequestCallout get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Config
Gateway
Plugin Request Callout Config - Consumer
Gateway
Plugin Request Callout Consumer - 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.
- Consumer
Group GatewayPlugin Request Callout Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRequest Callout Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Request Callout Ordering - Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Request Callout Route - 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.
- Service
Gateway
Plugin Request Callout Service - 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.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Config
Gateway
Plugin Request Callout Config Args - Consumer
Gateway
Plugin Request Callout Consumer Args - 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.
- Consumer
Group GatewayPlugin Request Callout Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRequest Callout Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Request Callout Ordering Args - Protocols []string
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Request Callout Route Args - 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.
- Service
Gateway
Plugin Request Callout Service Args - 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.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Request Callout Config - consumer
Gateway
Plugin Request Callout Consumer - 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.
- consumer
Group GatewayPlugin Request Callout Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRequest Callout Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Request Callout Ordering - protocols List<String>
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Request Callout Route - 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.
- service
Gateway
Plugin Request Callout Service - 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Request Callout Config - consumer
Gateway
Plugin Request Callout Consumer - 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.
- consumer
Group GatewayPlugin Request Callout Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringRequest Callout Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Request Callout Ordering - protocols string[]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Request Callout Route - 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.
- service
Gateway
Plugin Request Callout Service - 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.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Request Callout Config Args - consumer
Gateway
Plugin Request Callout Consumer Args - 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.
- consumer_
group GatewayPlugin Request Callout Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strrequest_ callout_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Request Callout Ordering Args - protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Request Callout Route Args - 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.
- service
Gateway
Plugin Request Callout Service Args - 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.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_
at float - Unix epoch when the resource was last updated.
- config Property Map
- consumer Property Map
- 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.
- consumer
Group Property Map - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRequest Callout Id - The ID of this resource.
- instance
Name String - ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- 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.
- service Property Map
- 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.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Supporting Types
GatewayPluginRequestCalloutConfig, GatewayPluginRequestCalloutConfigArgs
- Cache
Gateway
Plugin Request Callout Config Cache - Plugin global caching configuration.
- Callouts
List<Gateway
Plugin Request Callout Config Callout> - A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- Upstream
Gateway
Plugin Request Callout Config Upstream - Customizations to the upstream request.
- Cache
Gateway
Plugin Request Callout Config Cache - Plugin global caching configuration.
- Callouts
[]Gateway
Plugin Request Callout Config Callout - A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- Upstream
Gateway
Plugin Request Callout Config Upstream - Customizations to the upstream request.
- cache
Gateway
Plugin Request Callout Config Cache - Plugin global caching configuration.
- callouts
List<Gateway
Plugin Request Callout Config Callout> - A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- upstream
Gateway
Plugin Request Callout Config Upstream - Customizations to the upstream request.
- cache
Gateway
Plugin Request Callout Config Cache - Plugin global caching configuration.
- callouts
Gateway
Plugin Request Callout Config Callout[] - A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- upstream
Gateway
Plugin Request Callout Config Upstream - Customizations to the upstream request.
- cache
Gateway
Plugin Request Callout Config Cache - Plugin global caching configuration.
- callouts
Sequence[Gateway
Plugin Request Callout Config Callout] - A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- upstream
Gateway
Plugin Request Callout Config Upstream - Customizations to the upstream request.
- cache Property Map
- Plugin global caching configuration.
- callouts List<Property Map>
- A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
- upstream Property Map
- Customizations to the upstream request.
GatewayPluginRequestCalloutConfigCache, GatewayPluginRequestCalloutConfigCacheArgs
- Cache
Ttl double - TTL in seconds of cache entities.
- Memory
Gateway
Plugin Request Callout Config Cache Memory - Redis
Gateway
Plugin Request Callout Config Cache Redis - Strategy string
- The backing data store in which to hold cache entities. Accepted values are:
off,memory, andredis. must be one of ["memory", "off", "redis"]
- Cache
Ttl float64 - TTL in seconds of cache entities.
- Memory
Gateway
Plugin Request Callout Config Cache Memory - Redis
Gateway
Plugin Request Callout Config Cache Redis - Strategy string
- The backing data store in which to hold cache entities. Accepted values are:
off,memory, andredis. must be one of ["memory", "off", "redis"]
- cache
Ttl Double - TTL in seconds of cache entities.
- memory
Gateway
Plugin Request Callout Config Cache Memory - redis
Gateway
Plugin Request Callout Config Cache Redis - strategy String
- The backing data store in which to hold cache entities. Accepted values are:
off,memory, andredis. must be one of ["memory", "off", "redis"]
- cache
Ttl number - TTL in seconds of cache entities.
- memory
Gateway
Plugin Request Callout Config Cache Memory - redis
Gateway
Plugin Request Callout Config Cache Redis - strategy string
- The backing data store in which to hold cache entities. Accepted values are:
off,memory, andredis. must be one of ["memory", "off", "redis"]
- cache_
ttl float - TTL in seconds of cache entities.
- memory
Gateway
Plugin Request Callout Config Cache Memory - redis
Gateway
Plugin Request Callout Config Cache Redis - strategy str
- The backing data store in which to hold cache entities. Accepted values are:
off,memory, andredis. must be one of ["memory", "off", "redis"]
- cache
Ttl Number - TTL in seconds of cache entities.
- memory Property Map
- redis Property Map
- strategy String
- The backing data store in which to hold cache entities. Accepted values are:
off,memory, andredis. must be one of ["memory", "off", "redis"]
GatewayPluginRequestCalloutConfigCacheMemory, GatewayPluginRequestCalloutConfigCacheMemoryArgs
- Dictionary
Name string - The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
- Dictionary
Name string - The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
- dictionary
Name String - The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
- dictionary
Name string - The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
- dictionary_
name str - The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
- dictionary
Name String - The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
GatewayPluginRequestCalloutConfigCacheRedis, GatewayPluginRequestCalloutConfigCacheRedisArgs
- Cluster
Max doubleRedirections - Maximum retry attempts for redirection.
- Cluster
Nodes List<GatewayPlugin Request Callout Config Cache Redis Cluster Node> - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - Connect
Timeout double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Connection
Is boolProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - Database double
- Database to use for the Redis connection when using the
redisstrategy - Host string
- A string representing a host name, such as example.com.
- Keepalive
Backlog double - Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return
nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - Keepalive
Pool doubleSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. - Password string
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- Port double
- An integer representing a port number between 0 and 65535, inclusive.
- Read
Timeout double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Send
Timeout double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Sentinel
Master string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- Sentinel
Nodes List<GatewayPlugin Request Callout Config Cache Redis Sentinel Node> - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - Sentinel
Password string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- Sentinel
Role string - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - Sentinel
Username string - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- Server
Name string - A string representing an SNI (server name indication) value for TLS.
- Ssl bool
- If set to true, uses SSL to connect to Redis.
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - Username string
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to
default.
- Cluster
Max float64Redirections - Maximum retry attempts for redirection.
- Cluster
Nodes []GatewayPlugin Request Callout Config Cache Redis Cluster Node - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - Connect
Timeout float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Connection
Is boolProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - Database float64
- Database to use for the Redis connection when using the
redisstrategy - Host string
- A string representing a host name, such as example.com.
- Keepalive
Backlog float64 - Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return
nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - Keepalive
Pool float64Size - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. - Password string
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- Port float64
- An integer representing a port number between 0 and 65535, inclusive.
- Read
Timeout float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Send
Timeout float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Sentinel
Master string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- Sentinel
Nodes []GatewayPlugin Request Callout Config Cache Redis Sentinel Node - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - Sentinel
Password string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- Sentinel
Role string - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - Sentinel
Username string - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- Server
Name string - A string representing an SNI (server name indication) value for TLS.
- Ssl bool
- If set to true, uses SSL to connect to Redis.
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - Username string
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to
default.
- cluster
Max DoubleRedirections - Maximum retry attempts for redirection.
- cluster
Nodes List<GatewayPlugin Request Callout Config Cache Redis Cluster Node> - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect
Timeout Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is BooleanProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database Double
- Database to use for the Redis connection when using the
redisstrategy - host String
- A string representing a host name, such as example.com.
- keepalive
Backlog Double - Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return
nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive
Pool DoubleSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. - password String
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port Double
- An integer representing a port number between 0 and 65535, inclusive.
- read
Timeout Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send
Timeout Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master String - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes List<GatewayPlugin Request Callout Config Cache Redis Sentinel Node> - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel
Password String - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role String - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel
Username String - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server
Name String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - username String
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to
default.
- cluster
Max numberRedirections - Maximum retry attempts for redirection.
- cluster
Nodes GatewayPlugin Request Callout Config Cache Redis Cluster Node[] - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect
Timeout number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is booleanProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database number
- Database to use for the Redis connection when using the
redisstrategy - host string
- A string representing a host name, such as example.com.
- keepalive
Backlog number - Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return
nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive
Pool numberSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. - password string
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port number
- An integer representing a port number between 0 and 65535, inclusive.
- read
Timeout number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send
Timeout number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes GatewayPlugin Request Callout Config Cache Redis Sentinel Node[] - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel
Password string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role string - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel
Username string - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server
Name string - A string representing an SNI (server name indication) value for TLS.
- ssl boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - username string
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to
default.
- cluster_
max_ floatredirections - Maximum retry attempts for redirection.
- cluster_
nodes Sequence[GatewayPlugin Request Callout Config Cache Redis Cluster Node] - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect_
timeout float - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection_
is_ boolproxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database float
- Database to use for the Redis connection when using the
redisstrategy - host str
- A string representing a host name, such as example.com.
- keepalive_
backlog float - Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return
nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive_
pool_ floatsize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. - password str
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port float
- An integer representing a port number between 0 and 65535, inclusive.
- read_
timeout float - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send_
timeout float - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel_
master str - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel_
nodes Sequence[GatewayPlugin Request Callout Config Cache Redis Sentinel Node] - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel_
password str - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel_
role str - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel_
username str - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server_
name str - A string representing an SNI (server name indication) value for TLS.
- ssl bool
- If set to true, uses SSL to connect to Redis.
- ssl_
verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - username str
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to
default.
- cluster
Max NumberRedirections - Maximum retry attempts for redirection.
- cluster
Nodes List<Property Map> - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect
Timeout Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is BooleanProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database Number
- Database to use for the Redis connection when using the
redisstrategy - host String
- A string representing a host name, such as example.com.
- keepalive
Backlog Number - Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return
nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive
Pool NumberSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. - password String
- Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
- port Number
- An integer representing a port number between 0 and 65535, inclusive.
- read
Timeout Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- send
Timeout Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master String - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes List<Property Map> - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel
Password String - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role String - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel
Username String - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server
Name String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - username String
- Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to
default.
GatewayPluginRequestCalloutConfigCacheRedisClusterNode, GatewayPluginRequestCalloutConfigCacheRedisClusterNodeArgs
GatewayPluginRequestCalloutConfigCacheRedisSentinelNode, GatewayPluginRequestCalloutConfigCacheRedisSentinelNodeArgs
GatewayPluginRequestCalloutConfigCallout, GatewayPluginRequestCalloutConfigCalloutArgs
- Cache
Gateway
Plugin Request Callout Config Callout Cache - Callout caching configuration. Not Null
- Depends
Ons List<string> - An array of callout names the current callout depends on.This dependency determines the callout execution order.
- Name string
- A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.\n\n. Not Null
- Request
Gateway
Plugin Request Callout Config Callout Request - The customizations for the callout request. Not Null
- Response
Gateway
Plugin Request Callout Config Callout Response - Configurations of callout response handling. Not Null
- Cache
Gateway
Plugin Request Callout Config Callout Cache - Callout caching configuration. Not Null
- Depends
Ons []string - An array of callout names the current callout depends on.This dependency determines the callout execution order.
- Name string
- A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.\n\n. Not Null
- Request
Gateway
Plugin Request Callout Config Callout Request - The customizations for the callout request. Not Null
- Response
Gateway
Plugin Request Callout Config Callout Response - Configurations of callout response handling. Not Null
- cache
Gateway
Plugin Request Callout Config Callout Cache - Callout caching configuration. Not Null
- depends
Ons List<String> - An array of callout names the current callout depends on.This dependency determines the callout execution order.
- name String
- A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.\n\n. Not Null
- request
Gateway
Plugin Request Callout Config Callout Request - The customizations for the callout request. Not Null
- response
Gateway
Plugin Request Callout Config Callout Response - Configurations of callout response handling. Not Null
- cache
Gateway
Plugin Request Callout Config Callout Cache - Callout caching configuration. Not Null
- depends
Ons string[] - An array of callout names the current callout depends on.This dependency determines the callout execution order.
- name string
- A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.\n\n. Not Null
- request
Gateway
Plugin Request Callout Config Callout Request - The customizations for the callout request. Not Null
- response
Gateway
Plugin Request Callout Config Callout Response - Configurations of callout response handling. Not Null
- cache
Gateway
Plugin Request Callout Config Callout Cache - Callout caching configuration. Not Null
- depends_
ons Sequence[str] - An array of callout names the current callout depends on.This dependency determines the callout execution order.
- name str
- A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.\n\n. Not Null
- request
Gateway
Plugin Request Callout Config Callout Request - The customizations for the callout request. Not Null
- response
Gateway
Plugin Request Callout Config Callout Response - Configurations of callout response handling. Not Null
- cache Property Map
- Callout caching configuration. Not Null
- depends
Ons List<String> - An array of callout names the current callout depends on.This dependency determines the callout execution order.
- name String
- A string identifier for a callout. A callout object is referenceablevia its name in the kong.ctx.shared.callouts.\n\n. Not Null
- request Property Map
- The customizations for the callout request. Not Null
- response Property Map
- Configurations of callout response handling. Not Null
GatewayPluginRequestCalloutConfigCalloutCache, GatewayPluginRequestCalloutConfigCalloutCacheArgs
- Bypass bool
- If true, skips caching the callout response.
- Bypass bool
- If true, skips caching the callout response.
- bypass Boolean
- If true, skips caching the callout response.
- bypass boolean
- If true, skips caching the callout response.
- bypass bool
- If true, skips caching the callout response.
- bypass Boolean
- If true, skips caching the callout response.
GatewayPluginRequestCalloutConfigCalloutRequest, GatewayPluginRequestCalloutConfigCalloutRequestArgs
- Body
Gateway
Plugin Request Callout Config Callout Request Body - Callout request body customizations. Not Null
- By
Lua string - Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- Error
Gateway
Plugin Request Callout Config Callout Request Error - The error handling policy the plugin will apply to TCP and HTTP errors. Not Null
- Headers
Gateway
Plugin Request Callout Config Callout Request Headers - Callout request header customizations. Not Null
- Http
Opts GatewayPlugin Request Callout Config Callout Request Http Opts - HTTP connection parameters. Not Null
- Method string
- The HTTP method that will be requested.
- Query
Gateway
Plugin Request Callout Config Callout Request Query - Callout request query param customizations. Not Null
- Url string
- The URL that will be requested. Not Null
- Body
Gateway
Plugin Request Callout Config Callout Request Body - Callout request body customizations. Not Null
- By
Lua string - Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- Error
Gateway
Plugin Request Callout Config Callout Request Error - The error handling policy the plugin will apply to TCP and HTTP errors. Not Null
- Headers
Gateway
Plugin Request Callout Config Callout Request Headers - Callout request header customizations. Not Null
- Http
Opts GatewayPlugin Request Callout Config Callout Request Http Opts - HTTP connection parameters. Not Null
- Method string
- The HTTP method that will be requested.
- Query
Gateway
Plugin Request Callout Config Callout Request Query - Callout request query param customizations. Not Null
- Url string
- The URL that will be requested. Not Null
- body
Gateway
Plugin Request Callout Config Callout Request Body - Callout request body customizations. Not Null
- by
Lua String - Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- error
Gateway
Plugin Request Callout Config Callout Request Error - The error handling policy the plugin will apply to TCP and HTTP errors. Not Null
- headers
Gateway
Plugin Request Callout Config Callout Request Headers - Callout request header customizations. Not Null
- http
Opts GatewayPlugin Request Callout Config Callout Request Http Opts - HTTP connection parameters. Not Null
- method String
- The HTTP method that will be requested.
- query
Gateway
Plugin Request Callout Config Callout Request Query - Callout request query param customizations. Not Null
- url String
- The URL that will be requested. Not Null
- body
Gateway
Plugin Request Callout Config Callout Request Body - Callout request body customizations. Not Null
- by
Lua string - Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- error
Gateway
Plugin Request Callout Config Callout Request Error - The error handling policy the plugin will apply to TCP and HTTP errors. Not Null
- headers
Gateway
Plugin Request Callout Config Callout Request Headers - Callout request header customizations. Not Null
- http
Opts GatewayPlugin Request Callout Config Callout Request Http Opts - HTTP connection parameters. Not Null
- method string
- The HTTP method that will be requested.
- query
Gateway
Plugin Request Callout Config Callout Request Query - Callout request query param customizations. Not Null
- url string
- The URL that will be requested. Not Null
- body
Gateway
Plugin Request Callout Config Callout Request Body - Callout request body customizations. Not Null
- by_
lua str - Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- error
Gateway
Plugin Request Callout Config Callout Request Error - The error handling policy the plugin will apply to TCP and HTTP errors. Not Null
- headers
Gateway
Plugin Request Callout Config Callout Request Headers - Callout request header customizations. Not Null
- http_
opts GatewayPlugin Request Callout Config Callout Request Http Opts - HTTP connection parameters. Not Null
- method str
- The HTTP method that will be requested.
- query
Gateway
Plugin Request Callout Config Callout Request Query - Callout request query param customizations. Not Null
- url str
- The URL that will be requested. Not Null
- body Property Map
- Callout request body customizations. Not Null
- by
Lua String - Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
- error Property Map
- The error handling policy the plugin will apply to TCP and HTTP errors. Not Null
- headers Property Map
- Callout request header customizations. Not Null
- http
Opts Property Map - HTTP connection parameters. Not Null
- method String
- The HTTP method that will be requested.
- query Property Map
- Callout request query param customizations. Not Null
- url String
- The URL that will be requested. Not Null
GatewayPluginRequestCalloutConfigCalloutRequestBody, GatewayPluginRequestCalloutConfigCalloutRequestBodyArgs
- Custom Dictionary<string, string>
- The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(someluacode).
- Decode bool
- If true, decodes the request's body to make it available for customizations.
- Forward bool
- If true, forwards the incoming request's body to the callout request.
- Custom map[string]string
- The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(someluacode).
- Decode bool
- If true, decodes the request's body to make it available for customizations.
- Forward bool
- If true, forwards the incoming request's body to the callout request.
- custom Map<String,String>
- The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(someluacode).
- decode Boolean
- If true, decodes the request's body to make it available for customizations.
- forward Boolean
- If true, forwards the incoming request's body to the callout request.
- custom {[key: string]: string}
- The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(someluacode).
- decode boolean
- If true, decodes the request's body to make it available for customizations.
- forward boolean
- If true, forwards the incoming request's body to the callout request.
- custom Mapping[str, str]
- The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(someluacode).
- decode bool
- If true, decodes the request's body to make it available for customizations.
- forward bool
- If true, forwards the incoming request's body to the callout request.
- custom Map<String>
- The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(someluacode).
- decode Boolean
- If true, decodes the request's body to make it available for customizations.
- forward Boolean
- If true, forwards the incoming request's body to the callout request.
GatewayPluginRequestCalloutConfigCalloutRequestError, GatewayPluginRequestCalloutConfigCalloutRequestErrorArgs
- Error
Response doubleCode - The error code to respond with if
on_errorisfailor ifretriesis achieved. - Error
Response stringMsg - The error mesasge to respond with if
on_errorisfailor ifretriesis achieved.Templating with Lua expressions is supported. - Http
Statuses List<double> - The list of HTTP status codes considered errors under the error handling policy.
- On
Error string - must be one of ["continue", "fail", "retry"]
- Retries double
- The number of retries the plugin will attempt on TCP and HTTP errors if
on_erroris set toretry.
- Error
Response float64Code - The error code to respond with if
on_errorisfailor ifretriesis achieved. - Error
Response stringMsg - The error mesasge to respond with if
on_errorisfailor ifretriesis achieved.Templating with Lua expressions is supported. - Http
Statuses []float64 - The list of HTTP status codes considered errors under the error handling policy.
- On
Error string - must be one of ["continue", "fail", "retry"]
- Retries float64
- The number of retries the plugin will attempt on TCP and HTTP errors if
on_erroris set toretry.
- error
Response DoubleCode - The error code to respond with if
on_errorisfailor ifretriesis achieved. - error
Response StringMsg - The error mesasge to respond with if
on_errorisfailor ifretriesis achieved.Templating with Lua expressions is supported. - http
Statuses List<Double> - The list of HTTP status codes considered errors under the error handling policy.
- on
Error String - must be one of ["continue", "fail", "retry"]
- retries Double
- The number of retries the plugin will attempt on TCP and HTTP errors if
on_erroris set toretry.
- error
Response numberCode - The error code to respond with if
on_errorisfailor ifretriesis achieved. - error
Response stringMsg - The error mesasge to respond with if
on_errorisfailor ifretriesis achieved.Templating with Lua expressions is supported. - http
Statuses number[] - The list of HTTP status codes considered errors under the error handling policy.
- on
Error string - must be one of ["continue", "fail", "retry"]
- retries number
- The number of retries the plugin will attempt on TCP and HTTP errors if
on_erroris set toretry.
- error_
response_ floatcode - The error code to respond with if
on_errorisfailor ifretriesis achieved. - error_
response_ strmsg - The error mesasge to respond with if
on_errorisfailor ifretriesis achieved.Templating with Lua expressions is supported. - http_
statuses Sequence[float] - The list of HTTP status codes considered errors under the error handling policy.
- on_
error str - must be one of ["continue", "fail", "retry"]
- retries float
- The number of retries the plugin will attempt on TCP and HTTP errors if
on_erroris set toretry.
- error
Response NumberCode - The error code to respond with if
on_errorisfailor ifretriesis achieved. - error
Response StringMsg - The error mesasge to respond with if
on_errorisfailor ifretriesis achieved.Templating with Lua expressions is supported. - http
Statuses List<Number> - The list of HTTP status codes considered errors under the error handling policy.
- on
Error String - must be one of ["continue", "fail", "retry"]
- retries Number
- The number of retries the plugin will attempt on TCP and HTTP errors if
on_erroris set toretry.
GatewayPluginRequestCalloutConfigCalloutRequestHeaders, GatewayPluginRequestCalloutConfigCalloutRequestHeadersArgs
GatewayPluginRequestCalloutConfigCalloutRequestHttpOpts, GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsArgs
- Proxy
Gateway
Plugin Request Callout Config Callout Request Http Opts Proxy - Proxy settings.
- Ssl
Server stringName - The SNI used in the callout request. Defaults to host if omitted.
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - Timeouts
Gateway
Plugin Request Callout Config Callout Request Http Opts Timeouts - Socket timeouts in milliseconds. All or none must be set.
- Proxy
Gateway
Plugin Request Callout Config Callout Request Http Opts Proxy - Proxy settings.
- Ssl
Server stringName - The SNI used in the callout request. Defaults to host if omitted.
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - Timeouts
Gateway
Plugin Request Callout Config Callout Request Http Opts Timeouts - Socket timeouts in milliseconds. All or none must be set.
- proxy
Gateway
Plugin Request Callout Config Callout Request Http Opts Proxy - Proxy settings.
- ssl
Server StringName - The SNI used in the callout request. Defaults to host if omitted.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - timeouts
Gateway
Plugin Request Callout Config Callout Request Http Opts Timeouts - Socket timeouts in milliseconds. All or none must be set.
- proxy
Gateway
Plugin Request Callout Config Callout Request Http Opts Proxy - Proxy settings.
- ssl
Server stringName - The SNI used in the callout request. Defaults to host if omitted.
- ssl
Verify boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - timeouts
Gateway
Plugin Request Callout Config Callout Request Http Opts Timeouts - Socket timeouts in milliseconds. All or none must be set.
- proxy
Gateway
Plugin Request Callout Config Callout Request Http Opts Proxy - Proxy settings.
- ssl_
server_ strname - The SNI used in the callout request. Defaults to host if omitted.
- ssl_
verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - timeouts
Gateway
Plugin Request Callout Config Callout Request Http Opts Timeouts - Socket timeouts in milliseconds. All or none must be set.
- proxy Property Map
- Proxy settings.
- ssl
Server StringName - The SNI used in the callout request. Defaults to host if omitted.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - timeouts Property Map
- Socket timeouts in milliseconds. All or none must be set.
GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy, GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxyArgs
- Auth
Password string - The password to authenticate with, if the forward proxy is protected by basic authentication.
- Auth
Username string - The username to authenticate with, if the forward proxy is protected by basic authentication.
- Http
Proxy string - The HTTP proxy URL. This proxy server will be used for HTTP requests.
- Https
Proxy string - The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
- Auth
Password string - The password to authenticate with, if the forward proxy is protected by basic authentication.
- Auth
Username string - The username to authenticate with, if the forward proxy is protected by basic authentication.
- Http
Proxy string - The HTTP proxy URL. This proxy server will be used for HTTP requests.
- Https
Proxy string - The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
- auth
Password String - The password to authenticate with, if the forward proxy is protected by basic authentication.
- auth
Username String - The username to authenticate with, if the forward proxy is protected by basic authentication.
- http
Proxy String - The HTTP proxy URL. This proxy server will be used for HTTP requests.
- https
Proxy String - The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
- auth
Password string - The password to authenticate with, if the forward proxy is protected by basic authentication.
- auth
Username string - The username to authenticate with, if the forward proxy is protected by basic authentication.
- http
Proxy string - The HTTP proxy URL. This proxy server will be used for HTTP requests.
- https
Proxy string - The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
- auth_
password str - The password to authenticate with, if the forward proxy is protected by basic authentication.
- auth_
username str - The username to authenticate with, if the forward proxy is protected by basic authentication.
- http_
proxy str - The HTTP proxy URL. This proxy server will be used for HTTP requests.
- https_
proxy str - The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
- auth
Password String - The password to authenticate with, if the forward proxy is protected by basic authentication.
- auth
Username String - The username to authenticate with, if the forward proxy is protected by basic authentication.
- http
Proxy String - The HTTP proxy URL. This proxy server will be used for HTTP requests.
- https
Proxy String - The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts, GatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeoutsArgs
GatewayPluginRequestCalloutConfigCalloutRequestQuery, GatewayPluginRequestCalloutConfigCalloutRequestQueryArgs
GatewayPluginRequestCalloutConfigCalloutResponse, GatewayPluginRequestCalloutConfigCalloutResponseArgs
- Body
Gateway
Plugin Request Callout Config Callout Response Body - Not Null
- By
Lua string - Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- Headers
Gateway
Plugin Request Callout Config Callout Response Headers - Callout response header customizations. Not Null
- Body
Gateway
Plugin Request Callout Config Callout Response Body - Not Null
- By
Lua string - Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- Headers
Gateway
Plugin Request Callout Config Callout Response Headers - Callout response header customizations. Not Null
- body
Gateway
Plugin Request Callout Config Callout Response Body - Not Null
- by
Lua String - Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- headers
Gateway
Plugin Request Callout Config Callout Response Headers - Callout response header customizations. Not Null
- body
Gateway
Plugin Request Callout Config Callout Response Body - Not Null
- by
Lua string - Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- headers
Gateway
Plugin Request Callout Config Callout Response Headers - Callout response header customizations. Not Null
- body
Gateway
Plugin Request Callout Config Callout Response Body - Not Null
- by_
lua str - Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- headers
Gateway
Plugin Request Callout Config Callout Response Headers - Callout response header customizations. Not Null
- body Property Map
- Not Null
- by
Lua String - Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
- headers Property Map
- Callout response header customizations. Not Null
GatewayPluginRequestCalloutConfigCalloutResponseBody, GatewayPluginRequestCalloutConfigCalloutResponseBodyArgs
GatewayPluginRequestCalloutConfigCalloutResponseHeaders, GatewayPluginRequestCalloutConfigCalloutResponseHeadersArgs
- Store bool
- If false, skips storing the callout response headers intokong.ctx.shared.callouts.\n\n.response.headers.
- Store bool
- If false, skips storing the callout response headers intokong.ctx.shared.callouts.\n\n.response.headers.
- store Boolean
- If false, skips storing the callout response headers intokong.ctx.shared.callouts.\n\n.response.headers.
- store boolean
- If false, skips storing the callout response headers intokong.ctx.shared.callouts.\n\n.response.headers.
- store bool
- If false, skips storing the callout response headers intokong.ctx.shared.callouts.\n\n.response.headers.
- store Boolean
- If false, skips storing the callout response headers intokong.ctx.shared.callouts.\n\n.response.headers.
GatewayPluginRequestCalloutConfigUpstream, GatewayPluginRequestCalloutConfigUpstreamArgs
- Body
Gateway
Plugin Request Callout Config Upstream Body - Callout request body customizations.
- By
Lua string - Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- Headers
Gateway
Plugin Request Callout Config Upstream Headers - Callout request header customizations.
- Query
Gateway
Plugin Request Callout Config Upstream Query - Upstream request query param customizations.
- Body
Gateway
Plugin Request Callout Config Upstream Body - Callout request body customizations.
- By
Lua string - Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- Headers
Gateway
Plugin Request Callout Config Upstream Headers - Callout request header customizations.
- Query
Gateway
Plugin Request Callout Config Upstream Query - Upstream request query param customizations.
- body
Gateway
Plugin Request Callout Config Upstream Body - Callout request body customizations.
- by
Lua String - Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- headers
Gateway
Plugin Request Callout Config Upstream Headers - Callout request header customizations.
- query
Gateway
Plugin Request Callout Config Upstream Query - Upstream request query param customizations.
- body
Gateway
Plugin Request Callout Config Upstream Body - Callout request body customizations.
- by
Lua string - Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- headers
Gateway
Plugin Request Callout Config Upstream Headers - Callout request header customizations.
- query
Gateway
Plugin Request Callout Config Upstream Query - Upstream request query param customizations.
- body
Gateway
Plugin Request Callout Config Upstream Body - Callout request body customizations.
- by_
lua str - Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- headers
Gateway
Plugin Request Callout Config Upstream Headers - Callout request header customizations.
- query
Gateway
Plugin Request Callout Config Upstream Query - Upstream request query param customizations.
- body Property Map
- Callout request body customizations.
- by
Lua String - Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
- headers Property Map
- Callout request header customizations.
- query Property Map
- Upstream request query param customizations.
GatewayPluginRequestCalloutConfigUpstreamBody, GatewayPluginRequestCalloutConfigUpstreamBodyArgs
- Custom Dictionary<string, string>
- The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(someluacode).
- Decode bool
- If true, decodes the request's body to make it available for upstream by_lua customizations.
- Forward bool
- If false, skips forwarding the incoming request's body to the upstream request.
- Custom map[string]string
- The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(someluacode).
- Decode bool
- If true, decodes the request's body to make it available for upstream by_lua customizations.
- Forward bool
- If false, skips forwarding the incoming request's body to the upstream request.
- custom Map<String,String>
- The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(someluacode).
- decode Boolean
- If true, decodes the request's body to make it available for upstream by_lua customizations.
- forward Boolean
- If false, skips forwarding the incoming request's body to the upstream request.
- custom {[key: string]: string}
- The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(someluacode).
- decode boolean
- If true, decodes the request's body to make it available for upstream by_lua customizations.
- forward boolean
- If false, skips forwarding the incoming request's body to the upstream request.
- custom Mapping[str, str]
- The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(someluacode).
- decode bool
- If true, decodes the request's body to make it available for upstream by_lua customizations.
- forward bool
- If false, skips forwarding the incoming request's body to the upstream request.
- custom Map<String>
- The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(someluacode).
- decode Boolean
- If true, decodes the request's body to make it available for upstream by_lua customizations.
- forward Boolean
- If false, skips forwarding the incoming request's body to the upstream request.
GatewayPluginRequestCalloutConfigUpstreamHeaders, GatewayPluginRequestCalloutConfigUpstreamHeadersArgs
GatewayPluginRequestCalloutConfigUpstreamQuery, GatewayPluginRequestCalloutConfigUpstreamQueryArgs
GatewayPluginRequestCalloutConsumer, GatewayPluginRequestCalloutConsumerArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginRequestCalloutConsumerGroup, GatewayPluginRequestCalloutConsumerGroupArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginRequestCalloutOrdering, GatewayPluginRequestCalloutOrderingArgs
GatewayPluginRequestCalloutOrderingAfter, GatewayPluginRequestCalloutOrderingAfterArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginRequestCalloutOrderingBefore, GatewayPluginRequestCalloutOrderingBeforeArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginRequestCalloutRoute, GatewayPluginRequestCalloutRouteArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginRequestCalloutService, GatewayPluginRequestCalloutServiceArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
$ pulumi import konnect:index/gatewayPluginRequestCallout:GatewayPluginRequestCallout my_konnect_gateway_plugin_request_callout "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.