Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginRequestCallout
konnect 2.7.3 published on Tuesday, May 13, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginRequestCallout

Explore with Pulumi AI

konnect logo
konnect 2.7.3 published on Tuesday, May 13, 2025 by kong
kong/terraform-provider-konnect

    Using getGatewayPluginRequestCallout

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGatewayPluginRequestCallout(args: GetGatewayPluginRequestCalloutArgs, opts?: InvokeOptions): Promise<GetGatewayPluginRequestCalloutResult>
function getGatewayPluginRequestCalloutOutput(args: GetGatewayPluginRequestCalloutOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginRequestCalloutResult>
    def get_gateway_plugin_request_callout(control_plane_id: Optional[str] = None,
                                       opts: Optional[InvokeOptions] = None) -> GetGatewayPluginRequestCalloutResult
def get_gateway_plugin_request_callout_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                       opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginRequestCalloutResult]
    func LookupGatewayPluginRequestCallout(ctx *Context, args *LookupGatewayPluginRequestCalloutArgs, opts ...InvokeOption) (*LookupGatewayPluginRequestCalloutResult, error)
func LookupGatewayPluginRequestCalloutOutput(ctx *Context, args *LookupGatewayPluginRequestCalloutOutputArgs, opts ...InvokeOption) LookupGatewayPluginRequestCalloutResultOutput

    > Note: This function is named LookupGatewayPluginRequestCallout in the Go SDK.

    public static class GetGatewayPluginRequestCallout 
{
    public static Task<GetGatewayPluginRequestCalloutResult> InvokeAsync(GetGatewayPluginRequestCalloutArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginRequestCalloutResult> Invoke(GetGatewayPluginRequestCalloutInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayPluginRequestCalloutResult> getGatewayPluginRequestCallout(GetGatewayPluginRequestCalloutArgs args, InvokeOptions options)
public static Output<GetGatewayPluginRequestCalloutResult> getGatewayPluginRequestCallout(GetGatewayPluginRequestCalloutArgs args, InvokeOptions options)

    fn::invoke:
  function: konnect:index/getGatewayPluginRequestCallout:getGatewayPluginRequestCallout
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getGatewayPluginRequestCallout Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginRequestCalloutConfig

    Cache GetGatewayPluginRequestCalloutConfigCache
    Plugin global caching configuration.
    Callouts List<GetGatewayPluginRequestCalloutConfigCallout>
    A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
    Upstream GetGatewayPluginRequestCalloutConfigUpstream
    Customizations to the upstream request.
    Cache GetGatewayPluginRequestCalloutConfigCache
    Plugin global caching configuration.
    Callouts []GetGatewayPluginRequestCalloutConfigCallout
    A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
    Upstream GetGatewayPluginRequestCalloutConfigUpstream
    Customizations to the upstream request.
    cache GetGatewayPluginRequestCalloutConfigCache
    Plugin global caching configuration.
    callouts List<GetGatewayPluginRequestCalloutConfigCallout>
    A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
    upstream GetGatewayPluginRequestCalloutConfigUpstream
    Customizations to the upstream request.
    cache GetGatewayPluginRequestCalloutConfigCache
    Plugin global caching configuration.
    callouts GetGatewayPluginRequestCalloutConfigCallout[]
    A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
    upstream GetGatewayPluginRequestCalloutConfigUpstream
    Customizations to the upstream request.
    cache GetGatewayPluginRequestCalloutConfigCache
    Plugin global caching configuration.
    callouts Sequence[GetGatewayPluginRequestCalloutConfigCallout]
    A collection of callout objects, where each object represents an HTTPrequest made in the context of a proxy request.
    upstream GetGatewayPluginRequestCalloutConfigUpstream
    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.

    GetGatewayPluginRequestCalloutConfigCache

    CacheTtl double
    TTL in seconds of cache entities.
    Memory GetGatewayPluginRequestCalloutConfigCacheMemory
    Redis GetGatewayPluginRequestCalloutConfigCacheRedis
    Strategy string
    The backing data store in which to hold cache entities. Accepted values are: off, memory, and redis.
    CacheTtl float64
    TTL in seconds of cache entities.
    Memory GetGatewayPluginRequestCalloutConfigCacheMemory
    Redis GetGatewayPluginRequestCalloutConfigCacheRedis
    Strategy string
    The backing data store in which to hold cache entities. Accepted values are: off, memory, and redis.
    cacheTtl Double
    TTL in seconds of cache entities.
    memory GetGatewayPluginRequestCalloutConfigCacheMemory
    redis GetGatewayPluginRequestCalloutConfigCacheRedis
    strategy String
    The backing data store in which to hold cache entities. Accepted values are: off, memory, and redis.
    cacheTtl number
    TTL in seconds of cache entities.
    memory GetGatewayPluginRequestCalloutConfigCacheMemory
    redis GetGatewayPluginRequestCalloutConfigCacheRedis
    strategy string
    The backing data store in which to hold cache entities. Accepted values are: off, memory, and redis.
    cache_ttl float
    TTL in seconds of cache entities.
    memory GetGatewayPluginRequestCalloutConfigCacheMemory
    redis GetGatewayPluginRequestCalloutConfigCacheRedis
    strategy str
    The backing data store in which to hold cache entities. Accepted values are: off, memory, and redis.
    cacheTtl 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, and redis.

    GetGatewayPluginRequestCalloutConfigCacheMemory

    DictionaryName 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.
    DictionaryName 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.
    dictionaryName 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.
    dictionaryName 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.
    dictionaryName 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.

    GetGatewayPluginRequestCalloutConfigCacheRedis

    ClusterMaxRedirections double
    Maximum retry attempts for redirection.
    ClusterNodes List<GetGatewayPluginRequestCalloutConfigCacheRedisClusterNode>
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    ConnectTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    ConnectionIsProxied bool
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    Database double
    Database to use for the Redis connection when using the redis strategy
    Host string
    A string representing a host name, such as example.com.
    KeepaliveBacklog 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 than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    KeepalivePoolSize double
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is 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.
    ReadTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SendTimeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SentinelMaster string
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    SentinelNodes List<GetGatewayPluginRequestCalloutConfigCacheRedisSentinelNode>
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    SentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    SentinelRole string
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
    SentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    ServerName string
    A string representing an SNI (server name indication) value for TLS.
    Ssl bool
    If set to true, uses SSL to connect to Redis.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    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.
    ClusterMaxRedirections float64
    Maximum retry attempts for redirection.
    ClusterNodes []GetGatewayPluginRequestCalloutConfigCacheRedisClusterNode
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    ConnectTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    ConnectionIsProxied bool
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    Database float64
    Database to use for the Redis connection when using the redis strategy
    Host string
    A string representing a host name, such as example.com.
    KeepaliveBacklog 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 than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    KeepalivePoolSize float64
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is 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.
    ReadTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SendTimeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    SentinelMaster string
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    SentinelNodes []GetGatewayPluginRequestCalloutConfigCacheRedisSentinelNode
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    SentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    SentinelRole string
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
    SentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    ServerName string
    A string representing an SNI (server name indication) value for TLS.
    Ssl bool
    If set to true, uses SSL to connect to Redis.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    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.
    clusterMaxRedirections Double
    Maximum retry attempts for redirection.
    clusterNodes List<GetGatewayPluginRequestCalloutConfigCacheRedisClusterNode>
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connectTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connectionIsProxied Boolean
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database Double
    Database to use for the Redis connection when using the redis strategy
    host String
    A string representing a host name, such as example.com.
    keepaliveBacklog 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 than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalivePoolSize Double
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is 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.
    readTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sendTimeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinelMaster String
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinelNodes List<GetGatewayPluginRequestCalloutConfigCacheRedisSentinelNode>
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinelPassword String
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinelRole String
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
    sentinelUsername String
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    serverName String
    A string representing an SNI (server name indication) value for TLS.
    ssl Boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    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.
    clusterMaxRedirections number
    Maximum retry attempts for redirection.
    clusterNodes GetGatewayPluginRequestCalloutConfigCacheRedisClusterNode[]
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connectTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connectionIsProxied boolean
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database number
    Database to use for the Redis connection when using the redis strategy
    host string
    A string representing a host name, such as example.com.
    keepaliveBacklog 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 than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalivePoolSize number
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is 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.
    readTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sendTimeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinelMaster string
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinelNodes GetGatewayPluginRequestCalloutConfigCacheRedisSentinelNode[]
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinelPassword string
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinelRole string
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
    sentinelUsername string
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    serverName string
    A string representing an SNI (server name indication) value for TLS.
    ssl boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify boolean
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    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_redirections float
    Maximum retry attempts for redirection.
    cluster_nodes Sequence[GetGatewayPluginRequestCalloutConfigCacheRedisClusterNode]
    Cluster addresses to use for Redis connections when the redis strategy 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_proxied bool
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database float
    Database to use for the Redis connection when using the redis strategy
    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 than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalive_pool_size float
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is 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[GetGatewayPluginRequestCalloutConfigCacheRedisSentinelNode]
    Sentinel node addresses to use for Redis connections when the redis strategy 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 redis strategy is defined. Defining this value implies using Redis Sentinel.
    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_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    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.
    clusterMaxRedirections Number
    Maximum retry attempts for redirection.
    clusterNodes List<Property Map>
    Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.
    connectTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    connectionIsProxied Boolean
    If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.
    database Number
    Database to use for the Redis connection when using the redis strategy
    host String
    A string representing a host name, such as example.com.
    keepaliveBacklog 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 than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.
    keepalivePoolSize Number
    The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is 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.
    readTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sendTimeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    sentinelMaster String
    Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
    sentinelNodes List<Property Map>
    Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.
    sentinelPassword String
    Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
    sentinelRole String
    Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel.
    sentinelUsername String
    Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
    serverName String
    A string representing an SNI (server name indication) value for TLS.
    ssl Boolean
    If set to true, uses SSL to connect to Redis.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    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.

    GetGatewayPluginRequestCalloutConfigCacheRedisClusterNode

    Ip string
    A string representing a host name, such as example.com.
    Port double
    An integer representing a port number between 0 and 65535, inclusive.
    Ip string
    A string representing a host name, such as example.com.
    Port float64
    An integer representing a port number between 0 and 65535, inclusive.
    ip String
    A string representing a host name, such as example.com.
    port Double
    An integer representing a port number between 0 and 65535, inclusive.
    ip string
    A string representing a host name, such as example.com.
    port number
    An integer representing a port number between 0 and 65535, inclusive.
    ip str
    A string representing a host name, such as example.com.
    port float
    An integer representing a port number between 0 and 65535, inclusive.
    ip String
    A string representing a host name, such as example.com.
    port Number
    An integer representing a port number between 0 and 65535, inclusive.

    GetGatewayPluginRequestCalloutConfigCacheRedisSentinelNode

    Host string
    A string representing a host name, such as example.com.
    Port double
    An integer representing a port number between 0 and 65535, inclusive.
    Host string
    A string representing a host name, such as example.com.
    Port float64
    An integer representing a port number between 0 and 65535, inclusive.
    host String
    A string representing a host name, such as example.com.
    port Double
    An integer representing a port number between 0 and 65535, inclusive.
    host string
    A string representing a host name, such as example.com.
    port number
    An integer representing a port number between 0 and 65535, inclusive.
    host str
    A string representing a host name, such as example.com.
    port float
    An integer representing a port number between 0 and 65535, inclusive.
    host String
    A string representing a host name, such as example.com.
    port Number
    An integer representing a port number between 0 and 65535, inclusive.

    GetGatewayPluginRequestCalloutConfigCallout

    Cache GetGatewayPluginRequestCalloutConfigCalloutCache
    Callout caching configuration.
    DependsOns 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.
    Request GetGatewayPluginRequestCalloutConfigCalloutRequest
    The customizations for the callout request.
    Response GetGatewayPluginRequestCalloutConfigCalloutResponse
    Configurations of callout response handling.
    Cache GetGatewayPluginRequestCalloutConfigCalloutCache
    Callout caching configuration.
    DependsOns []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.
    Request GetGatewayPluginRequestCalloutConfigCalloutRequest
    The customizations for the callout request.
    Response GetGatewayPluginRequestCalloutConfigCalloutResponse
    Configurations of callout response handling.
    cache GetGatewayPluginRequestCalloutConfigCalloutCache
    Callout caching configuration.
    dependsOns 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.
    request GetGatewayPluginRequestCalloutConfigCalloutRequest
    The customizations for the callout request.
    response GetGatewayPluginRequestCalloutConfigCalloutResponse
    Configurations of callout response handling.
    cache GetGatewayPluginRequestCalloutConfigCalloutCache
    Callout caching configuration.
    dependsOns 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.
    request GetGatewayPluginRequestCalloutConfigCalloutRequest
    The customizations for the callout request.
    response GetGatewayPluginRequestCalloutConfigCalloutResponse
    Configurations of callout response handling.
    cache GetGatewayPluginRequestCalloutConfigCalloutCache
    Callout caching configuration.
    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.
    request GetGatewayPluginRequestCalloutConfigCalloutRequest
    The customizations for the callout request.
    response GetGatewayPluginRequestCalloutConfigCalloutResponse
    Configurations of callout response handling.
    cache Property Map
    Callout caching configuration.
    dependsOns 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.
    request Property Map
    The customizations for the callout request.
    response Property Map
    Configurations of callout response handling.

    GetGatewayPluginRequestCalloutConfigCalloutCache

    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.

    GetGatewayPluginRequestCalloutConfigCalloutRequest

    Body GetGatewayPluginRequestCalloutConfigCalloutRequestBody
    Callout request body customizations.
    ByLua string
    Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
    Error GetGatewayPluginRequestCalloutConfigCalloutRequestError
    The error handling policy the plugin will apply to TCP and HTTP errors.
    Headers GetGatewayPluginRequestCalloutConfigCalloutRequestHeaders
    Callout request header customizations.
    HttpOpts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOpts
    HTTP connection parameters.
    Method string
    The HTTP method that will be requested.
    Query GetGatewayPluginRequestCalloutConfigCalloutRequestQuery
    Callout request query param customizations.
    Url string
    The URL that will be requested.
    Body GetGatewayPluginRequestCalloutConfigCalloutRequestBody
    Callout request body customizations.
    ByLua string
    Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
    Error GetGatewayPluginRequestCalloutConfigCalloutRequestError
    The error handling policy the plugin will apply to TCP and HTTP errors.
    Headers GetGatewayPluginRequestCalloutConfigCalloutRequestHeaders
    Callout request header customizations.
    HttpOpts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOpts
    HTTP connection parameters.
    Method string
    The HTTP method that will be requested.
    Query GetGatewayPluginRequestCalloutConfigCalloutRequestQuery
    Callout request query param customizations.
    Url string
    The URL that will be requested.
    body GetGatewayPluginRequestCalloutConfigCalloutRequestBody
    Callout request body customizations.
    byLua String
    Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
    error GetGatewayPluginRequestCalloutConfigCalloutRequestError
    The error handling policy the plugin will apply to TCP and HTTP errors.
    headers GetGatewayPluginRequestCalloutConfigCalloutRequestHeaders
    Callout request header customizations.
    httpOpts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOpts
    HTTP connection parameters.
    method String
    The HTTP method that will be requested.
    query GetGatewayPluginRequestCalloutConfigCalloutRequestQuery
    Callout request query param customizations.
    url String
    The URL that will be requested.
    body GetGatewayPluginRequestCalloutConfigCalloutRequestBody
    Callout request body customizations.
    byLua string
    Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
    error GetGatewayPluginRequestCalloutConfigCalloutRequestError
    The error handling policy the plugin will apply to TCP and HTTP errors.
    headers GetGatewayPluginRequestCalloutConfigCalloutRequestHeaders
    Callout request header customizations.
    httpOpts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOpts
    HTTP connection parameters.
    method string
    The HTTP method that will be requested.
    query GetGatewayPluginRequestCalloutConfigCalloutRequestQuery
    Callout request query param customizations.
    url string
    The URL that will be requested.
    body GetGatewayPluginRequestCalloutConfigCalloutRequestBody
    Callout request body customizations.
    by_lua str
    Lua code that executes before the callout request is made.Standard Lua sandboxing restrictions apply.
    error GetGatewayPluginRequestCalloutConfigCalloutRequestError
    The error handling policy the plugin will apply to TCP and HTTP errors.
    headers GetGatewayPluginRequestCalloutConfigCalloutRequestHeaders
    Callout request header customizations.
    http_opts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOpts
    HTTP connection parameters.
    method str
    The HTTP method that will be requested.
    query GetGatewayPluginRequestCalloutConfigCalloutRequestQuery
    Callout request query param customizations.
    url str
    The URL that will be requested.
    body Property Map
    Callout request body customizations.
    byLua 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.
    headers Property Map
    Callout request header customizations.
    httpOpts Property Map
    HTTP connection parameters.
    method String
    The HTTP method that will be requested.
    query Property Map
    Callout request query param customizations.
    url String
    The URL that will be requested.

    GetGatewayPluginRequestCalloutConfigCalloutRequestBody

    Custom Dictionary<string, string>
    The custom body fields to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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.

    GetGatewayPluginRequestCalloutConfigCalloutRequestError

    ErrorResponseCode double
    The error code to respond with if on_error is fail or if retries is achieved.
    ErrorResponseMsg string
    The error mesasge to respond with if on_error is fail or if retries is achieved.Templating with Lua expressions is supported.
    HttpStatuses List<double>
    The list of HTTP status codes considered errors under the error handling policy.
    OnError string
    Retries double
    The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.
    ErrorResponseCode float64
    The error code to respond with if on_error is fail or if retries is achieved.
    ErrorResponseMsg string
    The error mesasge to respond with if on_error is fail or if retries is achieved.Templating with Lua expressions is supported.
    HttpStatuses []float64
    The list of HTTP status codes considered errors under the error handling policy.
    OnError string
    Retries float64
    The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.
    errorResponseCode Double
    The error code to respond with if on_error is fail or if retries is achieved.
    errorResponseMsg String
    The error mesasge to respond with if on_error is fail or if retries is achieved.Templating with Lua expressions is supported.
    httpStatuses List<Double>
    The list of HTTP status codes considered errors under the error handling policy.
    onError String
    retries Double
    The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.
    errorResponseCode number
    The error code to respond with if on_error is fail or if retries is achieved.
    errorResponseMsg string
    The error mesasge to respond with if on_error is fail or if retries is achieved.Templating with Lua expressions is supported.
    httpStatuses number[]
    The list of HTTP status codes considered errors under the error handling policy.
    onError string
    retries number
    The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.
    error_response_code float
    The error code to respond with if on_error is fail or if retries is achieved.
    error_response_msg str
    The error mesasge to respond with if on_error is fail or if retries is 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
    retries float
    The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.
    errorResponseCode Number
    The error code to respond with if on_error is fail or if retries is achieved.
    errorResponseMsg String
    The error mesasge to respond with if on_error is fail or if retries is achieved.Templating with Lua expressions is supported.
    httpStatuses List<Number>
    The list of HTTP status codes considered errors under the error handling policy.
    onError String
    retries Number
    The number of retries the plugin will attempt on TCP and HTTP errors if on_error is set to retry.

    GetGatewayPluginRequestCalloutConfigCalloutRequestHeaders

    Custom Dictionary<string, string>
    The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If true, forwards the incoming request's headers to the callout request.
    Custom map[string]string
    The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If true, forwards the incoming request's headers to the callout request.
    custom Map<String,String>
    The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If true, forwards the incoming request's headers to the callout request.
    custom {[key: string]: string}
    The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward boolean
    If true, forwards the incoming request's headers to the callout request.
    custom Mapping[str, str]
    The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward bool
    If true, forwards the incoming request's headers to the callout request.
    custom Map<String>
    The custom headers to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If true, forwards the incoming request's headers to the callout request.

    GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOpts

    Proxy GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy
    Proxy settings.
    SslServerName string
    The SNI used in the callout request. Defaults to host if omitted.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    Timeouts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts
    Socket timeouts in milliseconds. All or none must be set.
    Proxy GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy
    Proxy settings.
    SslServerName string
    The SNI used in the callout request. Defaults to host if omitted.
    SslVerify bool
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    Timeouts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts
    Socket timeouts in milliseconds. All or none must be set.
    proxy GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy
    Proxy settings.
    sslServerName String
    The SNI used in the callout request. Defaults to host if omitted.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    timeouts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts
    Socket timeouts in milliseconds. All or none must be set.
    proxy GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy
    Proxy settings.
    sslServerName string
    The SNI used in the callout request. Defaults to host if omitted.
    sslVerify boolean
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    timeouts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts
    Socket timeouts in milliseconds. All or none must be set.
    proxy GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy
    Proxy settings.
    ssl_server_name str
    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_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    timeouts GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts
    Socket timeouts in milliseconds. All or none must be set.
    proxy Property Map
    Proxy settings.
    sslServerName String
    The SNI used in the callout request. Defaults to host if omitted.
    sslVerify Boolean
    If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.
    timeouts Property Map
    Socket timeouts in milliseconds. All or none must be set.

    GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsProxy

    AuthPassword string
    The password to authenticate with, if the forward proxy is protected by basic authentication.
    AuthUsername string
    The username to authenticate with, if the forward proxy is protected by basic authentication.
    HttpProxy string
    The HTTP proxy URL. This proxy server will be used for HTTP requests.
    HttpsProxy string
    The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
    AuthPassword string
    The password to authenticate with, if the forward proxy is protected by basic authentication.
    AuthUsername string
    The username to authenticate with, if the forward proxy is protected by basic authentication.
    HttpProxy string
    The HTTP proxy URL. This proxy server will be used for HTTP requests.
    HttpsProxy string
    The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
    authPassword String
    The password to authenticate with, if the forward proxy is protected by basic authentication.
    authUsername String
    The username to authenticate with, if the forward proxy is protected by basic authentication.
    httpProxy String
    The HTTP proxy URL. This proxy server will be used for HTTP requests.
    httpsProxy String
    The HTTPS proxy URL. This proxy server will be used for HTTPS requests.
    authPassword string
    The password to authenticate with, if the forward proxy is protected by basic authentication.
    authUsername string
    The username to authenticate with, if the forward proxy is protected by basic authentication.
    httpProxy string
    The HTTP proxy URL. This proxy server will be used for HTTP requests.
    httpsProxy 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.
    authPassword String
    The password to authenticate with, if the forward proxy is protected by basic authentication.
    authUsername String
    The username to authenticate with, if the forward proxy is protected by basic authentication.
    httpProxy String
    The HTTP proxy URL. This proxy server will be used for HTTP requests.
    httpsProxy String
    The HTTPS proxy URL. This proxy server will be used for HTTPS requests.

    GetGatewayPluginRequestCalloutConfigCalloutRequestHttpOptsTimeouts

    Connect double
    The socket connect timeout.
    Read double
    The socket read timeout.
    Write double
    The socket write timeout.
    Connect float64
    The socket connect timeout.
    Read float64
    The socket read timeout.
    Write float64
    The socket write timeout.
    connect Double
    The socket connect timeout.
    read Double
    The socket read timeout.
    write Double
    The socket write timeout.
    connect number
    The socket connect timeout.
    read number
    The socket read timeout.
    write number
    The socket write timeout.
    connect float
    The socket connect timeout.
    read float
    The socket read timeout.
    write float
    The socket write timeout.
    connect Number
    The socket connect timeout.
    read Number
    The socket read timeout.
    write Number
    The socket write timeout.

    GetGatewayPluginRequestCalloutConfigCalloutRequestQuery

    Custom Dictionary<string, string>
    The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If true, forwards the incoming request's query params to the callout request.
    Custom map[string]string
    The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If true, forwards the incoming request's query params to the callout request.
    custom Map<String,String>
    The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If true, forwards the incoming request's query params to the callout request.
    custom {[key: string]: string}
    The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward boolean
    If true, forwards the incoming request's query params to the callout request.
    custom Mapping[str, str]
    The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward bool
    If true, forwards the incoming request's query params to the callout request.
    custom Map<String>
    The custom query params to be added in the callout HTTP request.Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If true, forwards the incoming request's query params to the callout request.

    GetGatewayPluginRequestCalloutConfigCalloutResponse

    Body GetGatewayPluginRequestCalloutConfigCalloutResponseBody
    ByLua string
    Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
    Headers GetGatewayPluginRequestCalloutConfigCalloutResponseHeaders
    Callout response header customizations.
    Body GetGatewayPluginRequestCalloutConfigCalloutResponseBody
    ByLua string
    Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
    Headers GetGatewayPluginRequestCalloutConfigCalloutResponseHeaders
    Callout response header customizations.
    body GetGatewayPluginRequestCalloutConfigCalloutResponseBody
    byLua String
    Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
    headers GetGatewayPluginRequestCalloutConfigCalloutResponseHeaders
    Callout response header customizations.
    body GetGatewayPluginRequestCalloutConfigCalloutResponseBody
    byLua string
    Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
    headers GetGatewayPluginRequestCalloutConfigCalloutResponseHeaders
    Callout response header customizations.
    body GetGatewayPluginRequestCalloutConfigCalloutResponseBody
    by_lua str
    Lua code that executes after the callout request is made, before caching takes place. Standard Lua sandboxing restrictions apply.
    headers GetGatewayPluginRequestCalloutConfigCalloutResponseHeaders
    Callout response header customizations.
    body Property Map
    byLua 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.

    GetGatewayPluginRequestCalloutConfigCalloutResponseBody

    Decode bool
    If true, decodes the response body before storing into the context. Only JSON is supported.
    Store bool
    If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.
    Decode bool
    If true, decodes the response body before storing into the context. Only JSON is supported.
    Store bool
    If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.
    decode Boolean
    If true, decodes the response body before storing into the context. Only JSON is supported.
    store Boolean
    If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.
    decode boolean
    If true, decodes the response body before storing into the context. Only JSON is supported.
    store boolean
    If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.
    decode bool
    If true, decodes the response body before storing into the context. Only JSON is supported.
    store bool
    If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.
    decode Boolean
    If true, decodes the response body before storing into the context. Only JSON is supported.
    store Boolean
    If false, skips storing the callout response body into kong.ctx.shared.callouts..response.body.

    GetGatewayPluginRequestCalloutConfigCalloutResponseHeaders

    Store bool
    If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.
    Store bool
    If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.
    store Boolean
    If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.
    store boolean
    If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.
    store bool
    If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.
    store Boolean
    If false, skips storing the callout response headers intokong.ctx.shared.callouts..response.headers.

    GetGatewayPluginRequestCalloutConfigUpstream

    Body GetGatewayPluginRequestCalloutConfigUpstreamBody
    Callout request body customizations.
    ByLua string
    Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
    Headers GetGatewayPluginRequestCalloutConfigUpstreamHeaders
    Callout request header customizations.
    Query GetGatewayPluginRequestCalloutConfigUpstreamQuery
    Upstream request query param customizations.
    Body GetGatewayPluginRequestCalloutConfigUpstreamBody
    Callout request body customizations.
    ByLua string
    Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
    Headers GetGatewayPluginRequestCalloutConfigUpstreamHeaders
    Callout request header customizations.
    Query GetGatewayPluginRequestCalloutConfigUpstreamQuery
    Upstream request query param customizations.
    body GetGatewayPluginRequestCalloutConfigUpstreamBody
    Callout request body customizations.
    byLua String
    Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
    headers GetGatewayPluginRequestCalloutConfigUpstreamHeaders
    Callout request header customizations.
    query GetGatewayPluginRequestCalloutConfigUpstreamQuery
    Upstream request query param customizations.
    body GetGatewayPluginRequestCalloutConfigUpstreamBody
    Callout request body customizations.
    byLua string
    Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
    headers GetGatewayPluginRequestCalloutConfigUpstreamHeaders
    Callout request header customizations.
    query GetGatewayPluginRequestCalloutConfigUpstreamQuery
    Upstream request query param customizations.
    body GetGatewayPluginRequestCalloutConfigUpstreamBody
    Callout request body customizations.
    by_lua str
    Lua code that executes before the upstream request is made. Standard Lua sandboxing restrictions apply.
    headers GetGatewayPluginRequestCalloutConfigUpstreamHeaders
    Callout request header customizations.
    query GetGatewayPluginRequestCalloutConfigUpstreamQuery
    Upstream request query param customizations.
    body Property Map
    Callout request body customizations.
    byLua 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.

    GetGatewayPluginRequestCalloutConfigUpstreamBody

    Custom Dictionary<string, string>
    The custom body fields to be added in the upstream request body. Values can contain Lua expressions in the form $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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 $(some_lua_code).
    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.

    GetGatewayPluginRequestCalloutConfigUpstreamHeaders

    Custom Dictionary<string, string>
    The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If false, does not forward request headers to upstream request.
    Custom map[string]string
    The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If false, does not forward request headers to upstream request.
    custom Map<String,String>
    The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If false, does not forward request headers to upstream request.
    custom {[key: string]: string}
    The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward boolean
    If false, does not forward request headers to upstream request.
    custom Mapping[str, str]
    The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward bool
    If false, does not forward request headers to upstream request.
    custom Map<String>
    The custom headers to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If false, does not forward request headers to upstream request.

    GetGatewayPluginRequestCalloutConfigUpstreamQuery

    Custom Dictionary<string, string>
    The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If false, does not forward request query params to upstream request.
    Custom map[string]string
    The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    Forward bool
    If false, does not forward request query params to upstream request.
    custom Map<String,String>
    The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If false, does not forward request query params to upstream request.
    custom {[key: string]: string}
    The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward boolean
    If false, does not forward request query params to upstream request.
    custom Mapping[str, str]
    The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward bool
    If false, does not forward request query params to upstream request.
    custom Map<String>
    The custom query params to be added in the upstream HTTP request. Values can contain Lua expressions in the form $(some_lua_code).
    forward Boolean
    If false, does not forward request query params to upstream request.

    GetGatewayPluginRequestCalloutConsumer

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginRequestCalloutConsumerGroup

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginRequestCalloutOrdering

    GetGatewayPluginRequestCalloutOrderingAfter

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginRequestCalloutOrderingBefore

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginRequestCalloutRoute

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginRequestCalloutService

    Id string
    Id string
    id String
    id string
    id str
    id String

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 2.7.3 published on Tuesday, May 13, 2025 by kong
    kong/terraform-provider-konnect