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 logo
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>
    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]
    func LookupGatewayPluginRateLimiting(ctx *Context, args *LookupGatewayPluginRateLimitingArgs, opts ...InvokeOption) (*LookupGatewayPluginRateLimitingResult, error)
func LookupGatewayPluginRateLimitingOutput(ctx *Context, args *LookupGatewayPluginRateLimitingOutputArgs, opts ...InvokeOption) LookupGatewayPluginRateLimitingResultOutput

    > 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)
}
    public static CompletableFuture<GetGatewayPluginRateLimitingResult> getGatewayPluginRateLimiting(GetGatewayPluginRateLimitingArgs args, InvokeOptions options)
public static Output<GetGatewayPluginRateLimitingResult> getGatewayPluginRateLimiting(GetGatewayPluginRateLimitingArgs args, InvokeOptions options)

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

    The following arguments are supported:

    getGatewayPluginRateLimiting Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginRateLimitingConfig

    Day double
    The number of HTTP requests that can be made per day.
    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.
    FaultTolerant 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 string
    A string representing an HTTP header name.
    HideClientHeaders bool
    Optionally hide informative response headers.
    Hour double
    The number of HTTP requests that can be made per hour.
    LimitBy string
    The entity that is used when aggregating the limits.
    Minute double
    The number of HTTP requests that can be made per minute.
    Month double
    The number of HTTP requests that can be made per month.
    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).
    Policy string
    The rate-limiting policies to use for retrieving and incrementing the limits.
    Redis GetGatewayPluginRateLimitingConfigRedis
    Redis configuration
    Second double
    The number of HTTP requests that can be made per second.
    SyncRate double
    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    Year double
    The number of HTTP requests that can be made per year.
    Day float64
    The number of HTTP requests that can be made per day.
    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.
    FaultTolerant 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 string
    A string representing an HTTP header name.
    HideClientHeaders bool
    Optionally hide informative response headers.
    Hour float64
    The number of HTTP requests that can be made per hour.
    LimitBy string
    The entity that is used when aggregating the limits.
    Minute float64
    The number of HTTP requests that can be made per minute.
    Month float64
    The number of HTTP requests that can be made per month.
    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).
    Policy string
    The rate-limiting policies to use for retrieving and incrementing the limits.
    Redis GetGatewayPluginRateLimitingConfigRedis
    Redis configuration
    Second float64
    The number of HTTP requests that can be made per second.
    SyncRate float64
    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    Year float64
    The number of HTTP requests that can be made per year.
    day Double
    The number of HTTP requests that can be made per day.
    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.
    faultTolerant 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 String
    A string representing an HTTP header name.
    hideClientHeaders Boolean
    Optionally hide informative response headers.
    hour Double
    The number of HTTP requests that can be made per hour.
    limitBy String
    The entity that is used when aggregating the limits.
    minute Double
    The number of HTTP requests that can be made per minute.
    month Double
    The number of HTTP requests that can be made per month.
    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).
    policy String
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis GetGatewayPluginRateLimitingConfigRedis
    Redis configuration
    second Double
    The number of HTTP requests that can be made per second.
    syncRate Double
    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    year Double
    The number of HTTP requests that can be made per year.
    day number
    The number of HTTP requests that can be made per day.
    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.
    faultTolerant 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 string
    A string representing an HTTP header name.
    hideClientHeaders boolean
    Optionally hide informative response headers.
    hour number
    The number of HTTP requests that can be made per hour.
    limitBy string
    The entity that is used when aggregating the limits.
    minute number
    The number of HTTP requests that can be made per minute.
    month number
    The number of HTTP requests that can be made per month.
    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).
    policy string
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis GetGatewayPluginRateLimitingConfigRedis
    Redis configuration
    second number
    The number of HTTP requests that can be made per second.
    syncRate number
    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    year number
    The number of HTTP requests that can be made per year.
    day float
    The number of HTTP requests that can be made per day.
    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.
    fault_tolerant 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 str
    A string representing an HTTP header name.
    hide_client_headers bool
    Optionally hide informative response headers.
    hour float
    The number of HTTP requests that can be made per hour.
    limit_by str
    The entity that is used when aggregating the limits.
    minute float
    The number of HTTP requests that can be made per minute.
    month float
    The number of HTTP requests that can be made per month.
    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).
    policy str
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis GetGatewayPluginRateLimitingConfigRedis
    Redis configuration
    second float
    The number of HTTP requests that can be made per second.
    sync_rate float
    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    year float
    The number of HTTP requests that can be made per year.
    day Number
    The number of HTTP requests that can be made per day.
    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.
    faultTolerant 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 String
    A string representing an HTTP header name.
    hideClientHeaders Boolean
    Optionally hide informative response headers.
    hour Number
    The number of HTTP requests that can be made per hour.
    limitBy String
    The entity that is used when aggregating the limits.
    minute Number
    The number of HTTP requests that can be made per minute.
    month Number
    The number of HTTP requests that can be made per month.
    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).
    policy String
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis Property Map
    Redis configuration
    second Number
    The number of HTTP requests that can be made per second.
    syncRate Number
    How often to sync counter data to the central data store. A value of -1 results in synchronous behavior.
    year Number
    The number of HTTP requests that can be made per year.

    GetGatewayPluginRateLimitingConfigRedis

    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.
    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.
    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.
    Timeout double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    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.
    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.
    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.
    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.
    Timeout float64
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    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.
    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.
    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.
    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.
    timeout Double
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    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.
    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.
    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.
    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.
    timeout number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    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.
    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.
    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.
    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.
    timeout float
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    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.
    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.
    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.
    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.
    timeout Number
    An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
    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.

    GetGatewayPluginRateLimitingConsumer

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginRateLimitingConsumerGroup

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginRateLimitingOrdering

    GetGatewayPluginRateLimitingOrderingAfter

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginRateLimitingOrderingBefore

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginRateLimitingRoute

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginRateLimitingService

    Id string
    Id string
    id String
    id string
    id str
    id String

    Package Details

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