konnect.GatewayPluginGraphqlProxyCacheAdvanced

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args GatewayPluginGraphqlProxyCacheAdvancedArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

resource_name str

The unique name of the resource.

args GatewayPluginGraphqlProxyCacheAdvancedArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name string

The unique name of the resource.

args GatewayPluginGraphqlProxyCacheAdvancedArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginGraphqlProxyCacheAdvancedArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginGraphqlProxyCacheAdvancedArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Config GatewayPluginGraphqlProxyCacheAdvancedConfig

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Consumer GatewayPluginGraphqlProxyCacheAdvancedConsumer

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

Enabled bool

Whether the plugin is applied.

GatewayPluginGraphqlProxyCacheAdvancedId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginGraphqlProxyCacheAdvancedOrdering

Protocols List<string>

A set of strings representing HTTP protocols.

Route GatewayPluginGraphqlProxyCacheAdvancedRoute

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

Service GatewayPluginGraphqlProxyCacheAdvancedService

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

Tags List<string>

An optional set of strings associated with the Plugin for grouping and filtering.

Config GatewayPluginGraphqlProxyCacheAdvancedConfigArgs

ControlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

Consumer GatewayPluginGraphqlProxyCacheAdvancedConsumerArgs

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

Enabled bool

Whether the plugin is applied.

GatewayPluginGraphqlProxyCacheAdvancedId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginGraphqlProxyCacheAdvancedOrderingArgs

Protocols []string

A set of strings representing HTTP protocols.

Route GatewayPluginGraphqlProxyCacheAdvancedRouteArgs

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

Service GatewayPluginGraphqlProxyCacheAdvancedServiceArgs

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

Tags []string

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginGraphqlProxyCacheAdvancedConfig

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

consumer GatewayPluginGraphqlProxyCacheAdvancedConsumer

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

enabled Boolean

Whether the plugin is applied.

gatewayPluginGraphqlProxyCacheAdvancedId String

The ID of this resource.

instanceName String

ordering GatewayPluginGraphqlProxyCacheAdvancedOrdering

protocols List<String>

A set of strings representing HTTP protocols.

route GatewayPluginGraphqlProxyCacheAdvancedRoute

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

service GatewayPluginGraphqlProxyCacheAdvancedService

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

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginGraphqlProxyCacheAdvancedConfig

controlPlaneId string

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

consumer GatewayPluginGraphqlProxyCacheAdvancedConsumer

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

enabled boolean

Whether the plugin is applied.

gatewayPluginGraphqlProxyCacheAdvancedId string

The ID of this resource.

instanceName string

ordering GatewayPluginGraphqlProxyCacheAdvancedOrdering

protocols string[]

A set of strings representing HTTP protocols.

route GatewayPluginGraphqlProxyCacheAdvancedRoute

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

service GatewayPluginGraphqlProxyCacheAdvancedService

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

tags string[]

An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginGraphqlProxyCacheAdvancedConfigArgs

control_plane_id str

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

consumer GatewayPluginGraphqlProxyCacheAdvancedConsumerArgs

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

enabled bool

Whether the plugin is applied.

gateway_plugin_graphql_proxy_cache_advanced_id str

The ID of this resource.

instance_name str

ordering GatewayPluginGraphqlProxyCacheAdvancedOrderingArgs

protocols Sequence[str]

A set of strings representing HTTP protocols.

route GatewayPluginGraphqlProxyCacheAdvancedRouteArgs

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

service GatewayPluginGraphqlProxyCacheAdvancedServiceArgs

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

tags Sequence[str]

An optional set of strings associated with the Plugin for grouping and filtering.

config Property Map

controlPlaneId String

The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.

consumer Property Map

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

enabled Boolean

Whether the plugin is applied.

gatewayPluginGraphqlProxyCacheAdvancedId String

The ID of this resource.

instanceName String

ordering Property Map

protocols List<String>

A set of strings representing HTTP protocols.

route Property Map

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

service Property Map

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

tags List<String>

An optional set of strings associated with the Plugin for grouping and filtering.

CreatedAt double

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt double

Unix epoch when the resource was last updated.

CreatedAt float64

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt float64

Unix epoch when the resource was last updated.

createdAt Double

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Double

Unix epoch when the resource was last updated.

createdAt number

Unix epoch when the resource was created.

id string

The provider-assigned unique ID for this managed resource.

updatedAt number

Unix epoch when the resource was last updated.

created_at float

Unix epoch when the resource was created.

id str

The provider-assigned unique ID for this managed resource.

updated_at float

Unix epoch when the resource was last updated.

createdAt Number

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Number

Unix epoch when the resource was last updated.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

A bag of options that control this resource's behavior.

BypassOnErr bool

Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.

CacheTtl double

TTL in seconds of cache entities. Must be a value greater than 0.

Memory GatewayPluginGraphqlProxyCacheAdvancedConfigMemory

Redis GatewayPluginGraphqlProxyCacheAdvancedConfigRedis

Strategy string

The backing data store in which to hold cached entities. Accepted value is memory. must be one of ["memory", "redis"]

VaryHeaders List<string>

Relevant headers considered for the cache key. If undefined, none of the headers 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.

CacheTtl float64

TTL in seconds of cache entities. Must be a value greater than 0.

Memory GatewayPluginGraphqlProxyCacheAdvancedConfigMemory

Redis GatewayPluginGraphqlProxyCacheAdvancedConfigRedis

Strategy string

The backing data store in which to hold cached entities. Accepted value is memory. must be one of ["memory", "redis"]

VaryHeaders []string

Relevant headers considered for the cache key. If undefined, none of the headers 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.

cacheTtl Double

TTL in seconds of cache entities. Must be a value greater than 0.

memory GatewayPluginGraphqlProxyCacheAdvancedConfigMemory

redis GatewayPluginGraphqlProxyCacheAdvancedConfigRedis

strategy String

The backing data store in which to hold cached entities. Accepted value is memory. must be one of ["memory", "redis"]

varyHeaders List<String>

Relevant headers considered for the cache key. If undefined, none of the headers 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.

cacheTtl number

TTL in seconds of cache entities. Must be a value greater than 0.

memory GatewayPluginGraphqlProxyCacheAdvancedConfigMemory

redis GatewayPluginGraphqlProxyCacheAdvancedConfigRedis

strategy string

The backing data store in which to hold cached entities. Accepted value is memory. must be one of ["memory", "redis"]

varyHeaders string[]

Relevant headers considered for the cache key. If undefined, none of the headers 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_ttl float

TTL in seconds of cache entities. Must be a value greater than 0.

memory GatewayPluginGraphqlProxyCacheAdvancedConfigMemory

redis GatewayPluginGraphqlProxyCacheAdvancedConfigRedis

strategy str

The backing data store in which to hold cached entities. Accepted value is memory. must be one of ["memory", "redis"]

vary_headers Sequence[str]

Relevant headers considered for the cache key. If undefined, none of the headers 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.

cacheTtl Number

TTL in seconds of cache entities. Must be a value greater than 0.

memory Property Map

redis Property Map

strategy String

The backing data store in which to hold cached entities. Accepted value is memory. must be one of ["memory", "redis"]

varyHeaders List<String>

Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.

DictionaryName string

The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. 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. 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. 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. 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. 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. This dictionary currently must be defined manually in the Kong Nginx template.

ClusterMaxRedirections double

Maximum retry attempts for redirection.

ClusterNodes List<GatewayPluginGraphqlProxyCacheAdvancedConfigRedisClusterNode>

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<GatewayPluginGraphqlProxyCacheAdvancedConfigRedisSentinelNode>

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. must be one of ["any", "master", "slave"]

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 []GatewayPluginGraphqlProxyCacheAdvancedConfigRedisClusterNode

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 []GatewayPluginGraphqlProxyCacheAdvancedConfigRedisSentinelNode

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. must be one of ["any", "master", "slave"]

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<GatewayPluginGraphqlProxyCacheAdvancedConfigRedisClusterNode>

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<GatewayPluginGraphqlProxyCacheAdvancedConfigRedisSentinelNode>

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. must be one of ["any", "master", "slave"]

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 GatewayPluginGraphqlProxyCacheAdvancedConfigRedisClusterNode[]

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 GatewayPluginGraphqlProxyCacheAdvancedConfigRedisSentinelNode[]

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. must be one of ["any", "master", "slave"]

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[GatewayPluginGraphqlProxyCacheAdvancedConfigRedisClusterNode]

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[GatewayPluginGraphqlProxyCacheAdvancedConfigRedisSentinelNode]

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. must be one of ["any", "master", "slave"]

sentinel_username str

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

server_name str

A string representing an SNI (server name indication) value for TLS.

ssl bool

If set to true, uses SSL to connect to Redis.

ssl_verify bool

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_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. must be one of ["any", "master", "slave"]

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.

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.