konnect.GatewayPluginGraphqlRateLimitingAdvanced

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args GatewayPluginGraphqlRateLimitingAdvancedArgs

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 GatewayPluginGraphqlRateLimitingAdvancedArgs

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 GatewayPluginGraphqlRateLimitingAdvancedArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginGraphqlRateLimitingAdvancedArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginGraphqlRateLimitingAdvancedArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ControlPlaneId string

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

Config GatewayPluginGraphqlRateLimitingAdvancedConfig

Consumer GatewayPluginGraphqlRateLimitingAdvancedConsumer

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.

CreatedAt double

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginGraphqlRateLimitingAdvancedId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginGraphqlRateLimitingAdvancedOrdering

Protocols List<string>

A set of strings representing HTTP protocols.

Route GatewayPluginGraphqlRateLimitingAdvancedRoute

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 GatewayPluginGraphqlRateLimitingAdvancedService

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.

UpdatedAt double

Unix epoch when the resource was last updated.

ControlPlaneId string

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

Config GatewayPluginGraphqlRateLimitingAdvancedConfigArgs

Consumer GatewayPluginGraphqlRateLimitingAdvancedConsumerArgs

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.

CreatedAt float64

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginGraphqlRateLimitingAdvancedId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginGraphqlRateLimitingAdvancedOrderingArgs

Protocols []string

A set of strings representing HTTP protocols.

Route GatewayPluginGraphqlRateLimitingAdvancedRouteArgs

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 GatewayPluginGraphqlRateLimitingAdvancedServiceArgs

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.

UpdatedAt float64

Unix epoch when the resource was last updated.

controlPlaneId String

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

config GatewayPluginGraphqlRateLimitingAdvancedConfig

consumer GatewayPluginGraphqlRateLimitingAdvancedConsumer

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.

createdAt Double

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginGraphqlRateLimitingAdvancedId String

The ID of this resource.

instanceName String

ordering GatewayPluginGraphqlRateLimitingAdvancedOrdering

protocols List<String>

A set of strings representing HTTP protocols.

route GatewayPluginGraphqlRateLimitingAdvancedRoute

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 GatewayPluginGraphqlRateLimitingAdvancedService

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.

updatedAt Double

Unix epoch when the resource was last updated.

controlPlaneId string

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

config GatewayPluginGraphqlRateLimitingAdvancedConfig

consumer GatewayPluginGraphqlRateLimitingAdvancedConsumer

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.

createdAt number

Unix epoch when the resource was created.

enabled boolean

Whether the plugin is applied.

gatewayPluginGraphqlRateLimitingAdvancedId string

The ID of this resource.

instanceName string

ordering GatewayPluginGraphqlRateLimitingAdvancedOrdering

protocols string[]

A set of strings representing HTTP protocols.

route GatewayPluginGraphqlRateLimitingAdvancedRoute

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 GatewayPluginGraphqlRateLimitingAdvancedService

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.

updatedAt number

Unix epoch when the resource was last updated.

control_plane_id str

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

config GatewayPluginGraphqlRateLimitingAdvancedConfigArgs

consumer GatewayPluginGraphqlRateLimitingAdvancedConsumerArgs

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.

created_at float

Unix epoch when the resource was created.

enabled bool

Whether the plugin is applied.

gateway_plugin_graphql_rate_limiting_advanced_id str

The ID of this resource.

instance_name str

ordering GatewayPluginGraphqlRateLimitingAdvancedOrderingArgs

protocols Sequence[str]

A set of strings representing HTTP protocols.

route GatewayPluginGraphqlRateLimitingAdvancedRouteArgs

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 GatewayPluginGraphqlRateLimitingAdvancedServiceArgs

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.

updated_at float

Unix epoch when the resource was last updated.

controlPlaneId String

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

config Property Map

consumer Property Map

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

createdAt Number

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginGraphqlRateLimitingAdvancedId 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.

updatedAt Number

Unix epoch when the resource was last updated.

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id string

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

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.

CostStrategy string

Strategy to use to evaluate query costs. Either default or node_quantifier. must be one of ["default", "node_quantifier"]

DictionaryName string

The shared dictionary where counters will be stored until the next sync cycle.

HideClientHeaders bool

Optionally hide informative response headers. Available options: true or false.

Identifier string

How to define the rate limit key. Can be ip, credential, consumer. must be one of ["consumer", "credential", "ip"]

Limits List<double>

One or more requests-per-window limits to apply.

MaxCost double

A defined maximum cost per query. 0 means unlimited.

Namespace string

The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, window_size, dictionary_name, need to be the same.

Redis GatewayPluginGraphqlRateLimitingAdvancedConfigRedis

ScoreFactor double

A scoring factor to multiply (or divide) the cost. The score_factor must always be greater than 0.

Strategy string

The rate-limiting strategy to use for retrieving and incrementing the limits. must be one of ["cluster", "redis"]

SyncRate double

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds.

WindowSizes List<double>

One or more window sizes to apply a limit to (defined in seconds).

WindowType string

Sets the time window to either sliding or fixed. must be one of ["fixed", "sliding"]

CostStrategy string

Strategy to use to evaluate query costs. Either default or node_quantifier. must be one of ["default", "node_quantifier"]

DictionaryName string

The shared dictionary where counters will be stored until the next sync cycle.

HideClientHeaders bool

Optionally hide informative response headers. Available options: true or false.

Identifier string

How to define the rate limit key. Can be ip, credential, consumer. must be one of ["consumer", "credential", "ip"]

Limits []float64

One or more requests-per-window limits to apply.

MaxCost float64

A defined maximum cost per query. 0 means unlimited.

Namespace string

The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, window_size, dictionary_name, need to be the same.

Redis GatewayPluginGraphqlRateLimitingAdvancedConfigRedis

ScoreFactor float64

A scoring factor to multiply (or divide) the cost. The score_factor must always be greater than 0.

Strategy string

The rate-limiting strategy to use for retrieving and incrementing the limits. must be one of ["cluster", "redis"]

SyncRate float64

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds.

WindowSizes []float64

One or more window sizes to apply a limit to (defined in seconds).

WindowType string

Sets the time window to either sliding or fixed. must be one of ["fixed", "sliding"]

costStrategy String

Strategy to use to evaluate query costs. Either default or node_quantifier. must be one of ["default", "node_quantifier"]

dictionaryName String

The shared dictionary where counters will be stored until the next sync cycle.

hideClientHeaders Boolean

Optionally hide informative response headers. Available options: true or false.

identifier String

How to define the rate limit key. Can be ip, credential, consumer. must be one of ["consumer", "credential", "ip"]

limits List<Double>

One or more requests-per-window limits to apply.

maxCost Double

A defined maximum cost per query. 0 means unlimited.

namespace String

The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, window_size, dictionary_name, need to be the same.

redis GatewayPluginGraphqlRateLimitingAdvancedConfigRedis

scoreFactor Double

A scoring factor to multiply (or divide) the cost. The score_factor must always be greater than 0.

strategy String

The rate-limiting strategy to use for retrieving and incrementing the limits. must be one of ["cluster", "redis"]

syncRate Double

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds.

windowSizes List<Double>

One or more window sizes to apply a limit to (defined in seconds).

windowType String

Sets the time window to either sliding or fixed. must be one of ["fixed", "sliding"]

costStrategy string

Strategy to use to evaluate query costs. Either default or node_quantifier. must be one of ["default", "node_quantifier"]

dictionaryName string

The shared dictionary where counters will be stored until the next sync cycle.

hideClientHeaders boolean

Optionally hide informative response headers. Available options: true or false.

identifier string

How to define the rate limit key. Can be ip, credential, consumer. must be one of ["consumer", "credential", "ip"]

limits number[]

One or more requests-per-window limits to apply.

maxCost number

A defined maximum cost per query. 0 means unlimited.

namespace string

The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, window_size, dictionary_name, need to be the same.

redis GatewayPluginGraphqlRateLimitingAdvancedConfigRedis

scoreFactor number

A scoring factor to multiply (or divide) the cost. The score_factor must always be greater than 0.

strategy string

The rate-limiting strategy to use for retrieving and incrementing the limits. must be one of ["cluster", "redis"]

syncRate number

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds.

windowSizes number[]

One or more window sizes to apply a limit to (defined in seconds).

windowType string

Sets the time window to either sliding or fixed. must be one of ["fixed", "sliding"]

cost_strategy str

Strategy to use to evaluate query costs. Either default or node_quantifier. must be one of ["default", "node_quantifier"]

dictionary_name str

The shared dictionary where counters will be stored until the next sync cycle.

hide_client_headers bool

Optionally hide informative response headers. Available options: true or false.

identifier str

How to define the rate limit key. Can be ip, credential, consumer. must be one of ["consumer", "credential", "ip"]

limits Sequence[float]

One or more requests-per-window limits to apply.

max_cost float

A defined maximum cost per query. 0 means unlimited.

namespace str

The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, window_size, dictionary_name, need to be the same.

redis GatewayPluginGraphqlRateLimitingAdvancedConfigRedis

score_factor float

A scoring factor to multiply (or divide) the cost. The score_factor must always be greater than 0.

strategy str

The rate-limiting strategy to use for retrieving and incrementing the limits. must be one of ["cluster", "redis"]

sync_rate float

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds.

window_sizes Sequence[float]

One or more window sizes to apply a limit to (defined in seconds).

window_type str

Sets the time window to either sliding or fixed. must be one of ["fixed", "sliding"]

costStrategy String

Strategy to use to evaluate query costs. Either default or node_quantifier. must be one of ["default", "node_quantifier"]

dictionaryName String

The shared dictionary where counters will be stored until the next sync cycle.

hideClientHeaders Boolean

Optionally hide informative response headers. Available options: true or false.

identifier String

How to define the rate limit key. Can be ip, credential, consumer. must be one of ["consumer", "credential", "ip"]

limits List<Number>

One or more requests-per-window limits to apply.

maxCost Number

A defined maximum cost per query. 0 means unlimited.

namespace String

The rate limiting namespace to use for this plugin instance. This namespace is used to share rate limiting counters across different instances. If it is not provided, a random UUID is generated. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, window_size, dictionary_name, need to be the same.

redis Property Map

scoreFactor Number

A scoring factor to multiply (or divide) the cost. The score_factor must always be greater than 0.

strategy String

The rate-limiting strategy to use for retrieving and incrementing the limits. must be one of ["cluster", "redis"]

syncRate Number

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 syncs the counters in that many number of seconds.

windowSizes List<Number>

One or more window sizes to apply a limit to (defined in seconds).

windowType String

Sets the time window to either sliding or fixed. must be one of ["fixed", "sliding"]

ClusterMaxRedirections double

Maximum retry attempts for redirection.

ClusterNodes List<GatewayPluginGraphqlRateLimitingAdvancedConfigRedisClusterNode>

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

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

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

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

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

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.