konnect.GatewayPluginAce

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

name string

The unique name of the resource.

args GatewayPluginAceArgs

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 GatewayPluginAceArgs

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 GatewayPluginAceArgs

The arguments to resource properties.

opts ResourceOption

Bag of options to control resource's behavior.

name string

The unique name of the resource.

args GatewayPluginAceArgs

The arguments to resource properties.

opts CustomResourceOptions

Bag of options to control resource's behavior.

name String

The unique name of the resource.

args GatewayPluginAceArgs

The arguments to resource properties.

options CustomResourceOptions

Bag of options to control resource's behavior.

ControlPlaneId string

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

Config GatewayPluginAceConfig

CreatedAt double

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied. Default: true

GatewayPluginAceId string

A string representing a UUID (universally unique identifier).

InstanceName string

A unique string representing a UTF-8 encoded name.

Ordering GatewayPluginAceOrdering

Partials List<GatewayPluginAcePartial>

A list of partials to be used by the plugin.

Protocols List<string>

A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]

Route GatewayPluginAceRoute

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 GatewayPluginAceService

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 string

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

Config GatewayPluginAceConfigArgs

CreatedAt float64

Unix epoch when the resource was created.

Enabled bool

Whether the plugin is applied. Default: true

GatewayPluginAceId string

A string representing a UUID (universally unique identifier).

InstanceName string

A unique string representing a UTF-8 encoded name.

Ordering GatewayPluginAceOrderingArgs

Partials []GatewayPluginAcePartialArgs

A list of partials to be used by the plugin.

Protocols []string

A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]

Route GatewayPluginAceRouteArgs

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 GatewayPluginAceServiceArgs

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 String

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

config GatewayPluginAceConfig

createdAt Double

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied. Default: true

gatewayPluginAceId String

A string representing a UUID (universally unique identifier).

instanceName String

A unique string representing a UTF-8 encoded name.

ordering GatewayPluginAceOrdering

partials List<GatewayPluginAcePartial>

A list of partials to be used by the plugin.

protocols List<String>

A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]

route GatewayPluginAceRoute

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 GatewayPluginAceService

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 string

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

config GatewayPluginAceConfig

createdAt number

Unix epoch when the resource was created.

enabled boolean

Whether the plugin is applied. Default: true

gatewayPluginAceId string

A string representing a UUID (universally unique identifier).

instanceName string

A unique string representing a UTF-8 encoded name.

ordering GatewayPluginAceOrdering

partials GatewayPluginAcePartial[]

A list of partials to be used by the plugin.

protocols string[]

A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]

route GatewayPluginAceRoute

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 GatewayPluginAceService

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 number

Unix epoch when the resource was last updated.

control_plane_id str

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

config GatewayPluginAceConfigArgs

created_at float

Unix epoch when the resource was created.

enabled bool

Whether the plugin is applied. Default: true

gateway_plugin_ace_id str

A string representing a UUID (universally unique identifier).

instance_name str

A unique string representing a UTF-8 encoded name.

ordering GatewayPluginAceOrderingArgs

partials Sequence[GatewayPluginAcePartialArgs]

A list of partials to be used by the plugin.

protocols Sequence[str]

A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]

route GatewayPluginAceRouteArgs

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 GatewayPluginAceServiceArgs

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 String

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

config Property Map

createdAt Number

Unix epoch when the resource was created.

enabled Boolean

Whether the plugin is applied. Default: true

gatewayPluginAceId String

A string representing a UUID (universally unique identifier).

instanceName String

A unique string representing a UTF-8 encoded name.

ordering Property Map

partials List<Property Map>

A list of partials to be used by the plugin.

protocols List<String>

A set of strings representing HTTP protocols. Default: ["grpc","grpcs","http","https"]

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

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.

Anonymous string

MatchPolicy string

Default: "ifpresent"; must be one of ["ifpresent", "required"]

RateLimiting GatewayPluginAceConfigRateLimiting

Anonymous string

MatchPolicy string

Default: "ifpresent"; must be one of ["ifpresent", "required"]

RateLimiting GatewayPluginAceConfigRateLimiting

anonymous String

matchPolicy String

Default: "ifpresent"; must be one of ["ifpresent", "required"]

rateLimiting GatewayPluginAceConfigRateLimiting

anonymous string

matchPolicy string

Default: "ifpresent"; must be one of ["ifpresent", "required"]

rateLimiting GatewayPluginAceConfigRateLimiting

anonymous str

match_policy str

Default: "ifpresent"; must be one of ["ifpresent", "required"]

rate_limiting GatewayPluginAceConfigRateLimiting

anonymous String

matchPolicy String

Default: "ifpresent"; must be one of ["ifpresent", "required"]

rateLimiting Property Map

Redis GatewayPluginAceConfigRateLimitingRedis

SyncRate double

Redis GatewayPluginAceConfigRateLimitingRedis

SyncRate float64

redis GatewayPluginAceConfigRateLimitingRedis

syncRate Double

redis GatewayPluginAceConfigRateLimitingRedis

syncRate number

redis GatewayPluginAceConfigRateLimitingRedis

sync_rate float

redis Property Map

syncRate Number

ClusterMaxRedirections double

Maximum retry attempts for redirection. Default: 5

ClusterNodes List<GatewayPluginAceConfigRateLimitingRedisClusterNode>

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

ConnectTimeout double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

ConnectionIsProxied bool

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address. Default: false

Database double

Database to use for the Redis connection when using the redis strategy. Default: 0

Host string

A string representing a host name, such as example.com. Default: "127.0.0.1"

KeepaliveBacklog double

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

KeepalivePoolSize double

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. Default: 256

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. Default: 6379

ReadTimeout double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

SendTimeout double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

SentinelMaster string

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

SentinelNodes List<GatewayPluginAceConfigRateLimitingRedisSentinelNode>

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

SentinelPassword string

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

SentinelRole string

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

SentinelUsername string

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

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. Default: false

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. Default: false

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.

ClusterMaxRedirections float64

Maximum retry attempts for redirection. Default: 5

ClusterNodes []GatewayPluginAceConfigRateLimitingRedisClusterNode

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

ConnectTimeout float64

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

ConnectionIsProxied bool

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address. Default: false

Database float64

Database to use for the Redis connection when using the redis strategy. Default: 0

Host string

A string representing a host name, such as example.com. Default: "127.0.0.1"

KeepaliveBacklog float64

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

KeepalivePoolSize float64

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. Default: 256

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. Default: 6379

ReadTimeout float64

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

SendTimeout float64

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

SentinelMaster string

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

SentinelNodes []GatewayPluginAceConfigRateLimitingRedisSentinelNode

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

SentinelPassword string

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

SentinelRole string

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

SentinelUsername string

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

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. Default: false

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. Default: false

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.

clusterMaxRedirections Double

Maximum retry attempts for redirection. Default: 5

clusterNodes List<GatewayPluginAceConfigRateLimitingRedisClusterNode>

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connectTimeout Double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

connectionIsProxied Boolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address. Default: false

database Double

Database to use for the Redis connection when using the redis strategy. Default: 0

host String

A string representing a host name, such as example.com. Default: "127.0.0.1"

keepaliveBacklog Double

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalivePoolSize Double

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. Default: 256

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. Default: 6379

readTimeout Double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sendTimeout Double

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sentinelMaster String

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinelNodes List<GatewayPluginAceConfigRateLimitingRedisSentinelNode>

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinelPassword String

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinelRole String

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinelUsername String

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

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. Default: false

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. Default: false

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.

clusterMaxRedirections number

Maximum retry attempts for redirection. Default: 5

clusterNodes GatewayPluginAceConfigRateLimitingRedisClusterNode[]

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connectTimeout number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

connectionIsProxied boolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address. Default: false

database number

Database to use for the Redis connection when using the redis strategy. Default: 0

host string

A string representing a host name, such as example.com. Default: "127.0.0.1"

keepaliveBacklog number

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalivePoolSize number

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. Default: 256

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. Default: 6379

readTimeout number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sendTimeout number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sentinelMaster string

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinelNodes GatewayPluginAceConfigRateLimitingRedisSentinelNode[]

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinelPassword string

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinelRole string

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinelUsername string

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

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. Default: false

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. Default: false

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.

cluster_max_redirections float

Maximum retry attempts for redirection. Default: 5

cluster_nodes Sequence[GatewayPluginAceConfigRateLimitingRedisClusterNode]

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connect_timeout float

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

connection_is_proxied bool

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address. Default: false

database float

Database to use for the Redis connection when using the redis strategy. Default: 0

host str

A string representing a host name, such as example.com. Default: "127.0.0.1"

keepalive_backlog float

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalive_pool_size float

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. Default: 256

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. Default: 6379

read_timeout float

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

send_timeout float

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sentinel_master str

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinel_nodes Sequence[GatewayPluginAceConfigRateLimitingRedisSentinelNode]

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinel_password str

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinel_role str

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinel_username str

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

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. Default: false

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. Default: false

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.

clusterMaxRedirections Number

Maximum retry attempts for redirection. Default: 5

clusterNodes List<Property Map>

Cluster addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Cluster. The minimum length of the array is 1 element.

connectTimeout Number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

connectionIsProxied Boolean

If the connection to Redis is proxied (e.g. Envoy), set it true. Set the host and port to point to the proxy address. Default: false

database Number

Database to use for the Redis connection when using the redis strategy. Default: 0

host String

A string representing a host name, such as example.com. Default: "127.0.0.1"

keepaliveBacklog Number

Limits the total number of opened connections for a pool. If the connection pool is full, connection queues above the limit go into the backlog queue. If the backlog queue is full, subsequent connect operations fail and return nil. Queued operations (subject to set timeouts) resume once the number of connections in the pool is less than keepalive_pool_size. If latency is high or throughput is low, try increasing this value. Empirically, this value is larger than keepalive_pool_size.

keepalivePoolSize Number

The size limit for every cosocket connection pool associated with every remote server, per worker process. If neither keepalive_pool_size nor keepalive_backlog is specified, no pool is created. If keepalive_pool_size isn't specified but keepalive_backlog is specified, then the pool uses the default value. Try to increase (e.g. 512) this value if latency is high or throughput is low. Default: 256

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. Default: 6379

readTimeout Number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sendTimeout Number

An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2. Default: 2000

sentinelMaster String

Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.

sentinelNodes List<Property Map>

Sentinel node addresses to use for Redis connections when the redis strategy is defined. Defining this field implies using a Redis Sentinel. The minimum length of the array is 1 element.

sentinelPassword String

Sentinel password to authenticate with a Redis Sentinel instance. If undefined, no AUTH commands are sent to Redis Sentinels.

sentinelRole String

Sentinel role to use for Redis connections when the redis strategy is defined. Defining this value implies using Redis Sentinel. must be one of ["any", "master", "slave"]

sentinelUsername String

Sentinel username to authenticate with a Redis Sentinel instance. If undefined, ACL authentication won't be performed. This requires Redis v6.2.0+.

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. Default: false

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. Default: false

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.

Ip string

A string representing a host name, such as example.com. Default: "127.0.0.1"

Port double

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

Ip string

A string representing a host name, such as example.com. Default: "127.0.0.1"

Port float64

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

ip String

A string representing a host name, such as example.com. Default: "127.0.0.1"

port Double

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

ip string

A string representing a host name, such as example.com. Default: "127.0.0.1"

port number

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

ip str

A string representing a host name, such as example.com. Default: "127.0.0.1"

port float

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

ip String

A string representing a host name, such as example.com. Default: "127.0.0.1"

port Number

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

Host string

A string representing a host name, such as example.com. Default: "127.0.0.1"

Port double

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

Host string

A string representing a host name, such as example.com. Default: "127.0.0.1"

Port float64

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

host String

A string representing a host name, such as example.com. Default: "127.0.0.1"

port Double

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

host string

A string representing a host name, such as example.com. Default: "127.0.0.1"

port number

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

host str

A string representing a host name, such as example.com. Default: "127.0.0.1"

port float

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

host String

A string representing a host name, such as example.com. Default: "127.0.0.1"

port Number

An integer representing a port number between 0 and 65535, inclusive. Default: 6379

After GatewayPluginAceOrderingAfter

Before GatewayPluginAceOrderingBefore

After GatewayPluginAceOrderingAfter

Before GatewayPluginAceOrderingBefore

after GatewayPluginAceOrderingAfter

before GatewayPluginAceOrderingBefore

after GatewayPluginAceOrderingAfter

before GatewayPluginAceOrderingBefore

after GatewayPluginAceOrderingAfter

before GatewayPluginAceOrderingBefore

after Property Map

before Property Map

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

Id string

A string representing a UUID (universally unique identifier).

Name string

A unique string representing a UTF-8 encoded name.

Path string