konnect 2.4.1, Mar 13 25

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

konnect.getGatewayPluginRateLimitingAdvanced

Explore with Pulumi AI

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

Using getGatewayPluginRateLimitingAdvanced

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

function getGatewayPluginRateLimitingAdvanced(args: GetGatewayPluginRateLimitingAdvancedArgs, opts?: InvokeOptions): Promise<GetGatewayPluginRateLimitingAdvancedResult>
function getGatewayPluginRateLimitingAdvancedOutput(args: GetGatewayPluginRateLimitingAdvancedOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginRateLimitingAdvancedResult>

def get_gateway_plugin_rate_limiting_advanced(control_plane_id: Optional[str] = None,
                                              opts: Optional[InvokeOptions] = None) -> GetGatewayPluginRateLimitingAdvancedResult
def get_gateway_plugin_rate_limiting_advanced_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                              opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginRateLimitingAdvancedResult]

func LookupGatewayPluginRateLimitingAdvanced(ctx *Context, args *LookupGatewayPluginRateLimitingAdvancedArgs, opts ...InvokeOption) (*LookupGatewayPluginRateLimitingAdvancedResult, error)
func LookupGatewayPluginRateLimitingAdvancedOutput(ctx *Context, args *LookupGatewayPluginRateLimitingAdvancedOutputArgs, opts ...InvokeOption) LookupGatewayPluginRateLimitingAdvancedResultOutput

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

public static class GetGatewayPluginRateLimitingAdvanced 
{
    public static Task<GetGatewayPluginRateLimitingAdvancedResult> InvokeAsync(GetGatewayPluginRateLimitingAdvancedArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginRateLimitingAdvancedResult> Invoke(GetGatewayPluginRateLimitingAdvancedInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginRateLimitingAdvancedResult> getGatewayPluginRateLimitingAdvanced(GetGatewayPluginRateLimitingAdvancedArgs args, InvokeOptions options)
public static Output<GetGatewayPluginRateLimitingAdvancedResult> getGatewayPluginRateLimitingAdvanced(GetGatewayPluginRateLimitingAdvancedArgs args, InvokeOptions options)

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

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginRateLimitingAdvanced Result

The following output properties are available:

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

Supporting Types

GetGatewayPluginRateLimitingAdvancedConfig

CompoundIdentifiers List<string>: Similar to identifer, but supports combining multiple items. The priority of compound_identifier is higher than identifier, which means if compound_identifer is set, it will be used, otherwise identifier will be used.
ConsumerGroups List<string>: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if enforce_consumer_groups is set to true.
DictionaryName string: The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
DisablePenalty bool: If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
EnforceConsumerGroups bool: Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping enforce_consumer_groups from true to false disables the group override, but does not clear the list of consumer groups. You can then flip enforce_consumer_groups to true to re-enforce the groups.
ErrorCode double: Set a custom error code to return when the rate limit is exceeded.
ErrorMessage string: Set a custom error message to return when the rate limit is exceeded.
HeaderName string: A string representing an HTTP header name.
HideClientHeaders bool: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
Identifier string: The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be ip, credential, consumer, service, header, path or consumer-group.
Limits List<double>: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
LockDictionaryName string: The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declare in nginx-kong.conf.
Namespace string: The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
Path string: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
Redis GetGatewayPluginRateLimitingAdvancedConfigRedis
RetryAfterJitterMax double: The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
Strategy string: The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster.
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 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
WindowSizes List<double>: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
WindowType string: Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.

CompoundIdentifiers []string: Similar to identifer, but supports combining multiple items. The priority of compound_identifier is higher than identifier, which means if compound_identifer is set, it will be used, otherwise identifier will be used.
ConsumerGroups []string: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if enforce_consumer_groups is set to true.
DictionaryName string: The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
DisablePenalty bool: If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
EnforceConsumerGroups bool: Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping enforce_consumer_groups from true to false disables the group override, but does not clear the list of consumer groups. You can then flip enforce_consumer_groups to true to re-enforce the groups.
ErrorCode float64: Set a custom error code to return when the rate limit is exceeded.
ErrorMessage string: Set a custom error message to return when the rate limit is exceeded.
HeaderName string: A string representing an HTTP header name.
HideClientHeaders bool: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
Identifier string: The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be ip, credential, consumer, service, header, path or consumer-group.
Limits []float64: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
LockDictionaryName string: The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declare in nginx-kong.conf.
Namespace string: The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
Path string: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
Redis GetGatewayPluginRateLimitingAdvancedConfigRedis
RetryAfterJitterMax float64: The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
Strategy string: The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster.
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 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
WindowSizes []float64: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
WindowType string: Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.

compoundIdentifiers List<String>: Similar to identifer, but supports combining multiple items. The priority of compound_identifier is higher than identifier, which means if compound_identifer is set, it will be used, otherwise identifier will be used.
consumerGroups List<String>: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if enforce_consumer_groups is set to true.
dictionaryName String: The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disablePenalty Boolean: If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
enforceConsumerGroups Boolean: Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping enforce_consumer_groups from true to false disables the group override, but does not clear the list of consumer groups. You can then flip enforce_consumer_groups to true to re-enforce the groups.
errorCode Double: Set a custom error code to return when the rate limit is exceeded.
errorMessage String: Set a custom error message to return when the rate limit is exceeded.
headerName String: A string representing an HTTP header name.
hideClientHeaders Boolean: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
identifier String: The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be ip, credential, consumer, service, header, path or consumer-group.
limits List<Double>: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lockDictionaryName String: The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declare in nginx-kong.conf.
namespace String: The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
path String: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
redis GetGatewayPluginRateLimitingAdvancedConfigRedis
retryAfterJitterMax Double: The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy String: The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster.
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 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
windowSizes List<Double>: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
windowType String: Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.

compoundIdentifiers string[]: Similar to identifer, but supports combining multiple items. The priority of compound_identifier is higher than identifier, which means if compound_identifer is set, it will be used, otherwise identifier will be used.
consumerGroups string[]: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if enforce_consumer_groups is set to true.
dictionaryName string: The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disablePenalty boolean: If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
enforceConsumerGroups boolean: Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping enforce_consumer_groups from true to false disables the group override, but does not clear the list of consumer groups. You can then flip enforce_consumer_groups to true to re-enforce the groups.
errorCode number: Set a custom error code to return when the rate limit is exceeded.
errorMessage string: Set a custom error message to return when the rate limit is exceeded.
headerName string: A string representing an HTTP header name.
hideClientHeaders boolean: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
identifier string: The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be ip, credential, consumer, service, header, path or consumer-group.
limits number[]: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lockDictionaryName string: The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declare in nginx-kong.conf.
namespace string: The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
path string: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
redis GetGatewayPluginRateLimitingAdvancedConfigRedis
retryAfterJitterMax number: The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy string: The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster.
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 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
windowSizes number[]: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
windowType string: Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.

compound_identifiers Sequence[str]: Similar to identifer, but supports combining multiple items. The priority of compound_identifier is higher than identifier, which means if compound_identifer is set, it will be used, otherwise identifier will be used.
consumer_groups Sequence[str]: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if enforce_consumer_groups is set to true.
dictionary_name str: The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disable_penalty bool: If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
enforce_consumer_groups bool: Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping enforce_consumer_groups from true to false disables the group override, but does not clear the list of consumer groups. You can then flip enforce_consumer_groups to true to re-enforce the groups.
error_code float: Set a custom error code to return when the rate limit is exceeded.
error_message str: Set a custom error message to return when the rate limit is exceeded.
header_name str: A string representing an HTTP header name.
hide_client_headers bool: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
identifier str: The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be ip, credential, consumer, service, header, path or consumer-group.
limits Sequence[float]: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lock_dictionary_name str: The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declare in nginx-kong.conf.
namespace str: The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
path str: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
redis GetGatewayPluginRateLimitingAdvancedConfigRedis
retry_after_jitter_max float: The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy str: The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster.
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 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
window_sizes Sequence[float]: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
window_type str: Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.

compoundIdentifiers List<String>: Similar to identifer, but supports combining multiple items. The priority of compound_identifier is higher than identifier, which means if compound_identifer is set, it will be used, otherwise identifier will be used.
consumerGroups List<String>: List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if enforce_consumer_groups is set to true.
dictionaryName String: The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.
disablePenalty Boolean: If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.
enforceConsumerGroups Boolean: Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping enforce_consumer_groups from true to false disables the group override, but does not clear the list of consumer groups. You can then flip enforce_consumer_groups to true to re-enforce the groups.
errorCode Number: Set a custom error code to return when the rate limit is exceeded.
errorMessage String: Set a custom error message to return when the rate limit is exceeded.
headerName String: A string representing an HTTP header name.
hideClientHeaders Boolean: Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.
identifier String: The type of identifier used to generate the rate limit key. Defines the scope used to increment the rate limiting counters. Can be ip, credential, consumer, service, header, path or consumer-group.
limits List<Number>: One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
lockDictionaryName String: The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declare in nginx-kong.conf.
namespace String: The rate limiting library namespace to use for this plugin instance. Counter data and sync configuration is isolated in each namespace. NOTE: For the plugin instances sharing the same namespace, all the configurations that are required for synchronizing counters, e.g. strategy, redis, sync_rate, dictionary_name, need to be the same.
path String: A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).
redis Property Map
retryAfterJitterMax Number: The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.
strategy String: The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster.
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 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).
windowSizes List<Number>: One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.
windowType String: Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters.

GetGatewayPluginRateLimitingAdvancedConfigRedis

ClusterMaxRedirections double: Maximum retry attempts for redirection.
ClusterNodes List<GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode>: 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.
RedisProxyType string: If the connection_is_proxied is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.
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<GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode>: 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 []GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode: 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.
RedisProxyType string: If the connection_is_proxied is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.
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 []GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode: 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<GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode>: 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.
redisProxyType String: If the connection_is_proxied is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.
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<GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode>: 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 GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode[]: 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.
redisProxyType string: If the connection_is_proxied is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.
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 GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode[]: 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[GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode]: 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.
redis_proxy_type str: If the connection_is_proxied is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.
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[GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode]: 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.
redisProxyType String: If the connection_is_proxied is enabled, this field indicates the proxy type and version you are using. For example, you can enable this optioin when you want authentication between Kong and Envoy proxy.
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.

GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode

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.

GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode

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.

GetGatewayPluginRateLimitingAdvancedConsumer

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginRateLimitingAdvancedConsumerGroup

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginRateLimitingAdvancedOrdering

After GetGatewayPluginRateLimitingAdvancedOrderingAfter
Before GetGatewayPluginRateLimitingAdvancedOrderingBefore

After GetGatewayPluginRateLimitingAdvancedOrderingAfter
Before GetGatewayPluginRateLimitingAdvancedOrderingBefore

after GetGatewayPluginRateLimitingAdvancedOrderingAfter
before GetGatewayPluginRateLimitingAdvancedOrderingBefore

after GetGatewayPluginRateLimitingAdvancedOrderingAfter
before GetGatewayPluginRateLimitingAdvancedOrderingBefore

after GetGatewayPluginRateLimitingAdvancedOrderingAfter
before GetGatewayPluginRateLimitingAdvancedOrderingBefore

after Property Map
before Property Map

GetGatewayPluginRateLimitingAdvancedOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginRateLimitingAdvancedOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginRateLimitingAdvancedRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginRateLimitingAdvancedService

Id string

Id string

id String

id string

id str

id String

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

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

kong/terraform-provider-konnect

konnect.getGatewayPluginRateLimitingAdvanced

On this page

On this page

Using getGatewayPluginRateLimitingAdvanced

getGatewayPluginRateLimitingAdvanced Result

Supporting Types

GetGatewayPluginRateLimitingAdvancedConfig

GetGatewayPluginRateLimitingAdvancedConfigRedis

GetGatewayPluginRateLimitingAdvancedConfigRedisClusterNode

GetGatewayPluginRateLimitingAdvancedConfigRedisSentinelNode

GetGatewayPluginRateLimitingAdvancedConsumer

GetGatewayPluginRateLimitingAdvancedConsumerGroup

GetGatewayPluginRateLimitingAdvancedOrdering

GetGatewayPluginRateLimitingAdvancedOrderingAfter

GetGatewayPluginRateLimitingAdvancedOrderingBefore

GetGatewayPluginRateLimitingAdvancedRoute

GetGatewayPluginRateLimitingAdvancedService

Package Details

On this page

On this page