Docs Home
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
konnect.GatewayPluginResponseRatelimiting
Explore with Pulumi AI
GatewayPluginResponseRatelimiting Resource
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginResponseRatelimiting;
import com.pulumi.konnect.GatewayPluginResponseRatelimitingArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingConfigRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginResponseRatelimitingServiceArgs;
import static com.pulumi.codegen.internal.Serialization.*;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var myGatewaypluginresponseratelimiting = new GatewayPluginResponseRatelimiting("myGatewaypluginresponseratelimiting", GatewayPluginResponseRatelimitingArgs.builder()
.config(GatewayPluginResponseRatelimitingConfigArgs.builder()
.block_on_first_violation(true)
.fault_tolerant(false)
.header_name("...my_header_name...")
.hide_client_headers(true)
.limit_by("ip")
.limits(Map.of("key", serializeJson(
"value")))
.policy("cluster")
.redis(GatewayPluginResponseRatelimitingConfigRedisArgs.builder()
.database(9)
.host("...my_host...")
.password("...my_password...")
.port(32565)
.serverName("...my_server_name...")
.ssl(true)
.sslVerify(false)
.timeout(70842937)
.username("...my_username...")
.build())
.build())
.consumer(GatewayPluginResponseRatelimitingConsumerArgs.builder()
.id("...my_id...")
.build())
.controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
.enabled(true)
.gatewayPluginResponseRatelimitingId("...my_id...")
.instanceName("...my_instance_name...")
.ordering(GatewayPluginResponseRatelimitingOrderingArgs.builder()
.after(GatewayPluginResponseRatelimitingOrderingAfterArgs.builder()
.access("...")
.build())
.before(GatewayPluginResponseRatelimitingOrderingBeforeArgs.builder()
.access("...")
.build())
.build())
.protocols("http")
.route(GatewayPluginResponseRatelimitingRouteArgs.builder()
.id("...my_id...")
.build())
.service(GatewayPluginResponseRatelimitingServiceArgs.builder()
.id("...my_id...")
.build())
.tags("...")
.build());
}
}
resources:
myGatewaypluginresponseratelimiting:
type: konnect:GatewayPluginResponseRatelimiting
properties:
config:
block_on_first_violation: true
fault_tolerant: false
header_name: '...my_header_name...'
hide_client_headers: true
limit_by: ip
limits:
key:
fn::toJSON: value
policy: cluster
redis:
database: 9
host: '...my_host...'
password: '...my_password...'
port: 32565
serverName: '...my_server_name...'
ssl: true
sslVerify: false
timeout: 7.0842937e+07
username: '...my_username...'
consumer:
id: '...my_id...'
controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
enabled: true
gatewayPluginResponseRatelimitingId: '...my_id...'
instanceName: '...my_instance_name...'
ordering:
after:
access:
- '...'
before:
access:
- '...'
protocols:
- http
route:
id: '...my_id...'
service:
id: '...my_id...'
tags:
- '...'
Create GatewayPluginResponseRatelimiting Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayPluginResponseRatelimiting(name: string, args: GatewayPluginResponseRatelimitingArgs, opts?: CustomResourceOptions);@overload
def GatewayPluginResponseRatelimiting(resource_name: str,
args: GatewayPluginResponseRatelimitingArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayPluginResponseRatelimiting(resource_name: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginResponseRatelimitingConfigArgs] = None,
control_plane_id: Optional[str] = None,
consumer: Optional[GatewayPluginResponseRatelimitingConsumerArgs] = None,
enabled: Optional[bool] = None,
gateway_plugin_response_ratelimiting_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginResponseRatelimitingOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginResponseRatelimitingRouteArgs] = None,
service: Optional[GatewayPluginResponseRatelimitingServiceArgs] = None,
tags: Optional[Sequence[str]] = None)func NewGatewayPluginResponseRatelimiting(ctx *Context, name string, args GatewayPluginResponseRatelimitingArgs, opts ...ResourceOption) (*GatewayPluginResponseRatelimiting, error)public GatewayPluginResponseRatelimiting(string name, GatewayPluginResponseRatelimitingArgs args, CustomResourceOptions? opts = null)
public GatewayPluginResponseRatelimiting(String name, GatewayPluginResponseRatelimitingArgs args)
public GatewayPluginResponseRatelimiting(String name, GatewayPluginResponseRatelimitingArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginResponseRatelimiting
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GatewayPluginResponseRatelimitingArgs
- 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 GatewayPluginResponseRatelimitingArgs
- 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 GatewayPluginResponseRatelimitingArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayPluginResponseRatelimitingArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayPluginResponseRatelimitingArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayPluginResponseRatelimitingResource = new Konnect.GatewayPluginResponseRatelimiting("gatewayPluginResponseRatelimitingResource", new()
{
Config = new Konnect.Inputs.GatewayPluginResponseRatelimitingConfigArgs
{
BlockOnFirstViolation = false,
FaultTolerant = false,
HeaderName = "string",
HideClientHeaders = false,
LimitBy = "string",
Limits =
{
{ "string", "string" },
},
Policy = "string",
Redis = new Konnect.Inputs.GatewayPluginResponseRatelimitingConfigRedisArgs
{
Database = 0,
Host = "string",
Password = "string",
Port = 0,
ServerName = "string",
Ssl = false,
SslVerify = false,
Timeout = 0,
Username = "string",
},
},
ControlPlaneId = "string",
Consumer = new Konnect.Inputs.GatewayPluginResponseRatelimitingConsumerArgs
{
Id = "string",
},
Enabled = false,
GatewayPluginResponseRatelimitingId = "string",
InstanceName = "string",
Ordering = new Konnect.Inputs.GatewayPluginResponseRatelimitingOrderingArgs
{
After = new Konnect.Inputs.GatewayPluginResponseRatelimitingOrderingAfterArgs
{
Accesses = new[]
{
"string",
},
},
Before = new Konnect.Inputs.GatewayPluginResponseRatelimitingOrderingBeforeArgs
{
Accesses = new[]
{
"string",
},
},
},
Protocols = new[]
{
"string",
},
Route = new Konnect.Inputs.GatewayPluginResponseRatelimitingRouteArgs
{
Id = "string",
},
Service = new Konnect.Inputs.GatewayPluginResponseRatelimitingServiceArgs
{
Id = "string",
},
Tags = new[]
{
"string",
},
});
example, err := konnect.NewGatewayPluginResponseRatelimiting(ctx, "gatewayPluginResponseRatelimitingResource", &konnect.GatewayPluginResponseRatelimitingArgs{
Config: &.GatewayPluginResponseRatelimitingConfigArgs{
BlockOnFirstViolation: pulumi.Bool(false),
FaultTolerant: pulumi.Bool(false),
HeaderName: pulumi.String("string"),
HideClientHeaders: pulumi.Bool(false),
LimitBy: pulumi.String("string"),
Limits: pulumi.StringMap{
"string": pulumi.String("string"),
},
Policy: pulumi.String("string"),
Redis: &.GatewayPluginResponseRatelimitingConfigRedisArgs{
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
Username: pulumi.String("string"),
},
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginResponseRatelimitingConsumerArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginResponseRatelimitingId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginResponseRatelimitingOrderingArgs{
After: &.GatewayPluginResponseRatelimitingOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginResponseRatelimitingOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginResponseRatelimitingRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginResponseRatelimitingServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
var gatewayPluginResponseRatelimitingResource = new GatewayPluginResponseRatelimiting("gatewayPluginResponseRatelimitingResource", GatewayPluginResponseRatelimitingArgs.builder()
.config(GatewayPluginResponseRatelimitingConfigArgs.builder()
.blockOnFirstViolation(false)
.faultTolerant(false)
.headerName("string")
.hideClientHeaders(false)
.limitBy("string")
.limits(Map.of("string", "string"))
.policy("string")
.redis(GatewayPluginResponseRatelimitingConfigRedisArgs.builder()
.database(0)
.host("string")
.password("string")
.port(0)
.serverName("string")
.ssl(false)
.sslVerify(false)
.timeout(0)
.username("string")
.build())
.build())
.controlPlaneId("string")
.consumer(GatewayPluginResponseRatelimitingConsumerArgs.builder()
.id("string")
.build())
.enabled(false)
.gatewayPluginResponseRatelimitingId("string")
.instanceName("string")
.ordering(GatewayPluginResponseRatelimitingOrderingArgs.builder()
.after(GatewayPluginResponseRatelimitingOrderingAfterArgs.builder()
.accesses("string")
.build())
.before(GatewayPluginResponseRatelimitingOrderingBeforeArgs.builder()
.accesses("string")
.build())
.build())
.protocols("string")
.route(GatewayPluginResponseRatelimitingRouteArgs.builder()
.id("string")
.build())
.service(GatewayPluginResponseRatelimitingServiceArgs.builder()
.id("string")
.build())
.tags("string")
.build());
gateway_plugin_response_ratelimiting_resource = konnect.GatewayPluginResponseRatelimiting("gatewayPluginResponseRatelimitingResource",
config={
"block_on_first_violation": False,
"fault_tolerant": False,
"header_name": "string",
"hide_client_headers": False,
"limit_by": "string",
"limits": {
"string": "string",
},
"policy": "string",
"redis": {
"database": 0,
"host": "string",
"password": "string",
"port": 0,
"server_name": "string",
"ssl": False,
"ssl_verify": False,
"timeout": 0,
"username": "string",
},
},
control_plane_id="string",
consumer={
"id": "string",
},
enabled=False,
gateway_plugin_response_ratelimiting_id="string",
instance_name="string",
ordering={
"after": {
"accesses": ["string"],
},
"before": {
"accesses": ["string"],
},
},
protocols=["string"],
route={
"id": "string",
},
service={
"id": "string",
},
tags=["string"])
const gatewayPluginResponseRatelimitingResource = new konnect.GatewayPluginResponseRatelimiting("gatewayPluginResponseRatelimitingResource", {
config: {
blockOnFirstViolation: false,
faultTolerant: false,
headerName: "string",
hideClientHeaders: false,
limitBy: "string",
limits: {
string: "string",
},
policy: "string",
redis: {
database: 0,
host: "string",
password: "string",
port: 0,
serverName: "string",
ssl: false,
sslVerify: false,
timeout: 0,
username: "string",
},
},
controlPlaneId: "string",
consumer: {
id: "string",
},
enabled: false,
gatewayPluginResponseRatelimitingId: "string",
instanceName: "string",
ordering: {
after: {
accesses: ["string"],
},
before: {
accesses: ["string"],
},
},
protocols: ["string"],
route: {
id: "string",
},
service: {
id: "string",
},
tags: ["string"],
});
type: konnect:GatewayPluginResponseRatelimiting
properties:
config:
blockOnFirstViolation: false
faultTolerant: false
headerName: string
hideClientHeaders: false
limitBy: string
limits:
string: string
policy: string
redis:
database: 0
host: string
password: string
port: 0
serverName: string
ssl: false
sslVerify: false
timeout: 0
username: string
consumer:
id: string
controlPlaneId: string
enabled: false
gatewayPluginResponseRatelimitingId: string
instanceName: string
ordering:
after:
accesses:
- string
before:
accesses:
- string
protocols:
- string
route:
id: string
service:
id: string
tags:
- string
GatewayPluginResponseRatelimiting Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayPluginResponseRatelimiting resource accepts the following input properties:
- Config
Gateway
Plugin Response Ratelimiting Config - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Consumer
Gateway
Plugin Response Ratelimiting Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringResponse Ratelimiting Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Response Ratelimiting Ordering - Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Response Ratelimiting Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Response Ratelimiting Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Config
Gateway
Plugin Response Ratelimiting Config Args - Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Consumer
Gateway
Plugin Response Ratelimiting Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringResponse Ratelimiting Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Response Ratelimiting Ordering Args - Protocols []string
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Response Ratelimiting Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Response Ratelimiting Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
Gateway
Plugin Response Ratelimiting Config - control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Response Ratelimiting Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringResponse Ratelimiting Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Response Ratelimiting Ordering - protocols List<String>
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Response Ratelimiting Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Response Ratelimiting Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
Gateway
Plugin Response Ratelimiting Config - control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Response Ratelimiting Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringResponse Ratelimiting Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Response Ratelimiting Ordering - protocols string[]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Response Ratelimiting Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Response Ratelimiting Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- config
Gateway
Plugin Response Ratelimiting Config Args - control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer
Gateway
Plugin Response Ratelimiting Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strresponse_ ratelimiting_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Response Ratelimiting Ordering Args - protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Response Ratelimiting Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Response Ratelimiting Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- config Property Map
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- consumer Property Map
- If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringResponse Ratelimiting Id - The ID of this resource.
- instance
Name String - ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service Property Map
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayPluginResponseRatelimiting resource produces the following output properties:
- created_
at float - Unix epoch when the resource was created.
- id str
- The provider-assigned unique ID for this managed resource.
- updated_
at float - Unix epoch when the resource was last updated.
Look up Existing GatewayPluginResponseRatelimiting Resource
Get an existing GatewayPluginResponseRatelimiting resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayPluginResponseRatelimitingState, opts?: CustomResourceOptions): GatewayPluginResponseRatelimiting@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
config: Optional[GatewayPluginResponseRatelimitingConfigArgs] = None,
consumer: Optional[GatewayPluginResponseRatelimitingConsumerArgs] = None,
control_plane_id: Optional[str] = None,
created_at: Optional[float] = None,
enabled: Optional[bool] = None,
gateway_plugin_response_ratelimiting_id: Optional[str] = None,
instance_name: Optional[str] = None,
ordering: Optional[GatewayPluginResponseRatelimitingOrderingArgs] = None,
protocols: Optional[Sequence[str]] = None,
route: Optional[GatewayPluginResponseRatelimitingRouteArgs] = None,
service: Optional[GatewayPluginResponseRatelimitingServiceArgs] = None,
tags: Optional[Sequence[str]] = None,
updated_at: Optional[float] = None) -> GatewayPluginResponseRatelimitingfunc GetGatewayPluginResponseRatelimiting(ctx *Context, name string, id IDInput, state *GatewayPluginResponseRatelimitingState, opts ...ResourceOption) (*GatewayPluginResponseRatelimiting, error)public static GatewayPluginResponseRatelimiting Get(string name, Input<string> id, GatewayPluginResponseRatelimitingState? state, CustomResourceOptions? opts = null)public static GatewayPluginResponseRatelimiting get(String name, Output<String> id, GatewayPluginResponseRatelimitingState state, CustomResourceOptions options)resources: _: type: konnect:GatewayPluginResponseRatelimiting get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Config
Gateway
Plugin Response Ratelimiting Config - Consumer
Gateway
Plugin Response Ratelimiting Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At double - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringResponse Ratelimiting Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Response Ratelimiting Ordering - Protocols List<string>
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Response Ratelimiting Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Response Ratelimiting Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<string>
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At double - Unix epoch when the resource was last updated.
- Config
Gateway
Plugin Response Ratelimiting Config Args - Consumer
Gateway
Plugin Response Ratelimiting Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- Control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- Created
At float64 - Unix epoch when the resource was created.
- Enabled bool
- Whether the plugin is applied.
- Gateway
Plugin stringResponse Ratelimiting Id - The ID of this resource.
- Instance
Name string - Ordering
Gateway
Plugin Response Ratelimiting Ordering Args - Protocols []string
- A set of strings representing HTTP protocols.
- Route
Gateway
Plugin Response Ratelimiting Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- Service
Gateway
Plugin Response Ratelimiting Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- []string
- An optional set of strings associated with the Plugin for grouping and filtering.
- Updated
At float64 - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Response Ratelimiting Config - consumer
Gateway
Plugin Response Ratelimiting Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Double - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringResponse Ratelimiting Id - The ID of this resource.
- instance
Name String - ordering
Gateway
Plugin Response Ratelimiting Ordering - protocols List<String>
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Response Ratelimiting Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Response Ratelimiting Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Double - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Response Ratelimiting Config - consumer
Gateway
Plugin Response Ratelimiting Consumer - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control
Plane stringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At number - Unix epoch when the resource was created.
- enabled boolean
- Whether the plugin is applied.
- gateway
Plugin stringResponse Ratelimiting Id - The ID of this resource.
- instance
Name string - ordering
Gateway
Plugin Response Ratelimiting Ordering - protocols string[]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Response Ratelimiting Route - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Response Ratelimiting Service - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- string[]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At number - Unix epoch when the resource was last updated.
- config
Gateway
Plugin Response Ratelimiting Config Args - consumer
Gateway
Plugin Response Ratelimiting Consumer Args - If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control_
plane_ strid - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created_
at float - Unix epoch when the resource was created.
- enabled bool
- Whether the plugin is applied.
- gateway_
plugin_ strresponse_ ratelimiting_ id - The ID of this resource.
- instance_
name str - ordering
Gateway
Plugin Response Ratelimiting Ordering Args - protocols Sequence[str]
- A set of strings representing HTTP protocols.
- route
Gateway
Plugin Response Ratelimiting Route Args - If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service
Gateway
Plugin Response Ratelimiting Service Args - If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- Sequence[str]
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated_
at float - Unix epoch when the resource was last updated.
- config Property Map
- consumer Property Map
- If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
- control
Plane StringId - The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
- created
At Number - Unix epoch when the resource was created.
- enabled Boolean
- Whether the plugin is applied.
- gateway
Plugin StringResponse Ratelimiting Id - The ID of this resource.
- instance
Name String - ordering Property Map
- protocols List<String>
- A set of strings representing HTTP protocols.
- route Property Map
- If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
- service Property Map
- If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
- List<String>
- An optional set of strings associated with the Plugin for grouping and filtering.
- updated
At Number - Unix epoch when the resource was last updated.
Supporting Types
GatewayPluginResponseRatelimitingConfig, GatewayPluginResponseRatelimitingConfigArgs
- Block
On boolFirst Violation - 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. Iffalse, then the clients will see500errors. - Header
Name string - The name of the response header used to increment the counters.
- Hide
Client boolHeaders - Optionally hide informative response headers.
- Limit
By string - The entity that will be used when aggregating the limits:
consumer,credential,ip. If theconsumeror thecredentialcannot be determined, the system will always fallback toip. must be one of ["consumer", "credential", "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. must be one of ["cluster", "local", "redis"]
- Redis
Gateway
Plugin Response Ratelimiting Config Redis - Redis configuration
- Block
On boolFirst Violation - 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. Iffalse, then the clients will see500errors. - Header
Name string - The name of the response header used to increment the counters.
- Hide
Client boolHeaders - Optionally hide informative response headers.
- Limit
By string - The entity that will be used when aggregating the limits:
consumer,credential,ip. If theconsumeror thecredentialcannot be determined, the system will always fallback toip. must be one of ["consumer", "credential", "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. must be one of ["cluster", "local", "redis"]
- Redis
Gateway
Plugin Response Ratelimiting Config Redis - Redis configuration
- block
On BooleanFirst Violation - 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 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. Iffalse, then the clients will see500errors. - header
Name String - The name of the response header used to increment the counters.
- hide
Client BooleanHeaders - Optionally hide informative response headers.
- limit
By String - The entity that will be used when aggregating the limits:
consumer,credential,ip. If theconsumeror thecredentialcannot be determined, the system will always fallback toip. must be one of ["consumer", "credential", "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. must be one of ["cluster", "local", "redis"]
- redis
Gateway
Plugin Response Ratelimiting Config Redis - Redis configuration
- block
On booleanFirst Violation - 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 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. Iffalse, then the clients will see500errors. - header
Name string - The name of the response header used to increment the counters.
- hide
Client booleanHeaders - Optionally hide informative response headers.
- limit
By string - The entity that will be used when aggregating the limits:
consumer,credential,ip. If theconsumeror thecredentialcannot be determined, the system will always fallback toip. must be one of ["consumer", "credential", "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. must be one of ["cluster", "local", "redis"]
- redis
Gateway
Plugin Response Ratelimiting Config Redis - Redis configuration
- block_
on_ boolfirst_ violation - 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. Iffalse, then the clients will see500errors. - header_
name str - The name of the response header used to increment the counters.
- hide_
client_ boolheaders - Optionally hide informative response headers.
- limit_
by str - The entity that will be used when aggregating the limits:
consumer,credential,ip. If theconsumeror thecredentialcannot be determined, the system will always fallback toip. must be one of ["consumer", "credential", "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. must be one of ["cluster", "local", "redis"]
- redis
Gateway
Plugin Response Ratelimiting Config Redis - Redis configuration
- block
On BooleanFirst Violation - 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 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. Iffalse, then the clients will see500errors. - header
Name String - The name of the response header used to increment the counters.
- hide
Client BooleanHeaders - Optionally hide informative response headers.
- limit
By String - The entity that will be used when aggregating the limits:
consumer,credential,ip. If theconsumeror thecredentialcannot be determined, the system will always fallback toip. must be one of ["consumer", "credential", "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. must be one of ["cluster", "local", "redis"]
- redis Property Map
- Redis configuration
GatewayPluginResponseRatelimitingConfigRedis, GatewayPluginResponseRatelimitingConfigRedisArgs
- Database double
- Database to use for the Redis connection when using the
redisstrategy - Host string
- A string representing a host name, such as example.com.
- 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.
- Server
Name string - A string representing an SNI (server name indication) value for TLS.
- Ssl bool
- If set to true, uses SSL to connect to Redis.
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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
redisstrategy - 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.
- Server
Name string - A string representing an SNI (server name indication) value for TLS.
- Ssl bool
- If set to true, uses SSL to connect to Redis.
- Ssl
Verify bool - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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
redisstrategy - 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.
- server
Name String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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
redisstrategy - 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.
- server
Name string - A string representing an SNI (server name indication) value for TLS.
- ssl boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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
redisstrategy - 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_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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
redisstrategy - 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.
- server
Name String - A string representing an SNI (server name indication) value for TLS.
- ssl Boolean
- If set to true, uses SSL to connect to Redis.
- ssl
Verify Boolean - If set to true, verifies the validity of the server SSL certificate. If setting this parameter, also configure
lua_ssl_trusted_certificateinkong.confto specify the CA (or server) certificate used by your Redis server. You may also need to configurelua_ssl_verify_depthaccordingly. - 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.
GatewayPluginResponseRatelimitingConsumer, GatewayPluginResponseRatelimitingConsumerArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginResponseRatelimitingOrdering, GatewayPluginResponseRatelimitingOrderingArgs
GatewayPluginResponseRatelimitingOrderingAfter, GatewayPluginResponseRatelimitingOrderingAfterArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginResponseRatelimitingOrderingBefore, GatewayPluginResponseRatelimitingOrderingBeforeArgs
- Accesses List<string>
- Accesses []string
- accesses List<String>
- accesses string[]
- accesses Sequence[str]
- accesses List<String>
GatewayPluginResponseRatelimitingRoute, GatewayPluginResponseRatelimitingRouteArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
GatewayPluginResponseRatelimitingService, GatewayPluginResponseRatelimitingServiceArgs
- Id string
- Id string
- id String
- id string
- id str
- id String
Import
$ pulumi import konnect:index/gatewayPluginResponseRatelimiting:GatewayPluginResponseRatelimiting my_konnect_gateway_plugin_response_ratelimiting "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- konnect kong/terraform-provider-konnect
- License
- Notes
- This Pulumi package is based on the
konnectTerraform Provider.