Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginRateLimiting
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginRateLimiting

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

Using getGatewayPluginRateLimiting

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

function getGatewayPluginRateLimiting(args: GetGatewayPluginRateLimitingArgs, opts?: InvokeOptions): Promise<GetGatewayPluginRateLimitingResult>
function getGatewayPluginRateLimitingOutput(args: GetGatewayPluginRateLimitingOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginRateLimitingResult>
Copy
def get_gateway_plugin_rate_limiting(control_plane_id: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetGatewayPluginRateLimitingResult
def get_gateway_plugin_rate_limiting_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                     opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginRateLimitingResult]
Copy
func LookupGatewayPluginRateLimiting(ctx *Context, args *LookupGatewayPluginRateLimitingArgs, opts ...InvokeOption) (*LookupGatewayPluginRateLimitingResult, error)
func LookupGatewayPluginRateLimitingOutput(ctx *Context, args *LookupGatewayPluginRateLimitingOutputArgs, opts ...InvokeOption) LookupGatewayPluginRateLimitingResultOutput
Copy

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

public static class GetGatewayPluginRateLimiting 
{
    public static Task<GetGatewayPluginRateLimitingResult> InvokeAsync(GetGatewayPluginRateLimitingArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginRateLimitingResult> Invoke(GetGatewayPluginRateLimitingInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGatewayPluginRateLimitingResult> getGatewayPluginRateLimiting(GetGatewayPluginRateLimitingArgs args, InvokeOptions options)
public static Output<GetGatewayPluginRateLimitingResult> getGatewayPluginRateLimiting(GetGatewayPluginRateLimitingArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginRateLimiting:getGatewayPluginRateLimiting
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ControlPlaneId This property is required. string
ControlPlaneId This property is required. string
controlPlaneId This property is required. String
controlPlaneId This property is required. string
control_plane_id This property is required. str
controlPlaneId This property is required. String

getGatewayPluginRateLimiting Result

The following output properties are available:

Supporting Types

GetGatewayPluginRateLimitingConfig

Day This property is required. double
The number of HTTP requests that can be made per day.
ErrorCode This property is required. double
Set a custom error code to return when the rate limit is exceeded.
ErrorMessage This property is required. string
Set a custom error message to return when the rate limit is exceeded.
FaultTolerant This property is required. bool
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.
HeaderName This property is required. string
A string representing an HTTP header name.
HideClientHeaders This property is required. bool
Optionally hide informative response headers.
Hour This property is required. double
The number of HTTP requests that can be made per hour.
LimitBy This property is required. string
The entity that is used when aggregating the limits.
Minute This property is required. double
The number of HTTP requests that can be made per minute.
Month This property is required. double
The number of HTTP requests that can be made per month.
Path This property is required. 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).
Policy This property is required. string
The rate-limiting policies to use for retrieving and incrementing the limits.
Redis This property is required. GetGatewayPluginRateLimitingConfigRedis
Redis configuration
Second This property is required. double
The number of HTTP requests that can be made per second.
SyncRate This property is required. double
How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
Year This property is required. double
The number of HTTP requests that can be made per year.
Day This property is required. float64
The number of HTTP requests that can be made per day.
ErrorCode This property is required. float64
Set a custom error code to return when the rate limit is exceeded.
ErrorMessage This property is required. string
Set a custom error message to return when the rate limit is exceeded.
FaultTolerant This property is required. bool
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.
HeaderName This property is required. string
A string representing an HTTP header name.
HideClientHeaders This property is required. bool
Optionally hide informative response headers.
Hour This property is required. float64
The number of HTTP requests that can be made per hour.
LimitBy This property is required. string
The entity that is used when aggregating the limits.
Minute This property is required. float64
The number of HTTP requests that can be made per minute.
Month This property is required. float64
The number of HTTP requests that can be made per month.
Path This property is required. 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).
Policy This property is required. string
The rate-limiting policies to use for retrieving and incrementing the limits.
Redis This property is required. GetGatewayPluginRateLimitingConfigRedis
Redis configuration
Second This property is required. float64
The number of HTTP requests that can be made per second.
SyncRate This property is required. float64
How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
Year This property is required. float64
The number of HTTP requests that can be made per year.
day This property is required. Double
The number of HTTP requests that can be made per day.
errorCode This property is required. Double
Set a custom error code to return when the rate limit is exceeded.
errorMessage This property is required. String
Set a custom error message to return when the rate limit is exceeded.
faultTolerant This property is required. Boolean
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.
headerName This property is required. String
A string representing an HTTP header name.
hideClientHeaders This property is required. Boolean
Optionally hide informative response headers.
hour This property is required. Double
The number of HTTP requests that can be made per hour.
limitBy This property is required. String
The entity that is used when aggregating the limits.
minute This property is required. Double
The number of HTTP requests that can be made per minute.
month This property is required. Double
The number of HTTP requests that can be made per month.
path This property is required. 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).
policy This property is required. String
The rate-limiting policies to use for retrieving and incrementing the limits.
redis This property is required. GetGatewayPluginRateLimitingConfigRedis
Redis configuration
second This property is required. Double
The number of HTTP requests that can be made per second.
syncRate This property is required. Double
How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
year This property is required. Double
The number of HTTP requests that can be made per year.
day This property is required. number
The number of HTTP requests that can be made per day.
errorCode This property is required. number
Set a custom error code to return when the rate limit is exceeded.
errorMessage This property is required. string
Set a custom error message to return when the rate limit is exceeded.
faultTolerant This property is required. boolean
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.
headerName This property is required. string
A string representing an HTTP header name.
hideClientHeaders This property is required. boolean
Optionally hide informative response headers.
hour This property is required. number
The number of HTTP requests that can be made per hour.
limitBy This property is required. string
The entity that is used when aggregating the limits.
minute This property is required. number
The number of HTTP requests that can be made per minute.
month This property is required. number
The number of HTTP requests that can be made per month.
path This property is required. 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).
policy This property is required. string
The rate-limiting policies to use for retrieving and incrementing the limits.
redis This property is required. GetGatewayPluginRateLimitingConfigRedis
Redis configuration
second This property is required. number
The number of HTTP requests that can be made per second.
syncRate This property is required. number
How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
year This property is required. number
The number of HTTP requests that can be made per year.
day This property is required. float
The number of HTTP requests that can be made per day.
error_code This property is required. float
Set a custom error code to return when the rate limit is exceeded.
error_message This property is required. str
Set a custom error message to return when the rate limit is exceeded.
fault_tolerant This property is required. bool
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.
header_name This property is required. str
A string representing an HTTP header name.
hide_client_headers This property is required. bool
Optionally hide informative response headers.
hour This property is required. float
The number of HTTP requests that can be made per hour.
limit_by This property is required. str
The entity that is used when aggregating the limits.
minute This property is required. float
The number of HTTP requests that can be made per minute.
month This property is required. float
The number of HTTP requests that can be made per month.
path This property is required. 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).
policy This property is required. str
The rate-limiting policies to use for retrieving and incrementing the limits.
redis This property is required. GetGatewayPluginRateLimitingConfigRedis
Redis configuration
second This property is required. float
The number of HTTP requests that can be made per second.
sync_rate This property is required. float
How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
year This property is required. float
The number of HTTP requests that can be made per year.
day This property is required. Number
The number of HTTP requests that can be made per day.
errorCode This property is required. Number
Set a custom error code to return when the rate limit is exceeded.
errorMessage This property is required. String
Set a custom error message to return when the rate limit is exceeded.
faultTolerant This property is required. Boolean
A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party data store. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the data store is working again. If false, then the clients will see 500 errors.
headerName This property is required. String
A string representing an HTTP header name.
hideClientHeaders This property is required. Boolean
Optionally hide informative response headers.
hour This property is required. Number
The number of HTTP requests that can be made per hour.
limitBy This property is required. String
The entity that is used when aggregating the limits.
minute This property is required. Number
The number of HTTP requests that can be made per minute.
month This property is required. Number
The number of HTTP requests that can be made per month.
path This property is required. 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).
policy This property is required. String
The rate-limiting policies to use for retrieving and incrementing the limits.
redis This property is required. Property Map
Redis configuration
second This property is required. Number
The number of HTTP requests that can be made per second.
syncRate This property is required. Number
How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
year This property is required. Number
The number of HTTP requests that can be made per year.

GetGatewayPluginRateLimitingConfigRedis

Database This property is required. double
Database to use for the Redis connection when using the redis strategy
Host This property is required. string
A string representing a host name, such as example.com.
Password This property is required. string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
Port This property is required. double
An integer representing a port number between 0 and 65535, inclusive.
ServerName This property is required. string
A string representing an SNI (server name indication) value for TLS.
Ssl This property is required. bool
If set to true, uses SSL to connect to Redis.
SslVerify This property is required. 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.
Timeout This property is required. double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Username This property is required. 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.
Database This property is required. float64
Database to use for the Redis connection when using the redis strategy
Host This property is required. string
A string representing a host name, such as example.com.
Password This property is required. string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
Port This property is required. float64
An integer representing a port number between 0 and 65535, inclusive.
ServerName This property is required. string
A string representing an SNI (server name indication) value for TLS.
Ssl This property is required. bool
If set to true, uses SSL to connect to Redis.
SslVerify This property is required. 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.
Timeout This property is required. float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
Username This property is required. 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.
database This property is required. Double
Database to use for the Redis connection when using the redis strategy
host This property is required. String
A string representing a host name, such as example.com.
password This property is required. String
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. Double
An integer representing a port number between 0 and 65535, inclusive.
serverName This property is required. String
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. Boolean
If set to true, uses SSL to connect to Redis.
sslVerify This property is required. 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.
timeout This property is required. Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. 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.
database This property is required. number
Database to use for the Redis connection when using the redis strategy
host This property is required. string
A string representing a host name, such as example.com.
password This property is required. string
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. number
An integer representing a port number between 0 and 65535, inclusive.
serverName This property is required. string
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. boolean
If set to true, uses SSL to connect to Redis.
sslVerify This property is required. 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.
timeout This property is required. number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. 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.
database This property is required. float
Database to use for the Redis connection when using the redis strategy
host This property is required. str
A string representing a host name, such as example.com.
password This property is required. str
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. float
An integer representing a port number between 0 and 65535, inclusive.
server_name This property is required. str
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. bool
If set to true, uses SSL to connect to Redis.
ssl_verify This property is required. 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.
timeout This property is required. float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. 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.
database This property is required. Number
Database to use for the Redis connection when using the redis strategy
host This property is required. String
A string representing a host name, such as example.com.
password This property is required. String
Password to use for Redis connections. If undefined, no AUTH commands are sent to Redis.
port This property is required. Number
An integer representing a port number between 0 and 65535, inclusive.
serverName This property is required. String
A string representing an SNI (server name indication) value for TLS.
ssl This property is required. Boolean
If set to true, uses SSL to connect to Redis.
sslVerify This property is required. 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.
timeout This property is required. Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
username This property is required. 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.

GetGatewayPluginRateLimitingConsumer

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginRateLimitingConsumerGroup

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginRateLimitingOrdering

after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginRateLimitingOrderingAfter

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginRateLimitingOrderingBefore

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginRateLimitingRoute

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginRateLimitingService

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect