konnect 2.5.0, Apr 15 25

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

konnect.getGatewayPluginGraphqlRateLimitingAdvanced

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong

Using getGatewayPluginGraphqlRateLimitingAdvanced

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 getGatewayPluginGraphqlRateLimitingAdvanced(args: GetGatewayPluginGraphqlRateLimitingAdvancedArgs, opts?: InvokeOptions): Promise<GetGatewayPluginGraphqlRateLimitingAdvancedResult>
function getGatewayPluginGraphqlRateLimitingAdvancedOutput(args: GetGatewayPluginGraphqlRateLimitingAdvancedOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginGraphqlRateLimitingAdvancedResult>

def get_gateway_plugin_graphql_rate_limiting_advanced(control_plane_id: Optional[str] = None,
                                                      opts: Optional[InvokeOptions] = None) -> GetGatewayPluginGraphqlRateLimitingAdvancedResult
def get_gateway_plugin_graphql_rate_limiting_advanced_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                                      opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginGraphqlRateLimitingAdvancedResult]

func LookupGatewayPluginGraphqlRateLimitingAdvanced(ctx *Context, args *LookupGatewayPluginGraphqlRateLimitingAdvancedArgs, opts ...InvokeOption) (*LookupGatewayPluginGraphqlRateLimitingAdvancedResult, error)
func LookupGatewayPluginGraphqlRateLimitingAdvancedOutput(ctx *Context, args *LookupGatewayPluginGraphqlRateLimitingAdvancedOutputArgs, opts ...InvokeOption) LookupGatewayPluginGraphqlRateLimitingAdvancedResultOutput

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

public static class GetGatewayPluginGraphqlRateLimitingAdvanced 
{
    public static Task<GetGatewayPluginGraphqlRateLimitingAdvancedResult> InvokeAsync(GetGatewayPluginGraphqlRateLimitingAdvancedArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginGraphqlRateLimitingAdvancedResult> Invoke(GetGatewayPluginGraphqlRateLimitingAdvancedInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginGraphqlRateLimitingAdvancedResult> getGatewayPluginGraphqlRateLimitingAdvanced(GetGatewayPluginGraphqlRateLimitingAdvancedArgs args, InvokeOptions options)
public static Output<GetGatewayPluginGraphqlRateLimitingAdvancedResult> getGatewayPluginGraphqlRateLimitingAdvanced(GetGatewayPluginGraphqlRateLimitingAdvancedArgs args, InvokeOptions options)

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

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginGraphqlRateLimitingAdvanced Result

The following output properties are available:

Config GetGatewayPluginGraphqlRateLimitingAdvancedConfig
Consumer GetGatewayPluginGraphqlRateLimitingAdvancedConsumer
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginGraphqlRateLimitingAdvancedOrdering
Protocols List<string>
Route GetGatewayPluginGraphqlRateLimitingAdvancedRoute
Service GetGatewayPluginGraphqlRateLimitingAdvancedService
Tags List<string>
UpdatedAt double

Config GetGatewayPluginGraphqlRateLimitingAdvancedConfig
Consumer GetGatewayPluginGraphqlRateLimitingAdvancedConsumer
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginGraphqlRateLimitingAdvancedOrdering
Protocols []string
Route GetGatewayPluginGraphqlRateLimitingAdvancedRoute
Service GetGatewayPluginGraphqlRateLimitingAdvancedService
Tags []string
UpdatedAt float64

config GetGatewayPluginGraphqlRateLimitingAdvancedConfig
consumer GetGatewayPluginGraphqlRateLimitingAdvancedConsumer
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginGraphqlRateLimitingAdvancedOrdering
protocols List<String>
route GetGatewayPluginGraphqlRateLimitingAdvancedRoute
service GetGatewayPluginGraphqlRateLimitingAdvancedService
tags List<String>
updatedAt Double

config GetGatewayPluginGraphqlRateLimitingAdvancedConfig
consumer GetGatewayPluginGraphqlRateLimitingAdvancedConsumer
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginGraphqlRateLimitingAdvancedOrdering
protocols string[]
route GetGatewayPluginGraphqlRateLimitingAdvancedRoute
service GetGatewayPluginGraphqlRateLimitingAdvancedService
tags string[]
updatedAt number

config GetGatewayPluginGraphqlRateLimitingAdvancedConfig
consumer GetGatewayPluginGraphqlRateLimitingAdvancedConsumer
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginGraphqlRateLimitingAdvancedOrdering
protocols Sequence[str]
route GetGatewayPluginGraphqlRateLimitingAdvancedRoute
service GetGatewayPluginGraphqlRateLimitingAdvancedService
tags Sequence[str]
updated_at float

config Property Map
consumer 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

GetGatewayPluginGraphqlRateLimitingAdvancedConfig

CostStrategy string: Strategy to use to evaluate query costs. Either default or 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.
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 GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis
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.
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.

CostStrategy string: Strategy to use to evaluate query costs. Either default or 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.
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 GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis
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.
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.

costStrategy String: Strategy to use to evaluate query costs. Either default or 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.
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 GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis
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.
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.

costStrategy string: Strategy to use to evaluate query costs. Either default or 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.
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 GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis
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.
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.

cost_strategy str: Strategy to use to evaluate query costs. Either default or 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.
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 GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis
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.
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.

costStrategy String: Strategy to use to evaluate query costs. Either default or 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.
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.
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.

GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis

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

GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedisClusterNode

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.

GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedisSentinelNode

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.

GetGatewayPluginGraphqlRateLimitingAdvancedConsumer

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginGraphqlRateLimitingAdvancedOrdering

After GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter
Before GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

After GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter
Before GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

after GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter
before GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

after GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter
before GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

after GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter
before GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

after Property Map
before Property Map

GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginGraphqlRateLimitingAdvancedRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginGraphqlRateLimitingAdvancedService

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.5.0 published on Tuesday, Apr 15, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginGraphqlRateLimitingAdvanced

On this page

On this page

Using getGatewayPluginGraphqlRateLimitingAdvanced

getGatewayPluginGraphqlRateLimitingAdvanced Result

Supporting Types

GetGatewayPluginGraphqlRateLimitingAdvancedConfig

GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedis

GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedisClusterNode

GetGatewayPluginGraphqlRateLimitingAdvancedConfigRedisSentinelNode

GetGatewayPluginGraphqlRateLimitingAdvancedConsumer

GetGatewayPluginGraphqlRateLimitingAdvancedOrdering

GetGatewayPluginGraphqlRateLimitingAdvancedOrderingAfter

GetGatewayPluginGraphqlRateLimitingAdvancedOrderingBefore

GetGatewayPluginGraphqlRateLimitingAdvancedRoute

GetGatewayPluginGraphqlRateLimitingAdvancedService

Package Details

On this page

On this page