konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getGatewayPluginProxyCacheAdvanced

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Using getGatewayPluginProxyCacheAdvanced

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.

TypeScript
Python
Go
C#
Java
YAML

function getGatewayPluginProxyCacheAdvanced(args: GetGatewayPluginProxyCacheAdvancedArgs, opts?: InvokeOptions): Promise<GetGatewayPluginProxyCacheAdvancedResult>
function getGatewayPluginProxyCacheAdvancedOutput(args: GetGatewayPluginProxyCacheAdvancedOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginProxyCacheAdvancedResult>

def get_gateway_plugin_proxy_cache_advanced(control_plane_id: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetGatewayPluginProxyCacheAdvancedResult
def get_gateway_plugin_proxy_cache_advanced_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginProxyCacheAdvancedResult]

func LookupGatewayPluginProxyCacheAdvanced(ctx *Context, args *LookupGatewayPluginProxyCacheAdvancedArgs, opts ...InvokeOption) (*LookupGatewayPluginProxyCacheAdvancedResult, error)
func LookupGatewayPluginProxyCacheAdvancedOutput(ctx *Context, args *LookupGatewayPluginProxyCacheAdvancedOutputArgs, opts ...InvokeOption) LookupGatewayPluginProxyCacheAdvancedResultOutput

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

public static class GetGatewayPluginProxyCacheAdvanced 
{
    public static Task<GetGatewayPluginProxyCacheAdvancedResult> InvokeAsync(GetGatewayPluginProxyCacheAdvancedArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginProxyCacheAdvancedResult> Invoke(GetGatewayPluginProxyCacheAdvancedInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginProxyCacheAdvancedResult> getGatewayPluginProxyCacheAdvanced(GetGatewayPluginProxyCacheAdvancedArgs args, InvokeOptions options)
public static Output<GetGatewayPluginProxyCacheAdvancedResult> getGatewayPluginProxyCacheAdvanced(GetGatewayPluginProxyCacheAdvancedArgs args, InvokeOptions options)

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

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginProxyCacheAdvanced Result

The following output properties are available:

config Property Map
consumer Property Map
consumerGroup Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginProxyCacheAdvancedConfig

BypassOnErr bool: Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
CacheControl bool: When enabled, respect the Cache-Control behaviors defined in RFC7234.
CacheTtl double: TTL in seconds of cache entities.
ContentTypes List<string>: Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
IgnoreUriCase bool: Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
Memory GetGatewayPluginProxyCacheAdvancedConfigMemory
Redis GetGatewayPluginProxyCacheAdvancedConfigRedis
RequestMethods List<string>: Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
ResponseCodes List<double>: Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
ResponseHeaders GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders: Caching related diagnostic headers that should be included in cached responses
StorageTtl double: Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
Strategy string: The backing data store in which to hold cache entities. Accepted values are: memory and redis.
VaryHeaders List<string>: Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
VaryQueryParams List<string>: Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

BypassOnErr bool: Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
CacheControl bool: When enabled, respect the Cache-Control behaviors defined in RFC7234.
CacheTtl float64: TTL in seconds of cache entities.
ContentTypes []string: Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
IgnoreUriCase bool: Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
Memory GetGatewayPluginProxyCacheAdvancedConfigMemory
Redis GetGatewayPluginProxyCacheAdvancedConfigRedis
RequestMethods []string: Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
ResponseCodes []float64: Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
ResponseHeaders GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders: Caching related diagnostic headers that should be included in cached responses
StorageTtl float64: Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
Strategy string: The backing data store in which to hold cache entities. Accepted values are: memory and redis.
VaryHeaders []string: Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
VaryQueryParams []string: Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

bypassOnErr Boolean: Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cacheControl Boolean: When enabled, respect the Cache-Control behaviors defined in RFC7234.
cacheTtl Double: TTL in seconds of cache entities.
contentTypes List<String>: Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignoreUriCase Boolean: Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory GetGatewayPluginProxyCacheAdvancedConfigMemory
redis GetGatewayPluginProxyCacheAdvancedConfigRedis
requestMethods List<String>: Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
responseCodes List<Double>: Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
responseHeaders GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders: Caching related diagnostic headers that should be included in cached responses
storageTtl Double: Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy String: The backing data store in which to hold cache entities. Accepted values are: memory and redis.
varyHeaders List<String>: Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
varyQueryParams List<String>: Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

bypassOnErr boolean: Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cacheControl boolean: When enabled, respect the Cache-Control behaviors defined in RFC7234.
cacheTtl number: TTL in seconds of cache entities.
contentTypes string[]: Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignoreUriCase boolean: Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory GetGatewayPluginProxyCacheAdvancedConfigMemory
redis GetGatewayPluginProxyCacheAdvancedConfigRedis
requestMethods string[]: Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
responseCodes number[]: Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
responseHeaders GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders: Caching related diagnostic headers that should be included in cached responses
storageTtl number: Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy string: The backing data store in which to hold cache entities. Accepted values are: memory and redis.
varyHeaders string[]: Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
varyQueryParams string[]: Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

bypass_on_err bool: Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cache_control bool: When enabled, respect the Cache-Control behaviors defined in RFC7234.
cache_ttl float: TTL in seconds of cache entities.
content_types Sequence[str]: Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignore_uri_case bool: Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory GetGatewayPluginProxyCacheAdvancedConfigMemory
redis GetGatewayPluginProxyCacheAdvancedConfigRedis
request_methods Sequence[str]: Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
response_codes Sequence[float]: Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
response_headers GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders: Caching related diagnostic headers that should be included in cached responses
storage_ttl float: Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy str: The backing data store in which to hold cache entities. Accepted values are: memory and redis.
vary_headers Sequence[str]: Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
vary_query_params Sequence[str]: Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

bypassOnErr Boolean: Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cacheControl Boolean: When enabled, respect the Cache-Control behaviors defined in RFC7234.
cacheTtl Number: TTL in seconds of cache entities.
contentTypes List<String>: Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignoreUriCase Boolean: Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory Property Map
redis Property Map
requestMethods List<String>: Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
responseCodes List<Number>: Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
responseHeaders Property Map: Caching related diagnostic headers that should be included in cached responses
storageTtl Number: Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy String: The backing data store in which to hold cache entities. Accepted values are: memory and redis.
varyHeaders List<String>: Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
varyQueryParams List<String>: Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

GetGatewayPluginProxyCacheAdvancedConfigMemory

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.

GetGatewayPluginProxyCacheAdvancedConfigRedis

ClusterMaxRedirections double: Maximum retry attempts for redirection.
ClusterNodes List<GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode>: 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<GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode>: 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 []GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode: 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 []GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode: 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<GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode>: 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<GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode>: 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 GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode[]: 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 GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode[]: 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[GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode]: 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[GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode]: 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.

GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode

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.

GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode

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.

GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders

Age bool
XCacheKey bool
XCacheStatus bool

Age bool
XCacheKey bool
XCacheStatus bool

age Boolean
xCacheKey Boolean
xCacheStatus Boolean

age boolean
xCacheKey boolean
xCacheStatus boolean

age bool
x_cache_key bool
x_cache_status bool

age Boolean
xCacheKey Boolean
xCacheStatus Boolean

GetGatewayPluginProxyCacheAdvancedConsumer

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginProxyCacheAdvancedConsumerGroup

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginProxyCacheAdvancedOrdering

After GetGatewayPluginProxyCacheAdvancedOrderingAfter
Before GetGatewayPluginProxyCacheAdvancedOrderingBefore

After GetGatewayPluginProxyCacheAdvancedOrderingAfter
Before GetGatewayPluginProxyCacheAdvancedOrderingBefore

after GetGatewayPluginProxyCacheAdvancedOrderingAfter
before GetGatewayPluginProxyCacheAdvancedOrderingBefore

after GetGatewayPluginProxyCacheAdvancedOrderingAfter
before GetGatewayPluginProxyCacheAdvancedOrderingBefore

after GetGatewayPluginProxyCacheAdvancedOrderingAfter
before GetGatewayPluginProxyCacheAdvancedOrderingBefore

after Property Map
before Property Map

GetGatewayPluginProxyCacheAdvancedOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginProxyCacheAdvancedOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginProxyCacheAdvancedRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginProxyCacheAdvancedService

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 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginProxyCacheAdvanced

On this page

On this page

Using getGatewayPluginProxyCacheAdvanced

getGatewayPluginProxyCacheAdvanced Result

Supporting Types

GetGatewayPluginProxyCacheAdvancedConfig

GetGatewayPluginProxyCacheAdvancedConfigMemory

GetGatewayPluginProxyCacheAdvancedConfigRedis

GetGatewayPluginProxyCacheAdvancedConfigRedisClusterNode

GetGatewayPluginProxyCacheAdvancedConfigRedisSentinelNode

GetGatewayPluginProxyCacheAdvancedConfigResponseHeaders

GetGatewayPluginProxyCacheAdvancedConsumer

GetGatewayPluginProxyCacheAdvancedConsumerGroup

GetGatewayPluginProxyCacheAdvancedOrdering

GetGatewayPluginProxyCacheAdvancedOrderingAfter

GetGatewayPluginProxyCacheAdvancedOrderingBefore

GetGatewayPluginProxyCacheAdvancedRoute

GetGatewayPluginProxyCacheAdvancedService

Package Details

On this page

On this page