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

konnect.getGatewayPluginResponseRatelimiting

Explore with Pulumi AI

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

    Using getGatewayPluginResponseRatelimiting

    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 getGatewayPluginResponseRatelimiting(args: GetGatewayPluginResponseRatelimitingArgs, opts?: InvokeOptions): Promise<GetGatewayPluginResponseRatelimitingResult>
function getGatewayPluginResponseRatelimitingOutput(args: GetGatewayPluginResponseRatelimitingOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginResponseRatelimitingResult>
    def get_gateway_plugin_response_ratelimiting(control_plane_id: Optional[str] = None,
                                             opts: Optional[InvokeOptions] = None) -> GetGatewayPluginResponseRatelimitingResult
def get_gateway_plugin_response_ratelimiting_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                             opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginResponseRatelimitingResult]
    func LookupGatewayPluginResponseRatelimiting(ctx *Context, args *LookupGatewayPluginResponseRatelimitingArgs, opts ...InvokeOption) (*LookupGatewayPluginResponseRatelimitingResult, error)
func LookupGatewayPluginResponseRatelimitingOutput(ctx *Context, args *LookupGatewayPluginResponseRatelimitingOutputArgs, opts ...InvokeOption) LookupGatewayPluginResponseRatelimitingResultOutput

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

    public static class GetGatewayPluginResponseRatelimiting 
{
    public static Task<GetGatewayPluginResponseRatelimitingResult> InvokeAsync(GetGatewayPluginResponseRatelimitingArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginResponseRatelimitingResult> Invoke(GetGatewayPluginResponseRatelimitingInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayPluginResponseRatelimitingResult> getGatewayPluginResponseRatelimiting(GetGatewayPluginResponseRatelimitingArgs args, InvokeOptions options)
public static Output<GetGatewayPluginResponseRatelimitingResult> getGatewayPluginResponseRatelimiting(GetGatewayPluginResponseRatelimitingArgs args, InvokeOptions options)

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

    The following arguments are supported:

    getGatewayPluginResponseRatelimiting Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginResponseRatelimitingConfig

    BlockOnFirstViolation bool
    A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
    FaultTolerant bool
    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If false, then the clients will see 500 errors.
    HeaderName string
    The name of the response header used to increment the counters.
    HideClientHeaders bool
    Optionally hide informative response headers.
    LimitBy string
    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.
    Limits Dictionary<string, string>
    A map that defines rate limits for the plugin.
    Policy string
    The rate-limiting policies to use for retrieving and incrementing the limits.
    Redis GetGatewayPluginResponseRatelimitingConfigRedis
    Redis configuration
    BlockOnFirstViolation bool
    A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
    FaultTolerant bool
    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If false, then the clients will see 500 errors.
    HeaderName string
    The name of the response header used to increment the counters.
    HideClientHeaders bool
    Optionally hide informative response headers.
    LimitBy string
    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.
    Limits map[string]string
    A map that defines rate limits for the plugin.
    Policy string
    The rate-limiting policies to use for retrieving and incrementing the limits.
    Redis GetGatewayPluginResponseRatelimitingConfigRedis
    Redis configuration
    blockOnFirstViolation Boolean
    A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
    faultTolerant Boolean
    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If false, then the clients will see 500 errors.
    headerName String
    The name of the response header used to increment the counters.
    hideClientHeaders Boolean
    Optionally hide informative response headers.
    limitBy String
    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.
    limits Map<String,String>
    A map that defines rate limits for the plugin.
    policy String
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis GetGatewayPluginResponseRatelimitingConfigRedis
    Redis configuration
    blockOnFirstViolation boolean
    A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
    faultTolerant boolean
    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If false, then the clients will see 500 errors.
    headerName string
    The name of the response header used to increment the counters.
    hideClientHeaders boolean
    Optionally hide informative response headers.
    limitBy string
    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.
    limits {[key: string]: string}
    A map that defines rate limits for the plugin.
    policy string
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis GetGatewayPluginResponseRatelimitingConfigRedis
    Redis configuration
    block_on_first_violation bool
    A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
    fault_tolerant bool
    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If false, then the clients will see 500 errors.
    header_name str
    The name of the response header used to increment the counters.
    hide_client_headers bool
    Optionally hide informative response headers.
    limit_by str
    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.
    limits Mapping[str, str]
    A map that defines rate limits for the plugin.
    policy str
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis GetGatewayPluginResponseRatelimitingConfigRedis
    Redis configuration
    blockOnFirstViolation Boolean
    A boolean value that determines if the requests should be blocked as soon as one limit is being exceeded. This will block requests that are supposed to consume other limits too.
    faultTolerant Boolean
    A boolean value that determines if the requests should be proxied even if Kong has troubles connecting a third-party datastore. If true, requests will be proxied anyway, effectively disabling the rate-limiting function until the datastore is working again. If false, then the clients will see 500 errors.
    headerName String
    The name of the response header used to increment the counters.
    hideClientHeaders Boolean
    Optionally hide informative response headers.
    limitBy String
    The entity that will be used when aggregating the limits: consumer, credential, ip. If the consumer or the credential cannot be determined, the system will always fallback to ip.
    limits Map<String>
    A map that defines rate limits for the plugin.
    policy String
    The rate-limiting policies to use for retrieving and incrementing the limits.
    redis Property Map
    Redis configuration

    GetGatewayPluginResponseRatelimitingConfigRedis

    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.

    GetGatewayPluginResponseRatelimitingConsumer

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

    GetGatewayPluginResponseRatelimitingOrdering

    GetGatewayPluginResponseRatelimitingOrderingAfter

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

    GetGatewayPluginResponseRatelimitingOrderingBefore

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

    GetGatewayPluginResponseRatelimitingRoute

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

    GetGatewayPluginResponseRatelimitingService

    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