konnect.GatewayPluginRateLimiting

Coming soon!

Coming soon!

Coming soon!

resource_name This property is required. str

The unique name of the resource.

args This property is required. GatewayPluginRateLimitingArgs

The arguments to resource properties.

opts ResourceOptions

Bag of options to control resource's behavior.

ctx Context

Context object for the current deployment.

name This property is required. string

The unique name of the resource.

args This property is required. GatewayPluginRateLimitingArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name This property is required. string

The unique name of the resource.

args This property is required. GatewayPluginRateLimitingArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name This property is required. String

The unique name of the resource.

args This property is required. GatewayPluginRateLimitingArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ControlPlaneId This property is required. string

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

Config GatewayPluginRateLimitingConfig

Consumer GatewayPluginRateLimitingConsumer

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.

ConsumerGroup GatewayPluginRateLimitingConsumerGroup

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

CreatedAt double

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginRateLimitingId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginRateLimitingOrdering

Protocols List<string>

A set of strings representing HTTP protocols.

Route GatewayPluginRateLimitingRoute

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 GatewayPluginRateLimitingService

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

Tags List<string>

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

UpdatedAt double

Unix epoch when the resource was last updated.

ControlPlaneId This property is required. string

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

Config GatewayPluginRateLimitingConfigArgs

Consumer GatewayPluginRateLimitingConsumerArgs

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.

ConsumerGroup GatewayPluginRateLimitingConsumerGroupArgs

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

CreatedAt float64

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied.

GatewayPluginRateLimitingId string

The ID of this resource.

InstanceName string

Ordering GatewayPluginRateLimitingOrderingArgs

Protocols []string

A set of strings representing HTTP protocols.

Route GatewayPluginRateLimitingRouteArgs

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 GatewayPluginRateLimitingServiceArgs

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

Tags []string

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

UpdatedAt float64

Unix epoch when the resource was last updated.

controlPlaneId This property is required. String

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

config GatewayPluginRateLimitingConfig

consumer GatewayPluginRateLimitingConsumer

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.

consumerGroup GatewayPluginRateLimitingConsumerGroup

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

createdAt Double

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginRateLimitingId String

The ID of this resource.

instanceName String

ordering GatewayPluginRateLimitingOrdering

protocols List<String>

A set of strings representing HTTP protocols.

route GatewayPluginRateLimitingRoute

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 GatewayPluginRateLimitingService

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

tags List<String>

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

updatedAt Double

Unix epoch when the resource was last updated.

control_plane_id This property is required. str

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

config GatewayPluginRateLimitingConfigArgs

consumer GatewayPluginRateLimitingConsumerArgs

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.

consumer_group GatewayPluginRateLimitingConsumerGroupArgs

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

created_at float

Unix epoch when the resource was created.

enabled bool

Whether the plugin is applied.

gateway_plugin_rate_limiting_id str

The ID of this resource.

instance_name str

ordering GatewayPluginRateLimitingOrderingArgs

protocols Sequence[str]

A set of strings representing HTTP protocols.

route GatewayPluginRateLimitingRouteArgs

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 GatewayPluginRateLimitingServiceArgs

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

tags Sequence[str]

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

updated_at float

Unix epoch when the resource was last updated.

controlPlaneId This property is required. String

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

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.

consumerGroup Property Map

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

createdAt Number

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied.

gatewayPluginRateLimitingId String

The ID of this resource.

instanceName 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.

tags List<String>

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

updatedAt Number

Unix epoch when the resource was last updated.

Id string

The provider-assigned unique ID for this managed resource.

Id string

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

id str

The provider-assigned unique ID for this managed resource.

id String

The provider-assigned unique ID for this managed resource.

resource_name This property is required.

The unique name of the resulting resource.

id This property is required.

The unique provider ID of the resource to lookup.

name This property is required.

The unique name of the resulting resource.

id This property is required.

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 This property is required.

The unique name of the resulting resource.

id This property is required.

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 This property is required.

The unique name of the resulting resource.

id This property is required.

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.

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. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"]

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. must be one of ["cluster", "local", "redis"]

Redis GatewayPluginRateLimitingConfigRedis

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. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"]

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. must be one of ["cluster", "local", "redis"]

Redis GatewayPluginRateLimitingConfigRedis

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. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"]

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. must be one of ["cluster", "local", "redis"]

redis GatewayPluginRateLimitingConfigRedis

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 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. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"]

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. must be one of ["cluster", "local", "redis"]

redis GatewayPluginRateLimitingConfigRedis

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. must be one of ["consumer", "consumer-group", "credential", "header", "ip", "path", "service"]

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. must be one of ["cluster", "local", "redis"]

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.

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 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.

Id string

Id string

id String

id str

id String

Id string

Id string

id String

id str

id String

After GatewayPluginRateLimitingOrderingAfter

Before GatewayPluginRateLimitingOrderingBefore

After GatewayPluginRateLimitingOrderingAfter

Before GatewayPluginRateLimitingOrderingBefore

after GatewayPluginRateLimitingOrderingAfter

before GatewayPluginRateLimitingOrderingBefore

after GatewayPluginRateLimitingOrderingAfter

before GatewayPluginRateLimitingOrderingBefore

after Property Map

before Property Map

Accesses List<string>

Accesses []string

accesses List<String>

accesses Sequence[str]

accesses List<String>

Accesses List<string>

Accesses []string

accesses List<String>

accesses Sequence[str]

accesses List<String>

Id string

Id string