Docs Home
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
konnect.GatewayPluginRateLimitingAdvanced
Explore with Pulumi AI
GatewayPluginRateLimitingAdvanced Resource
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginRateLimitingAdvanced;
import com.pulumi.konnect.GatewayPluginRateLimitingAdvancedArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedConfigRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginRateLimitingAdvancedServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myGatewaypluginratelimitingadvanced = new GatewayPluginRateLimitingAdvanced("myGatewaypluginratelimitingadvanced", GatewayPluginRateLimitingAdvancedArgs.builder()
.config(GatewayPluginRateLimitingAdvancedConfigArgs.builder()
.compound_identifier("header")
.consumer_groups("...")
.dictionary_name("...my_dictionary_name...")
.disable_penalty(false)
.enforce_consumer_groups(false)
.error_code(3.07)
.error_message("...my_error_message...")
.header_name("...my_header_name...")
.hide_client_headers(true)
.identifier("consumer")
.limit(4.52)
.lock_dictionary_name("...my_lock_dictionary_name...")
.namespace("...my_namespace...")
.path("...my_path...")
.redis(GatewayPluginRateLimitingAdvancedConfigRedisArgs.builder()
.clusterMaxRedirections(7)
.clusterNodes(GatewayPluginRateLimitingAdvancedConfigRedisClusterNodeArgs.builder()
.ip("...my_ip...")
.port(54354)
.build())
.connectTimeout(374037696)
.connectionIsProxied(false)
.database(3)
.host("...my_host...")
.keepaliveBacklog(788639936)
.keepalivePoolSize(1875079515)
.password("...my_password...")
.port(63483)
.readTimeout(382621324)
.redisProxyType("envoy_v1.31")
.sendTimeout(1710404950)
.sentinelMaster("...my_sentinel_master...")
.sentinelNodes(GatewayPluginRateLimitingAdvancedConfigRedisSentinelNodeArgs.builder()
.host("...my_host...")
.port(57176)
.build())
.sentinelPassword("...my_sentinel_password...")
.sentinelRole("any")
.sentinelUsername("...my_sentinel_username...")
.serverName("...my_server_name...")
.ssl(true)
.sslVerify(true)
.username("...my_username...")
.build())
.retry_after_jitter_max(9.23)
.strategy("cluster")
.sync_rate(4.11)
.window_size(4.61)
.window_type("sliding")
.build())
.consumer(GatewayPluginRateLimitingAdvancedConsumerArgs.builder()
.id("...my_id...")
.build())
.consumerGroup(GatewayPluginRateLimitingAdvancedConsumerGroupArgs.builder()
.id("...my_id...")
.build())
.controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
.enabled(true)
.gatewayPluginRateLimitingAdvancedId("...my_id...")
.instanceName("...my_instance_name...")
.ordering(GatewayPluginRateLimitingAdvancedOrderingArgs.builder()
.after(GatewayPluginRateLimitingAdvancedOrderingAfterArgs.builder()
.access("...")
.build())
.before(GatewayPluginRateLimitingAdvancedOrderingBeforeArgs.builder()
.access("...")
.build())
.build())
.protocols("grpcs")
.route(GatewayPluginRateLimitingAdvancedRouteArgs.builder()
.id("...my_id...")
.build())
.service(GatewayPluginRateLimitingAdvancedServiceArgs.builder()
.id("...my_id...")
.build())
.tags("...")
.build());
}
}
resources:
myGatewaypluginratelimitingadvanced:
type: konnect:GatewayPluginRateLimitingAdvanced
properties:
config:
compound_identifier:
- header
consumer_groups:
- '...'
dictionary_name: '...my_dictionary_name...'
disable_penalty: false
enforce_consumer_groups: false
error_code: 3.07
error_message: '...my_error_message...'
header_name: '...my_header_name...'
hide_client_headers: true
identifier: consumer
limit:
- 4.52
lock_dictionary_name: '...my_lock_dictionary_name...'
namespace: '...my_namespace...'
path: '...my_path...'
redis:
clusterMaxRedirections: 7
clusterNodes:
- ip: '...my_ip...'
port: 54354
connectTimeout: 3.74037696e+08
connectionIsProxied: false
database: 3
host: '...my_host...'
keepaliveBacklog: 7.88639936e+08
keepalivePoolSize: 1.875079515e+09
password: '...my_password...'
port: 63483
readTimeout: 3.82621324e+08
redisProxyType: envoy_v1.31
sendTimeout: 1.71040495e+09
sentinelMaster: '...my_sentinel_master...'
sentinelNodes:
- host: '...my_host...'
port: 57176
sentinelPassword: '...my_sentinel_password...'
sentinelRole: any
sentinelUsername: '...my_sentinel_username...'
serverName: '...my_server_name...'
ssl: true
sslVerify: true
username: '...my_username...'
retry_after_jitter_max: 9.23
strategy: cluster
sync_rate: 4.11
window_size:
- 4.61
window_type: sliding
consumer:
id: '...my_id...'
consumerGroup:
id: '...my_id...'
controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
enabled: true
gatewayPluginRateLimitingAdvancedId: '...my_id...'
instanceName: '...my_instance_name...'
ordering:
after:
access:
- '...'
before:
access:
- '...'
protocols:
- grpcs
route:
id: '...my_id...'
service:
id: '...my_id...'
tags:
- '...'
Create GatewayPluginRateLimitingAdvanced Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayPluginRateLimitingAdvanced(name: string, args: GatewayPluginRateLimitingAdvancedArgs, opts?: CustomResourceOptions);@overload
def GatewayPluginRateLimitingAdvanced(resource_name: str,
args: GatewayPluginRateLimitingAdvancedArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayPluginRateLimitingAdvanced(resource_name: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginRateLimitingAdvancedConfigArgs] = None,
control_plane_id: Optional[str] = None,
consumer: Optional[GatewayPluginRateLimitingAdvancedConsumerArgs] = None,
consumer_group: Optional[GatewayPluginRateLimitingAdvancedConsumerGroupArgs] = None,
enabled: Optional[bool] = None,
gateway_plugin_rate_limiting_advanced_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginRateLimitingAdvancedOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginRateLimitingAdvancedRouteArgs] = None,
service: Optional[GatewayPluginRateLimitingAdvancedServiceArgs] = None,
tags: Optional[Sequence[str]] = None)func NewGatewayPluginRateLimitingAdvanced(ctx *Context, name string, args GatewayPluginRateLimitingAdvancedArgs, opts ...ResourceOption) (*GatewayPluginRateLimitingAdvanced, error)public GatewayPluginRateLimitingAdvanced(string name, GatewayPluginRateLimitingAdvancedArgs args, CustomResourceOptions? opts = null)
public GatewayPluginRateLimitingAdvanced(String name, GatewayPluginRateLimitingAdvancedArgs args)
public GatewayPluginRateLimitingAdvanced(String name, GatewayPluginRateLimitingAdvancedArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginRateLimitingAdvanced
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayPluginRateLimitingAdvancedArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayPluginRateLimitingAdvancedArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayPluginRateLimitingAdvancedArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayPluginRateLimitingAdvancedArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayPluginRateLimitingAdvancedArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayPluginRateLimitingAdvancedResource = new Konnect.GatewayPluginRateLimitingAdvanced("gatewayPluginRateLimitingAdvancedResource", new()
{
Config = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedConfigArgs
{
CompoundIdentifiers = new[]
{
"string",
},
ConsumerGroups = new[]
{
"string",
},
DictionaryName = "string",
DisablePenalty = false,
EnforceConsumerGroups = false,
ErrorCode = 0,
ErrorMessage = "string",
HeaderName = "string",
HideClientHeaders = false,
Identifier = "string",
Limits = new[]
{
0,
},
LockDictionaryName = "string",
Namespace = "string",
Path = "string",
Redis = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedConfigRedisArgs
{
ClusterMaxRedirections = 0,
ClusterNodes = new[]
{
new Konnect.Inputs.GatewayPluginRateLimitingAdvancedConfigRedisClusterNodeArgs
{
Ip = "string",
Port = 0,
},
},
ConnectTimeout = 0,
ConnectionIsProxied = false,
Database = 0,
Host = "string",
KeepaliveBacklog = 0,
KeepalivePoolSize = 0,
Password = "string",
Port = 0,
ReadTimeout = 0,
RedisProxyType = "string",
SendTimeout = 0,
SentinelMaster = "string",
SentinelNodes = new[]
{
new Konnect.Inputs.GatewayPluginRateLimitingAdvancedConfigRedisSentinelNodeArgs
{
Host = "string",
Port = 0,
},
},
SentinelPassword = "string",
SentinelRole = "string",
SentinelUsername = "string",
ServerName = "string",
Ssl = false,
SslVerify = false,
Username = "string",
},
RetryAfterJitterMax = 0,
Strategy = "string",
SyncRate = 0,
WindowSizes = new[]
{
0,
},
WindowType = "string",
},
ControlPlaneId = "string",
Consumer = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedConsumerArgs
{
Id = "string",
},
ConsumerGroup = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedConsumerGroupArgs
{
Id = "string",
},
Enabled = false,
GatewayPluginRateLimitingAdvancedId = "string",
InstanceName = "string",
Ordering = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedOrderingAfterArgs
{
Accesses = new[]
{
"string",
},
},
Before = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedOrderingBeforeArgs
{
Accesses = new[]
{
"string",
},
},
},
Protocols = new[]
{
"string",
},
Route = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedRouteArgs
{
Id = "string",
},
Service = new Konnect.Inputs.GatewayPluginRateLimitingAdvancedServiceArgs
{
Id = "string",
},
Tags = new[]
{
"string",
},
});
example, err := konnect.NewGatewayPluginRateLimitingAdvanced(ctx, "gatewayPluginRateLimitingAdvancedResource", &konnect.GatewayPluginRateLimitingAdvancedArgs{
Config: &.GatewayPluginRateLimitingAdvancedConfigArgs{
CompoundIdentifiers: pulumi.StringArray{
pulumi.String("string"),
},
ConsumerGroups: pulumi.StringArray{
pulumi.String("string"),
},
DictionaryName: pulumi.String("string"),
DisablePenalty: pulumi.Bool(false),
EnforceConsumerGroups: pulumi.Bool(false),
ErrorCode: pulumi.Float64(0),
ErrorMessage: pulumi.String("string"),
HeaderName: pulumi.String("string"),
HideClientHeaders: pulumi.Bool(false),
Identifier: pulumi.String("string"),
Limits: pulumi.Float64Array{
pulumi.Float64(0),
},
LockDictionaryName: pulumi.String("string"),
Namespace: pulumi.String("string"),
Path: pulumi.String("string"),
Redis: &.GatewayPluginRateLimitingAdvancedConfigRedisArgs{
ClusterMaxRedirections: pulumi.Float64(0),
ClusterNodes: .GatewayPluginRateLimitingAdvancedConfigRedisClusterNodeArray{
&.GatewayPluginRateLimitingAdvancedConfigRedisClusterNodeArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ConnectTimeout: pulumi.Float64(0),
ConnectionIsProxied: pulumi.Bool(false),
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
KeepaliveBacklog: pulumi.Float64(0),
KeepalivePoolSize: pulumi.Float64(0),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ReadTimeout: pulumi.Float64(0),
RedisProxyType: pulumi.String("string"),
SendTimeout: pulumi.Float64(0),
SentinelMaster: pulumi.String("string"),
SentinelNodes: .GatewayPluginRateLimitingAdvancedConfigRedisSentinelNodeArray{
&.GatewayPluginRateLimitingAdvancedConfigRedisSentinelNodeArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
SentinelPassword: pulumi.String("string"),
SentinelRole: pulumi.String("string"),
SentinelUsername: pulumi.String("string"),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Username: pulumi.String("string"),
},
RetryAfterJitterMax: pulumi.Float64(0),
Strategy: pulumi.String("string"),
SyncRate: pulumi.Float64(0),
WindowSizes: pulumi.Float64Array{
pulumi.Float64(0),
},
WindowType: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginRateLimitingAdvancedConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginRateLimitingAdvancedConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginRateLimitingAdvancedId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginRateLimitingAdvancedOrderingArgs{
After: &.GatewayPluginRateLimitingAdvancedOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginRateLimitingAdvancedOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginRateLimitingAdvancedRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginRateLimitingAdvancedServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var gatewayPluginRateLimitingAdvancedResource = new GatewayPluginRateLimitingAdvanced("gatewayPluginRateLimitingAdvancedResource", GatewayPluginRateLimitingAdvancedArgs.builder()
.config(GatewayPluginRateLimitingAdvancedConfigArgs.builder()
.compoundIdentifiers("string")
.consumerGroups("string")
.dictionaryName("string")
.disablePenalty(false)
.enforceConsumerGroups(false)
.errorCode(0)
.errorMessage("string")
.headerName("string")
.hideClientHeaders(false)
.identifier("string")
.limits(0)
.lockDictionaryName("string")
.namespace("string")
.path("string")
.redis(GatewayPluginRateLimitingAdvancedConfigRedisArgs.builder()
.clusterMaxRedirections(0)
.clusterNodes(GatewayPluginRateLimitingAdvancedConfigRedisClusterNodeArgs.builder()
.ip("string")
.port(0)
.build())
.connectTimeout(0)
.connectionIsProxied(false)
.database(0)
.host("string")
.keepaliveBacklog(0)
.keepalivePoolSize(0)
.password("string")
.port(0)
.readTimeout(0)
.redisProxyType("string")
.sendTimeout(0)
.sentinelMaster("string")
.sentinelNodes(GatewayPluginRateLimitingAdvancedConfigRedisSentinelNodeArgs.builder()
.host("string")
.port(0)
.build())
.sentinelPassword("string")
.sentinelRole("string")
.sentinelUsername("string")
.serverName("string")
.ssl(false)
.sslVerify(false)
.username("string")
.build())
.retryAfterJitterMax(0)
.strategy("string")
.syncRate(0)
.windowSizes(0)
.windowType("string")
.build())
.controlPlaneId("string")
.consumer(GatewayPluginRateLimitingAdvancedConsumerArgs.builder()
.id("string")
.build())
.consumerGroup(GatewayPluginRateLimitingAdvancedConsumerGroupArgs.builder()
.id("string")
.build())
.enabled(false)
.gatewayPluginRateLimitingAdvancedId("string")
.instanceName("string")
.ordering(GatewayPluginRateLimitingAdvancedOrderingArgs.builder()
.after(GatewayPluginRateLimitingAdvancedOrderingAfterArgs.builder()
.accesses("string")
.build())
.before(GatewayPluginRateLimitingAdvancedOrderingBeforeArgs.builder()
.accesses("string")
.build())
.build())
.protocols("string")
.route(GatewayPluginRateLimitingAdvancedRouteArgs.builder()
.id("string")
.build())
.service(GatewayPluginRateLimitingAdvancedServiceArgs.builder()
.id("string")
.build())
.tags("string")
.build());
gateway_plugin_rate_limiting_advanced_resource = konnect.GatewayPluginRateLimitingAdvanced("gatewayPluginRateLimitingAdvancedResource",
config={
"compound_identifiers": ["string"],
"consumer_groups": ["string"],
"dictionary_name": "string",
"disable_penalty": False,
"enforce_consumer_groups": False,
"error_code": 0,
"error_message": "string",
"header_name": "string",
"hide_client_headers": False,
"identifier": "string",
"limits": [0],
"lock_dictionary_name": "string",
"namespace": "string",
"path": "string",
"redis": {
"cluster_max_redirections": 0,
"cluster_nodes": [{
"ip": "string",
"port": 0,
}],
"connect_timeout": 0,
"connection_is_proxied": False,
"database": 0,
"host": "string",
"keepalive_backlog": 0,
"keepalive_pool_size": 0,
"password": "string",
"port": 0,
"read_timeout": 0,
"redis_proxy_type": "string",
"send_timeout": 0,
"sentinel_master": "string",
"sentinel_nodes": [{
"host": "string",
"port": 0,
}],
"sentinel_password": "string",
"sentinel_role": "string",
"sentinel_username": "string",
"server_name": "string",
"ssl": False,
"ssl_verify": False,
"username": "string",
},
"retry_after_jitter_max": 0,
"strategy": "string",
"sync_rate": 0,
"window_sizes": [0],
"window_type": "string",
},
control_plane_id="string",
consumer={
"id": "string",
},
consumer_group={
"id": "string",
},
enabled=False,
gateway_plugin_rate_limiting_advanced_id="string",
instance_name="string",
ordering={
"after": {
"accesses": ["string"],
},
"before": {
"accesses": ["string"],
},
},
protocols=["string"],
route={
"id": "string",
},
service={
"id": "string",
},
tags=["string"])
const gatewayPluginRateLimitingAdvancedResource = new konnect.GatewayPluginRateLimitingAdvanced("gatewayPluginRateLimitingAdvancedResource", {
config: {
compoundIdentifiers: ["string"],
consumerGroups: ["string"],
dictionaryName: "string",
disablePenalty: false,
enforceConsumerGroups: false,
errorCode: 0,
errorMessage: "string",
headerName: "string",
hideClientHeaders: false,
identifier: "string",
limits: [0],
lockDictionaryName: "string",
namespace: "string",
path: "string",
redis: {
clusterMaxRedirections: 0,
clusterNodes: [{
ip: "string",
port: 0,
}],
connectTimeout: 0,
connectionIsProxied: false,
database: 0,
host: "string",
keepaliveBacklog: 0,
keepalivePoolSize: 0,
password: "string",
port: 0,
readTimeout: 0,
redisProxyType: "string",
sendTimeout: 0,
sentinelMaster: "string",
sentinelNodes: [{
host: "string",
port: 0,
}],
sentinelPassword: "string",
sentinelRole: "string",
sentinelUsername: "string",
serverName: "string",
ssl: false,
sslVerify: false,
username: "string",
},
retryAfterJitterMax: 0,
strategy: "string",
syncRate: 0,
windowSizes: [0],
windowType: "string",
},
controlPlaneId: "string",
consumer: {
id: "string",
},
consumerGroup: {
id: "string",
},
enabled: false,
gatewayPluginRateLimitingAdvancedId: "string",
instanceName: "string",
ordering: {
after: {
accesses: ["string"],
},
before: {
accesses: ["string"],
},
},
protocols: ["string"],
route: {
id: "string",
},
service: {
id: "string",
},
tags: ["string"],
});
type: konnect:GatewayPluginRateLimitingAdvanced
properties:
config:
compoundIdentifiers:
- string
consumerGroups:
- string
dictionaryName: string
disablePenalty: false
enforceConsumerGroups: false
errorCode: 0
errorMessage: string
headerName: string
hideClientHeaders: false
identifier: string
limits:
- 0
lockDictionaryName: string
namespace: string
path: string
redis:
clusterMaxRedirections: 0
clusterNodes:
- ip: string
port: 0
connectTimeout: 0
connectionIsProxied: false
database: 0
host: string
keepaliveBacklog: 0
keepalivePoolSize: 0
password: string
port: 0
readTimeout: 0
redisProxyType: string
sendTimeout: 0
sentinelMaster: string
sentinelNodes:
- host: string
port: 0
sentinelPassword: string
sentinelRole: string
sentinelUsername: string
serverName: string
ssl: false
sslVerify: false
username: string
retryAfterJitterMax: 0
strategy: string
syncRate: 0
windowSizes:
- 0
windowType: string
consumer:
id: string
consumerGroup:
id: string
controlPlaneId: string
enabled: false
gatewayPluginRateLimitingAdvancedId: string
instanceName: string
ordering:
after:
accesses:
- string
before:
accesses:
- string
protocols:
- string
route:
id: string
service:
id: string
tags:
- string
GatewayPluginRateLimitingAdvanced Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayPluginRateLimitingAdvanced resource accepts the following input properties:
- Config
Gateway
Plugin Rate Limiting Advanced Config - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Consumer
Gateway
Plugin Rate Limiting Advanced Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRate Limiting Advanced Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Rate Limiting Advanced Ordering - Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Rate Limiting Advanced Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Rate Limiting Advanced Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Config
Gateway
Plugin Rate Limiting Advanced Config Args - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Consumer
Gateway
Plugin Rate Limiting Advanced Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRate Limiting Advanced Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Rate Limiting Advanced Ordering Args - Protocols []string
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Rate Limiting Advanced Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Rate Limiting Advanced Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
Gateway
Plugin Rate Limiting Advanced Config - control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Rate Limiting Advanced Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRate Limiting Advanced Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Rate Limiting Advanced Ordering - protocols List<String>
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Rate Limiting Advanced Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Rate Limiting Advanced Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
Gateway
Plugin Rate Limiting Advanced Config - control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Rate Limiting Advanced Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringRate Limiting Advanced Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Rate Limiting Advanced Ordering - protocols string[]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Rate Limiting Advanced Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Rate Limiting Advanced Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
Gateway
Plugin Rate Limiting Advanced Config Args - control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Rate Limiting Advanced Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer_
group GatewayPlugin Rate Limiting Advanced Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strrate_ limiting_ advanced_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Rate Limiting Advanced Ordering Args - protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Rate Limiting Advanced Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Rate Limiting Advanced Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- config Property Map
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer Property Map
- If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer
Group Property Map - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRate Limiting Advanced Id - The ID of this resource.
- instance
Name String - ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service Property Map
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayPluginRateLimitingAdvanced resource produces the following output properties:
- created_
at float - Unix epoch when the resource was created.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at float - Unix epoch when the resource was last updated.
Look up Existing GatewayPluginRateLimitingAdvanced Resource
Get an existing GatewayPluginRateLimitingAdvanced resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayPluginRateLimitingAdvancedState, opts?: CustomResourceOptions): GatewayPluginRateLimitingAdvanced@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginRateLimitingAdvancedConfigArgs] = None,
consumer: Optional[GatewayPluginRateLimitingAdvancedConsumerArgs] = None,
consumer_group: Optional[GatewayPluginRateLimitingAdvancedConsumerGroupArgs] = None,
control_plane_id: Optional[str] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_rate_limiting_advanced_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginRateLimitingAdvancedOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginRateLimitingAdvancedRouteArgs] = None,
service: Optional[GatewayPluginRateLimitingAdvancedServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None) -> GatewayPluginRateLimitingAdvancedfunc GetGatewayPluginRateLimitingAdvanced(ctx *Context, name string, id IDInput, state *GatewayPluginRateLimitingAdvancedState, opts ...ResourceOption) (*GatewayPluginRateLimitingAdvanced, error)public static GatewayPluginRateLimitingAdvanced Get(string name, Input<string> id, GatewayPluginRateLimitingAdvancedState? state, CustomResourceOptions? opts = null)public static GatewayPluginRateLimitingAdvanced get(String name, Output<String> id, GatewayPluginRateLimitingAdvancedState state, CustomResourceOptions options)resources: _: type: konnect:GatewayPluginRateLimitingAdvanced get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Config
Gateway
Plugin Rate Limiting Advanced Config - Consumer
Gateway
Plugin Rate Limiting Advanced Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRate Limiting Advanced Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Rate Limiting Advanced Ordering - Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Rate Limiting Advanced Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Rate Limiting Advanced Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Config
Gateway
Plugin Rate Limiting Advanced Config Args - Consumer
Gateway
Plugin Rate Limiting Advanced Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringRate Limiting Advanced Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Rate Limiting Advanced Ordering Args - Protocols []string
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Rate Limiting Advanced Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Rate Limiting Advanced Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Rate Limiting Advanced Config - consumer
Gateway
Plugin Rate Limiting Advanced Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRate Limiting Advanced Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Rate Limiting Advanced Ordering - protocols List<String>
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Rate Limiting Advanced Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Rate Limiting Advanced Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Rate Limiting Advanced Config - consumer
Gateway
Plugin Rate Limiting Advanced Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer
Group GatewayPlugin Rate Limiting Advanced Consumer Group - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringRate Limiting Advanced Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Rate Limiting Advanced Ordering - protocols string[]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Rate Limiting Advanced Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Rate Limiting Advanced Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Rate Limiting Advanced Config Args - consumer
Gateway
Plugin Rate Limiting Advanced Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer_
group GatewayPlugin Rate Limiting Advanced Consumer Group Args - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strrate_ limiting_ advanced_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Rate Limiting Advanced Ordering Args - protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Rate Limiting Advanced Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Rate Limiting Advanced Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_
at float - Unix epoch when the resource was last updated.
- config Property Map
- consumer Property Map
- If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- consumer
Group Property Map - If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringRate Limiting Advanced Id - The ID of this resource.
- instance
Name String - ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service Property Map
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Supporting Types
GatewayPluginRateLimitingAdvancedConfig, GatewayPluginRateLimitingAdvancedConfigArgs
- Compound
Identifiers List<string> - Similar to
identifer, but supports combining multiple items. The priority ofcompound_identifieris higher thanidentifier, which means ifcompound_identiferis set, it will be used, otherwiseidentifierwill be used. - Consumer
Groups List<string> - List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if
enforce_consumer_groupsis set totrue. - Dictionary
Name string - The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is
config.strategyisclusterorredisandconfig.sync_rateisn'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 tofalse, all requests, including denied ones, are counted. This parameter only affects theslidingwindow_type. - Enforce
Consumer boolGroups - Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping
enforce_consumer_groupsfromtruetofalsedisables the group override, but does not clear the list of consumer groups. You can then flipenforce_consumer_groupstotrueto re-enforce the groups. - Error
Code double - Set a custom error code to return when the rate limit is exceeded.
- Error
Message string - Set a custom error message to return when the rate limit is exceeded.
- Header
Name string - A string representing an HTTP header name.
- Hide
Client boolHeaders - 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,pathorconsumer-group. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"] - Limits List<double>
- One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
- Lock
Dictionary stringName - 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
Gateway
Plugin Rate Limiting Advanced Config Redis - Retry
After doubleJitter Max - The upper bound of a jitter (random delay) in seconds to be added to the
Retry-Afterheader 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 is0; in this case, theRetry-Afterheader is equal to theRateLimit-Resetheader. - Strategy string
- The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are:
localandcluster. must be one of ["cluster", "local", "redis"] - Sync
Rate 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).
- Window
Sizes 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.
- Window
Type string - Sets the time window type to either
sliding(default) orfixed. 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. must be one of ["fixed", "sliding"]
- Compound
Identifiers []string - Similar to
identifer, but supports combining multiple items. The priority ofcompound_identifieris higher thanidentifier, which means ifcompound_identiferis set, it will be used, otherwiseidentifierwill be used. - Consumer
Groups []string - List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if
enforce_consumer_groupsis set totrue. - Dictionary
Name string - The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is
config.strategyisclusterorredisandconfig.sync_rateisn'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 tofalse, all requests, including denied ones, are counted. This parameter only affects theslidingwindow_type. - Enforce
Consumer boolGroups - Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping
enforce_consumer_groupsfromtruetofalsedisables the group override, but does not clear the list of consumer groups. You can then flipenforce_consumer_groupstotrueto re-enforce the groups. - Error
Code float64 - Set a custom error code to return when the rate limit is exceeded.
- Error
Message string - Set a custom error message to return when the rate limit is exceeded.
- Header
Name string - A string representing an HTTP header name.
- Hide
Client boolHeaders - 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,pathorconsumer-group. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"] - Limits []float64
- One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
- Lock
Dictionary stringName - 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
Gateway
Plugin Rate Limiting Advanced Config Redis - Retry
After float64Jitter Max - The upper bound of a jitter (random delay) in seconds to be added to the
Retry-Afterheader 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 is0; in this case, theRetry-Afterheader is equal to theRateLimit-Resetheader. - Strategy string
- The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are:
localandcluster. must be one of ["cluster", "local", "redis"] - Sync
Rate 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).
- Window
Sizes []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.
- Window
Type string - Sets the time window type to either
sliding(default) orfixed. 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. must be one of ["fixed", "sliding"]
- compound
Identifiers List<String> - Similar to
identifer, but supports combining multiple items. The priority ofcompound_identifieris higher thanidentifier, which means ifcompound_identiferis set, it will be used, otherwiseidentifierwill be used. - consumer
Groups List<String> - List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if
enforce_consumer_groupsis set totrue. - dictionary
Name String - The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is
config.strategyisclusterorredisandconfig.sync_rateisn't-1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle. - disable
Penalty Boolean - If set to
true, this doesn't count denied requests (status =429). If set tofalse, all requests, including denied ones, are counted. This parameter only affects theslidingwindow_type. - enforce
Consumer BooleanGroups - Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping
enforce_consumer_groupsfromtruetofalsedisables the group override, but does not clear the list of consumer groups. You can then flipenforce_consumer_groupstotrueto re-enforce the groups. - error
Code Double - Set a custom error code to return when the rate limit is exceeded.
- error
Message String - Set a custom error message to return when the rate limit is exceeded.
- header
Name String - A string representing an HTTP header name.
- hide
Client BooleanHeaders - 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,pathorconsumer-group. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"] - limits List<Double>
- One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
- lock
Dictionary StringName - 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
Gateway
Plugin Rate Limiting Advanced Config Redis - retry
After DoubleJitter Max - The upper bound of a jitter (random delay) in seconds to be added to the
Retry-Afterheader 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 is0; in this case, theRetry-Afterheader is equal to theRateLimit-Resetheader. - strategy String
- The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are:
localandcluster. must be one of ["cluster", "local", "redis"] - sync
Rate 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).
- window
Sizes 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.
- window
Type String - Sets the time window type to either
sliding(default) orfixed. 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. must be one of ["fixed", "sliding"]
- compound
Identifiers string[] - Similar to
identifer, but supports combining multiple items. The priority ofcompound_identifieris higher thanidentifier, which means ifcompound_identiferis set, it will be used, otherwiseidentifierwill be used. - consumer
Groups string[] - List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if
enforce_consumer_groupsis set totrue. - dictionary
Name string - The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is
config.strategyisclusterorredisandconfig.sync_rateisn't-1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle. - disable
Penalty boolean - If set to
true, this doesn't count denied requests (status =429). If set tofalse, all requests, including denied ones, are counted. This parameter only affects theslidingwindow_type. - enforce
Consumer booleanGroups - Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping
enforce_consumer_groupsfromtruetofalsedisables the group override, but does not clear the list of consumer groups. You can then flipenforce_consumer_groupstotrueto re-enforce the groups. - error
Code number - Set a custom error code to return when the rate limit is exceeded.
- error
Message string - Set a custom error message to return when the rate limit is exceeded.
- header
Name string - A string representing an HTTP header name.
- hide
Client booleanHeaders - 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,pathorconsumer-group. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"] - limits number[]
- One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
- lock
Dictionary stringName - 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
Gateway
Plugin Rate Limiting Advanced Config Redis - retry
After numberJitter Max - The upper bound of a jitter (random delay) in seconds to be added to the
Retry-Afterheader 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 is0; in this case, theRetry-Afterheader is equal to theRateLimit-Resetheader. - strategy string
- The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are:
localandcluster. must be one of ["cluster", "local", "redis"] - sync
Rate 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).
- window
Sizes 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.
- window
Type string - Sets the time window type to either
sliding(default) orfixed. 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. must be one of ["fixed", "sliding"]
- compound_
identifiers Sequence[str] - Similar to
identifer, but supports combining multiple items. The priority ofcompound_identifieris higher thanidentifier, which means ifcompound_identiferis set, it will be used, otherwiseidentifierwill 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_groupsis set totrue. - dictionary_
name str - The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is
config.strategyisclusterorredisandconfig.sync_rateisn'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 tofalse, all requests, including denied ones, are counted. This parameter only affects theslidingwindow_type. - enforce_
consumer_ boolgroups - Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping
enforce_consumer_groupsfromtruetofalsedisables the group override, but does not clear the list of consumer groups. You can then flipenforce_consumer_groupstotrueto 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_ boolheaders - 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,pathorconsumer-group. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"] - 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_ strname - 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
Gateway
Plugin Rate Limiting Advanced Config Redis - retry_
after_ floatjitter_ max - The upper bound of a jitter (random delay) in seconds to be added to the
Retry-Afterheader 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 is0; in this case, theRetry-Afterheader is equal to theRateLimit-Resetheader. - strategy str
- The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are:
localandcluster. must be one of ["cluster", "local", "redis"] - sync_
rate float - How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 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) orfixed. 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. must be one of ["fixed", "sliding"]
- compound
Identifiers List<String> - Similar to
identifer, but supports combining multiple items. The priority ofcompound_identifieris higher thanidentifier, which means ifcompound_identiferis set, it will be used, otherwiseidentifierwill be used. - consumer
Groups List<String> - List of consumer groups allowed to override the rate limiting settings for the given Route or Service. Required if
enforce_consumer_groupsis set totrue. - dictionary
Name String - The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is
config.strategyisclusterorredisandconfig.sync_rateisn't-1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle. - disable
Penalty Boolean - If set to
true, this doesn't count denied requests (status =429). If set tofalse, all requests, including denied ones, are counted. This parameter only affects theslidingwindow_type. - enforce
Consumer BooleanGroups - Determines if consumer groups are allowed to override the rate limiting settings for the given Route or Service. Flipping
enforce_consumer_groupsfromtruetofalsedisables the group override, but does not clear the list of consumer groups. You can then flipenforce_consumer_groupstotrueto re-enforce the groups. - error
Code Number - Set a custom error code to return when the rate limit is exceeded.
- error
Message String - Set a custom error message to return when the rate limit is exceeded.
- header
Name String - A string representing an HTTP header name.
- hide
Client BooleanHeaders - 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,pathorconsumer-group. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"] - limits List<Number>
- One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.
- lock
Dictionary StringName - 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
- retry
After NumberJitter Max - The upper bound of a jitter (random delay) in seconds to be added to the
Retry-Afterheader 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 is0; in this case, theRetry-Afterheader is equal to theRateLimit-Resetheader. - strategy String
- The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are:
localandcluster. must be one of ["cluster", "local", "redis"] - sync
Rate 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).
- window
Sizes 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.
- window
Type String - Sets the time window type to either
sliding(default) orfixed. 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. must be one of ["fixed", "sliding"]
GatewayPluginRateLimitingAdvancedConfigRedis, GatewayPluginRateLimitingAdvancedConfigRedisArgs
- Cluster
Max doubleRedirections - Maximum retry attempts for redirection.
- Cluster
Nodes List<GatewayPlugin Rate Limiting Advanced Config Redis Cluster Node> - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - Connect
Timeout double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Connection
Is boolProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - Database double
- Database to use for the Redis connection when using the
redisstrategy - Host string
- A string representing a host name, such as example.com.
- Keepalive
Backlog 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 thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - Keepalive
Pool doubleSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis 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.
- Read
Timeout double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Redis
Proxy stringType - If the
connection_is_proxiedis 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. must be "envoy_v1.31" - Send
Timeout double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Sentinel
Master string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- Sentinel
Nodes List<GatewayPlugin Rate Limiting Advanced Config Redis Sentinel Node> - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - Sentinel
Password string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- Sentinel
Role string - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - Sentinel
Username string - 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 string - 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_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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 float64Redirections - Maximum retry attempts for redirection.
- Cluster
Nodes []GatewayPlugin Rate Limiting Advanced Config Redis Cluster Node - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - Connect
Timeout float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Connection
Is boolProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - Database float64
- Database to use for the Redis connection when using the
redisstrategy - Host string
- A string representing a host name, such as example.com.
- Keepalive
Backlog 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 thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - Keepalive
Pool float64Size - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis 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.
- Read
Timeout float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Redis
Proxy stringType - If the
connection_is_proxiedis 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. must be "envoy_v1.31" - Send
Timeout float64 - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- Sentinel
Master string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- Sentinel
Nodes []GatewayPlugin Rate Limiting Advanced Config Redis Sentinel Node - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - Sentinel
Password string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- Sentinel
Role string - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - Sentinel
Username string - 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 string - 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_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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 DoubleRedirections - Maximum retry attempts for redirection.
- cluster
Nodes List<GatewayPlugin Rate Limiting Advanced Config Redis Cluster Node> - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect
Timeout Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is BooleanProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database Double
- Database to use for the Redis connection when using the
redisstrategy - host String
- A string representing a host name, such as example.com.
- keepalive
Backlog 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 thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive
Pool DoubleSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis 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.
- read
Timeout Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- redis
Proxy StringType - If the
connection_is_proxiedis 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. must be "envoy_v1.31" - send
Timeout Double - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master String - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes List<GatewayPlugin Rate Limiting Advanced Config Redis Sentinel Node> - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel
Password String - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role String - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel
Username String - 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 String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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 numberRedirections - Maximum retry attempts for redirection.
- cluster
Nodes GatewayPlugin Rate Limiting Advanced Config Redis Cluster Node[] - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect
Timeout number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is booleanProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database number
- Database to use for the Redis connection when using the
redisstrategy - host string
- A string representing a host name, such as example.com.
- keepalive
Backlog 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 thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive
Pool numberSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis 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.
- read
Timeout number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- redis
Proxy stringType - If the
connection_is_proxiedis 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. must be "envoy_v1.31" - send
Timeout number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master string - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes GatewayPlugin Rate Limiting Advanced Config Redis Sentinel Node[] - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel
Password string - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role string - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel
Username string - 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 string - A string representing an SNI (server name indication) value for TLS.
- ssl boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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_ floatredirections - Maximum retry attempts for redirection.
- cluster_
nodes Sequence[GatewayPlugin Rate Limiting Advanced Config Redis Cluster Node] - Cluster addresses to use for Redis connections when the
redisstrategy 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_ boolproxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database float
- Database to use for the Redis connection when using the
redisstrategy - 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 thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive_
pool_ floatsize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis 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_ strtype - If the
connection_is_proxiedis 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. must be "envoy_v1.31" - 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[GatewayPlugin Rate Limiting Advanced Config Redis Sentinel Node] - Sentinel node addresses to use for Redis connections when the
redisstrategy 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
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel_
username str - Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.
- server_
name str - A string representing an SNI (server name indication) value for TLS.
- ssl bool
- If set to true, uses SSL to connect to Redis.
- ssl_
verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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.
- cluster
Max NumberRedirections - Maximum retry attempts for redirection.
- cluster
Nodes List<Property Map> - Cluster addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element. - connect
Timeout Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- connection
Is BooleanProxied - If the connection to Redis is proxied (e.g. Envoy), set it
true. Set thehostandportto point to the proxy address. - database Number
- Database to use for the Redis connection when using the
redisstrategy - host String
- A string representing a host name, such as example.com.
- keepalive
Backlog 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 thankeepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger thankeepalive_pool_size. - keepalive
Pool NumberSize - The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither
keepalive_pool_sizenorkeepalive_backlogis specified, no pool is created. Ifkeepalive_pool_sizeisn't specified butkeepalive_backlogis 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.
- read
Timeout Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- redis
Proxy StringType - If the
connection_is_proxiedis 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. must be "envoy_v1.31" - send
Timeout Number - An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
- sentinel
Master String - Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
- sentinel
Nodes List<Property Map> - Sentinel node addresses to use for Redis connections when the
redisstrategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element. - sentinel
Password String - Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.
- sentinel
Role String - Sentinel role to use for Redis connections when the
redisstrategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"] - sentinel
Username String - 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 String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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.
GatewayPluginRateLimitingAdvancedConfigRedisClusterNode, GatewayPluginRateLimitingAdvancedConfigRedisClusterNodeArgs
GatewayPluginRateLimitingAdvancedConfigRedisSentinelNode, GatewayPluginRateLimitingAdvancedConfigRedisSentinelNodeArgs
GatewayPluginRateLimitingAdvancedConsumer, GatewayPluginRateLimitingAdvancedConsumerArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginRateLimitingAdvancedConsumerGroup, GatewayPluginRateLimitingAdvancedConsumerGroupArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginRateLimitingAdvancedOrdering, GatewayPluginRateLimitingAdvancedOrderingArgs
GatewayPluginRateLimitingAdvancedOrderingAfter, GatewayPluginRateLimitingAdvancedOrderingAfterArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginRateLimitingAdvancedOrderingBefore, GatewayPluginRateLimitingAdvancedOrderingBeforeArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginRateLimitingAdvancedRoute, GatewayPluginRateLimitingAdvancedRouteArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginRateLimitingAdvancedService, GatewayPluginRateLimitingAdvancedServiceArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
$ pulumi import konnect:index/gatewayPluginRateLimitingAdvanced:GatewayPluginRateLimitingAdvanced my_konnect_gateway_plugin_rate_limiting_advanced "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.