konnect.GatewayPluginServiceProtection

Coming soon!

Coming soon!

Coming soon!

Coming soon!

name string

The unique name of the resource.

args GatewayPluginServiceProtectionArgs

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 GatewayPluginServiceProtectionArgs

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 GatewayPluginServiceProtectionArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginServiceProtectionArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginServiceProtectionArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

Config GatewayPluginServiceProtectionConfig

ControlPlaneId string

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

Enabled bool

Whether the plugin is applied.

GatewayPluginServiceProtectionId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginServiceProtectionOrdering

Protocols List<string>

A set of strings representing HTTP protocols.

Service GatewayPluginServiceProtectionService

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

Tags List<string>

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

Config GatewayPluginServiceProtectionConfigArgs

ControlPlaneId string

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

Enabled bool

Whether the plugin is applied.

GatewayPluginServiceProtectionId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginServiceProtectionOrderingArgs

Protocols []string

A set of strings representing HTTP protocols.

Service GatewayPluginServiceProtectionServiceArgs

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

Tags []string

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

config GatewayPluginServiceProtectionConfig

controlPlaneId String

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

enabled Boolean

Whether the plugin is applied.

gatewayPluginServiceProtectionId String

The ID of this resource.

instanceName String

ordering GatewayPluginServiceProtectionOrdering

protocols List<String>

A set of strings representing HTTP protocols.

service GatewayPluginServiceProtectionService

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

tags List<String>

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

config GatewayPluginServiceProtectionConfig

controlPlaneId string

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

enabled boolean

Whether the plugin is applied.

gatewayPluginServiceProtectionId string

The ID of this resource.

instanceName string

ordering GatewayPluginServiceProtectionOrdering

protocols string[]

A set of strings representing HTTP protocols.

service GatewayPluginServiceProtectionService

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

tags string[]

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

config GatewayPluginServiceProtectionConfigArgs

control_plane_id str

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

enabled bool

Whether the plugin is applied.

gateway_plugin_service_protection_id str

The ID of this resource.

instance_name str

ordering GatewayPluginServiceProtectionOrderingArgs

protocols Sequence[str]

A set of strings representing HTTP protocols.

service GatewayPluginServiceProtectionServiceArgs

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

tags Sequence[str]

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

config Property Map

controlPlaneId String

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

enabled Boolean

Whether the plugin is applied.

gatewayPluginServiceProtectionId String

The ID of this resource.

instanceName String

ordering Property Map

protocols List<String>

A set of strings representing HTTP protocols.

service Property Map

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

tags List<String>

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

CreatedAt double

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt double

Unix epoch when the resource was last updated.

CreatedAt float64

Unix epoch when the resource was created.

Id string

The provider-assigned unique ID for this managed resource.

UpdatedAt float64

Unix epoch when the resource was last updated.

createdAt Double

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Double

Unix epoch when the resource was last updated.

createdAt number

Unix epoch when the resource was created.

id string

The provider-assigned unique ID for this managed resource.

updatedAt number

Unix epoch when the resource was last updated.

created_at float

Unix epoch when the resource was created.

id str

The provider-assigned unique ID for this managed resource.

updated_at float

Unix epoch when the resource was last updated.

createdAt Number

Unix epoch when the resource was created.

id String

The provider-assigned unique ID for this managed resource.

updatedAt Number

Unix epoch when the resource was last updated.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

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

resource_name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

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

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

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

name

The unique name of the resulting resource.

id

The unique provider ID of the resource to lookup.

state

Any extra arguments used during the lookup.

opts

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

DictionaryName string

The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.

DisablePenalty bool

If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.

ErrorCode double

Set a custom error code to return when the rate limit is exceeded.

ErrorMessage string

Set a custom error message to return when the rate limit is exceeded.

HideClientHeaders bool

Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.

Limits List<double>

One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.

LockDictionaryName string

The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared 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.

Redis GatewayPluginServiceProtectionConfigRedis

RetryAfterJitterMax double

The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

Strategy string

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

SyncRate double

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).

WindowSizes List<double>

One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.

WindowType string

Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

DictionaryName string

The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.

DisablePenalty bool

If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.

ErrorCode float64

Set a custom error code to return when the rate limit is exceeded.

ErrorMessage string

Set a custom error message to return when the rate limit is exceeded.

HideClientHeaders bool

Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.

Limits []float64

One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.

LockDictionaryName string

The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared 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.

Redis GatewayPluginServiceProtectionConfigRedis

RetryAfterJitterMax float64

The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

Strategy string

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

SyncRate float64

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).

WindowSizes []float64

One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.

WindowType string

Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

dictionaryName String

The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.

disablePenalty Boolean

If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.

errorCode Double

Set a custom error code to return when the rate limit is exceeded.

errorMessage String

Set a custom error message to return when the rate limit is exceeded.

hideClientHeaders Boolean

Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.

limits List<Double>

One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.

lockDictionaryName String

The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared 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.

redis GatewayPluginServiceProtectionConfigRedis

retryAfterJitterMax Double

The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

strategy String

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

syncRate Double

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).

windowSizes List<Double>

One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.

windowType String

Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

dictionaryName string

The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.

disablePenalty boolean

If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.

errorCode number

Set a custom error code to return when the rate limit is exceeded.

errorMessage string

Set a custom error message to return when the rate limit is exceeded.

hideClientHeaders boolean

Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.

limits number[]

One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.

lockDictionaryName string

The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared 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.

redis GatewayPluginServiceProtectionConfigRedis

retryAfterJitterMax number

The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

strategy string

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

syncRate number

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).

windowSizes number[]

One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.

windowType string

Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

dictionary_name str

The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.

disable_penalty bool

If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.

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.

hide_client_headers bool

Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.

limits Sequence[float]

One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.

lock_dictionary_name str

The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared 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.

redis GatewayPluginServiceProtectionConfigRedis

retry_after_jitter_max float

The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

strategy str

The rate-limiting strategy to use for retrieving and incrementing the limits. Available values are: local and cluster. 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) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

dictionaryName String

The shared dictionary where counters are stored. When the plugin is configured to synchronize counter data externally (that is config.strategy is cluster or redis and config.sync_rate isn't -1), this dictionary serves as a buffer to populate counters in the data store on each synchronization cycle.

disablePenalty Boolean

If set to true, this doesn't count denied requests (status = 429). If set to false, all requests, including denied ones, are counted. This parameter only affects the sliding window_type.

errorCode Number

Set a custom error code to return when the rate limit is exceeded.

errorMessage String

Set a custom error message to return when the rate limit is exceeded.

hideClientHeaders Boolean

Optionally hide informative response headers that would otherwise provide information about the current status of limits and counters.

limits List<Number>

One or more requests-per-window limits to apply. There must be a matching number of window limits and sizes specified.

lockDictionaryName String

The shared dictionary where concurrency control locks are stored. The default shared dictionary is kong_locks. The shared dictionary should be declared 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.

redis Property Map

retryAfterJitterMax Number

The upper bound of a jitter (random delay) in seconds to be added to the Retry-After header of denied requests (status = 429) in order to prevent all the clients from coming back at the same time. The lower bound of the jitter is 0; in this case, the Retry-After header is equal to the RateLimit-Reset header.

strategy String

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

syncRate Number

How often to sync counter data to the central data store. A value of 0 results in synchronous behavior; a value of -1 ignores sync behavior entirely and only stores counters in node memory. A value greater than 0 will sync the counters in the specified number of seconds. The minimum allowed interval is 0.02 seconds (20ms).

windowSizes List<Number>

One or more window sizes to apply a limit to (defined in seconds). There must be a matching number of window limits and sizes specified.

windowType String

Sets the time window type to either sliding (default) or fixed. Sliding windows apply the rate limiting logic while taking into account previous hit rates (from the window that immediately precedes the current) using a dynamic weight. Fixed windows consist of buckets that are statically assigned to a definitive time range, each request is mapped to only one fixed window based on its timestamp and will affect only that window's counters. must be one of ["fixed", "sliding"]

ClusterMaxRedirections double

Maximum retry attempts for redirection.

ClusterNodes List<GatewayPluginServiceProtectionConfigRedisClusterNode>

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

ConnectTimeout double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

ConnectionIsProxied bool

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

Database double

Database to use for the Redis connection when using the redis strategy

Host string

A string representing a host name, such as example.com.

KeepaliveBacklog double

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

KeepalivePoolSize double

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.

Password string

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.

Port double

An integer representing a port number between 0 and 65535, inclusive.

ReadTimeout double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

SendTimeout double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

SentinelMaster string

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

SentinelNodes List<GatewayPluginServiceProtectionConfigRedisSentinelNode>

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

SentinelPassword string

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

SentinelRole string

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

SentinelUsername string

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

ServerName string

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

Ssl bool

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

SslVerify bool

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

Username string

Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

ClusterMaxRedirections float64

Maximum retry attempts for redirection.

ClusterNodes []GatewayPluginServiceProtectionConfigRedisClusterNode

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

ConnectTimeout float64

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

ConnectionIsProxied bool

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

Database float64

Database to use for the Redis connection when using the redis strategy

Host string

A string representing a host name, such as example.com.

KeepaliveBacklog float64

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

KeepalivePoolSize float64

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.

Password string

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.

Port float64

An integer representing a port number between 0 and 65535, inclusive.

ReadTimeout float64

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

SendTimeout float64

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

SentinelMaster string

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

SentinelNodes []GatewayPluginServiceProtectionConfigRedisSentinelNode

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

SentinelPassword string

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

SentinelRole string

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

SentinelUsername string

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

ServerName string

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

Ssl bool

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

SslVerify bool

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

Username string

Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

clusterMaxRedirections Double

Maximum retry attempts for redirection.

clusterNodes List<GatewayPluginServiceProtectionConfigRedisClusterNode>

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connectTimeout Double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

connectionIsProxied Boolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

database Double

Database to use for the Redis connection when using the redis strategy

host String

A string representing a host name, such as example.com.

keepaliveBacklog Double

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalivePoolSize Double

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.

password String

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.

port Double

An integer representing a port number between 0 and 65535, inclusive.

readTimeout Double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sendTimeout Double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sentinelMaster String

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinelNodes List<GatewayPluginServiceProtectionConfigRedisSentinelNode>

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinelPassword String

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinelRole String

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinelUsername String

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

serverName String

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

ssl Boolean

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

sslVerify Boolean

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

username String

Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

clusterMaxRedirections number

Maximum retry attempts for redirection.

clusterNodes GatewayPluginServiceProtectionConfigRedisClusterNode[]

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connectTimeout number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

connectionIsProxied boolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

database number

Database to use for the Redis connection when using the redis strategy

host string

A string representing a host name, such as example.com.

keepaliveBacklog number

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalivePoolSize number

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.

password string

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.

port number

An integer representing a port number between 0 and 65535, inclusive.

readTimeout number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sendTimeout number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sentinelMaster string

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinelNodes GatewayPluginServiceProtectionConfigRedisSentinelNode[]

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinelPassword string

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinelRole string

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinelUsername string

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

serverName string

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

ssl boolean

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

sslVerify boolean

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

username string

Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

cluster_max_redirections float

Maximum retry attempts for redirection.

cluster_nodes Sequence[GatewayPluginServiceProtectionConfigRedisClusterNode]

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connect_timeout float

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

connection_is_proxied bool

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

database float

Database to use for the Redis connection when using the redis strategy

host str

A string representing a host name, such as example.com.

keepalive_backlog float

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalive_pool_size float

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.

password str

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.

port float

An integer representing a port number between 0 and 65535, inclusive.

read_timeout float

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

send_timeout float

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sentinel_master str

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinel_nodes Sequence[GatewayPluginServiceProtectionConfigRedisSentinelNode]

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinel_password str

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinel_role str

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinel_username str

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

server_name str

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

ssl bool

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

ssl_verify bool

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

username str

Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

clusterMaxRedirections Number

Maximum retry attempts for redirection.

clusterNodes List<Property Map>

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connectTimeout Number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

connectionIsProxied Boolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address.

database Number

Database to use for the Redis connection when using the redis strategy

host String

A string representing a host name, such as example.com.

keepaliveBacklog Number

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalivePoolSize Number

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low.

password String

Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.

port Number

An integer representing a port number between 0 and 65535, inclusive.

readTimeout Number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sendTimeout Number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.

sentinelMaster String

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinelNodes List<Property Map>

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinelPassword String

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinelRole String

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinelUsername String

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

serverName String

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

ssl Boolean

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

sslVerify Boolean

If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure lua_ssl_trusted_certificate in kong.conf to specify the CA (or server) certificate used by your Redis server. You may also need to configure lua_ssl_verify_depth accordingly.

username String

Username to use for Redis connections. If undefined, ACL authentication won't be performed. This requires Redis v6.0.0+. To be compatible with Redis v5.x.y, you can set it to default.

Ip string

A string representing a host name, such as example.com.

Port double

An integer representing a port number between 0 and 65535, inclusive.

Ip string

A string representing a host name, such as example.com.

Port float64

An integer representing a port number between 0 and 65535, inclusive.

ip String

A string representing a host name, such as example.com.

port Double

An integer representing a port number between 0 and 65535, inclusive.

ip string

A string representing a host name, such as example.com.

port number

An integer representing a port number between 0 and 65535, inclusive.