1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginProxyCacheAdvanced
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginProxyCacheAdvanced

Explore with Pulumi AI

GatewayPluginProxyCacheAdvanced 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.GatewayPluginProxyCacheAdvanced;
import com.pulumi.konnect.GatewayPluginProxyCacheAdvancedArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedConfigMemoryArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedConfigRedisArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedConsumerArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedConsumerGroupArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginProxyCacheAdvancedServiceArgs;
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 myGatewaypluginproxycacheadvanced = new GatewayPluginProxyCacheAdvanced("myGatewaypluginproxycacheadvanced", GatewayPluginProxyCacheAdvancedArgs.builder()
            .config(GatewayPluginProxyCacheAdvancedConfigArgs.builder()
                .bypass_on_err(true)
                .cache_control(true)
                .cache_ttl(5)
                .content_type("...")
                .ignore_uri_case(false)
                .memory(GatewayPluginProxyCacheAdvancedConfigMemoryArgs.builder()
                    .dictionaryName("...my_dictionary_name...")
                    .build())
                .redis(GatewayPluginProxyCacheAdvancedConfigRedisArgs.builder()
                    .clusterMaxRedirections(7)
                    .clusterNodes(GatewayPluginProxyCacheAdvancedConfigRedisClusterNodeArgs.builder()
                        .ip("...my_ip...")
                        .port(56343)
                        .build())
                    .connectTimeout(883264270)
                    .connectionIsProxied(false)
                    .database(1)
                    .host("...my_host...")
                    .keepaliveBacklog(578209368)
                    .keepalivePoolSize(1307431457)
                    .password("...my_password...")
                    .port(54281)
                    .readTimeout(350076819)
                    .sendTimeout(2140614627)
                    .sentinelMaster("...my_sentinel_master...")
                    .sentinelNodes(GatewayPluginProxyCacheAdvancedConfigRedisSentinelNodeArgs.builder()
                        .host("...my_host...")
                        .port(8222)
                        .build())
                    .sentinelPassword("...my_sentinel_password...")
                    .sentinelRole("any")
                    .sentinelUsername("...my_sentinel_username...")
                    .serverName("...my_server_name...")
                    .ssl(false)
                    .sslVerify(true)
                    .username("...my_username...")
                    .build())
                .request_method("GET")
                .response_code(269)
                .response_headers(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                .storage_ttl(0)
                .strategy("redis")
                .vary_headers("...")
                .vary_query_params("...")
                .build())
            .consumer(GatewayPluginProxyCacheAdvancedConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerGroup(GatewayPluginProxyCacheAdvancedConsumerGroupArgs.builder()
                .id("...my_id...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginProxyCacheAdvancedId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginProxyCacheAdvancedOrderingArgs.builder()
                .after(GatewayPluginProxyCacheAdvancedOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginProxyCacheAdvancedOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpcs")
            .route(GatewayPluginProxyCacheAdvancedRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginProxyCacheAdvancedServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}
Copy
resources:
  myGatewaypluginproxycacheadvanced:
    type: konnect:GatewayPluginProxyCacheAdvanced
    properties:
      config:
        bypass_on_err: true
        cache_control: true
        cache_ttl: 5
        content_type:
          - '...'
        ignore_uri_case: false
        memory:
          dictionaryName: '...my_dictionary_name...'
        redis:
          clusterMaxRedirections: 7
          clusterNodes:
            - ip: '...my_ip...'
              port: 56343
          connectTimeout: 8.8326427e+08
          connectionIsProxied: false
          database: 1
          host: '...my_host...'
          keepaliveBacklog: 5.78209368e+08
          keepalivePoolSize: 1.307431457e+09
          password: '...my_password...'
          port: 54281
          readTimeout: 3.50076819e+08
          sendTimeout: 2.140614627e+09
          sentinelMaster: '...my_sentinel_master...'
          sentinelNodes:
            - host: '...my_host...'
              port: 8222
          sentinelPassword: '...my_sentinel_password...'
          sentinelRole: any
          sentinelUsername: '...my_sentinel_username...'
          serverName: '...my_server_name...'
          ssl: false
          sslVerify: true
          username: '...my_username...'
        request_method:
          - GET
        response_code:
          - 269
        response_headers:
          age: false
          xCacheKey: true
          xCacheStatus: true
        storage_ttl: 0
        strategy: redis
        vary_headers:
          - '...'
        vary_query_params:
          - '...'
      consumer:
        id: '...my_id...'
      consumerGroup:
        id: '...my_id...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginProxyCacheAdvancedId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpcs
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
Copy

Create GatewayPluginProxyCacheAdvanced Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GatewayPluginProxyCacheAdvanced(name: string, args: GatewayPluginProxyCacheAdvancedArgs, opts?: CustomResourceOptions);
@overload
def GatewayPluginProxyCacheAdvanced(resource_name: str,
                                    args: GatewayPluginProxyCacheAdvancedArgs,
                                    opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginProxyCacheAdvanced(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    config: Optional[GatewayPluginProxyCacheAdvancedConfigArgs] = None,
                                    control_plane_id: Optional[str] = None,
                                    consumer: Optional[GatewayPluginProxyCacheAdvancedConsumerArgs] = None,
                                    consumer_group: Optional[GatewayPluginProxyCacheAdvancedConsumerGroupArgs] = None,
                                    enabled: Optional[bool] = None,
                                    gateway_plugin_proxy_cache_advanced_id: Optional[str] = None,
                                    instance_name: Optional[str] = None,
                                    ordering: Optional[GatewayPluginProxyCacheAdvancedOrderingArgs] = None,
                                    protocols: Optional[Sequence[str]] = None,
                                    route: Optional[GatewayPluginProxyCacheAdvancedRouteArgs] = None,
                                    service: Optional[GatewayPluginProxyCacheAdvancedServiceArgs] = None,
                                    tags: Optional[Sequence[str]] = None)
func NewGatewayPluginProxyCacheAdvanced(ctx *Context, name string, args GatewayPluginProxyCacheAdvancedArgs, opts ...ResourceOption) (*GatewayPluginProxyCacheAdvanced, error)
public GatewayPluginProxyCacheAdvanced(string name, GatewayPluginProxyCacheAdvancedArgs args, CustomResourceOptions? opts = null)
public GatewayPluginProxyCacheAdvanced(String name, GatewayPluginProxyCacheAdvancedArgs args)
public GatewayPluginProxyCacheAdvanced(String name, GatewayPluginProxyCacheAdvancedArgs args, CustomResourceOptions options)
type: konnect:GatewayPluginProxyCacheAdvanced
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayPluginProxyCacheAdvancedArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayPluginProxyCacheAdvancedArgs
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. GatewayPluginProxyCacheAdvancedArgs
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. GatewayPluginProxyCacheAdvancedArgs
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. GatewayPluginProxyCacheAdvancedArgs
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 gatewayPluginProxyCacheAdvancedResource = new Konnect.GatewayPluginProxyCacheAdvanced("gatewayPluginProxyCacheAdvancedResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConfigArgs
    {
        BypassOnErr = false,
        CacheControl = false,
        CacheTtl = 0,
        ContentTypes = new[]
        {
            "string",
        },
        IgnoreUriCase = false,
        Memory = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConfigMemoryArgs
        {
            DictionaryName = "string",
        },
        Redis = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConfigRedisArgs
        {
            ClusterMaxRedirections = 0,
            ClusterNodes = new[]
            {
                new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConfigRedisClusterNodeArgs
                {
                    Ip = "string",
                    Port = 0,
                },
            },
            ConnectTimeout = 0,
            ConnectionIsProxied = false,
            Database = 0,
            Host = "string",
            KeepaliveBacklog = 0,
            KeepalivePoolSize = 0,
            Password = "string",
            Port = 0,
            ReadTimeout = 0,
            SendTimeout = 0,
            SentinelMaster = "string",
            SentinelNodes = new[]
            {
                new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConfigRedisSentinelNodeArgs
                {
                    Host = "string",
                    Port = 0,
                },
            },
            SentinelPassword = "string",
            SentinelRole = "string",
            SentinelUsername = "string",
            ServerName = "string",
            Ssl = false,
            SslVerify = false,
            Username = "string",
        },
        RequestMethods = new[]
        {
            "string",
        },
        ResponseCodes = new[]
        {
            0,
        },
        ResponseHeaders = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConfigResponseHeadersArgs
        {
            Age = false,
            XCacheKey = false,
            XCacheStatus = false,
        },
        StorageTtl = 0,
        Strategy = "string",
        VaryHeaders = new[]
        {
            "string",
        },
        VaryQueryParams = new[]
        {
            "string",
        },
    },
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    GatewayPluginProxyCacheAdvancedId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginProxyCacheAdvancedServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayPluginProxyCacheAdvanced(ctx, "gatewayPluginProxyCacheAdvancedResource", &konnect.GatewayPluginProxyCacheAdvancedArgs{
Config: &.GatewayPluginProxyCacheAdvancedConfigArgs{
BypassOnErr: pulumi.Bool(false),
CacheControl: pulumi.Bool(false),
CacheTtl: pulumi.Float64(0),
ContentTypes: pulumi.StringArray{
pulumi.String("string"),
},
IgnoreUriCase: pulumi.Bool(false),
Memory: &.GatewayPluginProxyCacheAdvancedConfigMemoryArgs{
DictionaryName: pulumi.String("string"),
},
Redis: &.GatewayPluginProxyCacheAdvancedConfigRedisArgs{
ClusterMaxRedirections: pulumi.Float64(0),
ClusterNodes: .GatewayPluginProxyCacheAdvancedConfigRedisClusterNodeArray{
&.GatewayPluginProxyCacheAdvancedConfigRedisClusterNodeArgs{
Ip: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
ConnectTimeout: pulumi.Float64(0),
ConnectionIsProxied: pulumi.Bool(false),
Database: pulumi.Float64(0),
Host: pulumi.String("string"),
KeepaliveBacklog: pulumi.Float64(0),
KeepalivePoolSize: pulumi.Float64(0),
Password: pulumi.String("string"),
Port: pulumi.Float64(0),
ReadTimeout: pulumi.Float64(0),
SendTimeout: pulumi.Float64(0),
SentinelMaster: pulumi.String("string"),
SentinelNodes: .GatewayPluginProxyCacheAdvancedConfigRedisSentinelNodeArray{
&.GatewayPluginProxyCacheAdvancedConfigRedisSentinelNodeArgs{
Host: pulumi.String("string"),
Port: pulumi.Float64(0),
},
},
SentinelPassword: pulumi.String("string"),
SentinelRole: pulumi.String("string"),
SentinelUsername: pulumi.String("string"),
ServerName: pulumi.String("string"),
Ssl: pulumi.Bool(false),
SslVerify: pulumi.Bool(false),
Username: pulumi.String("string"),
},
RequestMethods: pulumi.StringArray{
pulumi.String("string"),
},
ResponseCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
ResponseHeaders: &.GatewayPluginProxyCacheAdvancedConfigResponseHeadersArgs{
Age: pulumi.Bool(false),
XCacheKey: pulumi.Bool(false),
XCacheStatus: pulumi.Bool(false),
},
StorageTtl: pulumi.Float64(0),
Strategy: pulumi.String("string"),
VaryHeaders: pulumi.StringArray{
pulumi.String("string"),
},
VaryQueryParams: pulumi.StringArray{
pulumi.String("string"),
},
},
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayPluginProxyCacheAdvancedConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayPluginProxyCacheAdvancedConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
GatewayPluginProxyCacheAdvancedId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginProxyCacheAdvancedOrderingArgs{
After: &.GatewayPluginProxyCacheAdvancedOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginProxyCacheAdvancedOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginProxyCacheAdvancedRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginProxyCacheAdvancedServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayPluginProxyCacheAdvancedResource = new GatewayPluginProxyCacheAdvanced("gatewayPluginProxyCacheAdvancedResource", GatewayPluginProxyCacheAdvancedArgs.builder()
    .config(GatewayPluginProxyCacheAdvancedConfigArgs.builder()
        .bypassOnErr(false)
        .cacheControl(false)
        .cacheTtl(0)
        .contentTypes("string")
        .ignoreUriCase(false)
        .memory(GatewayPluginProxyCacheAdvancedConfigMemoryArgs.builder()
            .dictionaryName("string")
            .build())
        .redis(GatewayPluginProxyCacheAdvancedConfigRedisArgs.builder()
            .clusterMaxRedirections(0)
            .clusterNodes(GatewayPluginProxyCacheAdvancedConfigRedisClusterNodeArgs.builder()
                .ip("string")
                .port(0)
                .build())
            .connectTimeout(0)
            .connectionIsProxied(false)
            .database(0)
            .host("string")
            .keepaliveBacklog(0)
            .keepalivePoolSize(0)
            .password("string")
            .port(0)
            .readTimeout(0)
            .sendTimeout(0)
            .sentinelMaster("string")
            .sentinelNodes(GatewayPluginProxyCacheAdvancedConfigRedisSentinelNodeArgs.builder()
                .host("string")
                .port(0)
                .build())
            .sentinelPassword("string")
            .sentinelRole("string")
            .sentinelUsername("string")
            .serverName("string")
            .ssl(false)
            .sslVerify(false)
            .username("string")
            .build())
        .requestMethods("string")
        .responseCodes(0)
        .responseHeaders(GatewayPluginProxyCacheAdvancedConfigResponseHeadersArgs.builder()
            .age(false)
            .xCacheKey(false)
            .xCacheStatus(false)
            .build())
        .storageTtl(0)
        .strategy("string")
        .varyHeaders("string")
        .varyQueryParams("string")
        .build())
    .controlPlaneId("string")
    .consumer(GatewayPluginProxyCacheAdvancedConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayPluginProxyCacheAdvancedConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .gatewayPluginProxyCacheAdvancedId("string")
    .instanceName("string")
    .ordering(GatewayPluginProxyCacheAdvancedOrderingArgs.builder()
        .after(GatewayPluginProxyCacheAdvancedOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginProxyCacheAdvancedOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginProxyCacheAdvancedRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginProxyCacheAdvancedServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
Copy
gateway_plugin_proxy_cache_advanced_resource = konnect.GatewayPluginProxyCacheAdvanced("gatewayPluginProxyCacheAdvancedResource",
    config={
        "bypass_on_err": False,
        "cache_control": False,
        "cache_ttl": 0,
        "content_types": ["string"],
        "ignore_uri_case": False,
        "memory": {
            "dictionary_name": "string",
        },
        "redis": {
            "cluster_max_redirections": 0,
            "cluster_nodes": [{
                "ip": "string",
                "port": 0,
            }],
            "connect_timeout": 0,
            "connection_is_proxied": False,
            "database": 0,
            "host": "string",
            "keepalive_backlog": 0,
            "keepalive_pool_size": 0,
            "password": "string",
            "port": 0,
            "read_timeout": 0,
            "send_timeout": 0,
            "sentinel_master": "string",
            "sentinel_nodes": [{
                "host": "string",
                "port": 0,
            }],
            "sentinel_password": "string",
            "sentinel_role": "string",
            "sentinel_username": "string",
            "server_name": "string",
            "ssl": False,
            "ssl_verify": False,
            "username": "string",
        },
        "request_methods": ["string"],
        "response_codes": [0],
        "response_headers": {
            "age": False,
            "x_cache_key": False,
            "x_cache_status": False,
        },
        "storage_ttl": 0,
        "strategy": "string",
        "vary_headers": ["string"],
        "vary_query_params": ["string"],
    },
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    gateway_plugin_proxy_cache_advanced_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])
Copy
const gatewayPluginProxyCacheAdvancedResource = new konnect.GatewayPluginProxyCacheAdvanced("gatewayPluginProxyCacheAdvancedResource", {
    config: {
        bypassOnErr: false,
        cacheControl: false,
        cacheTtl: 0,
        contentTypes: ["string"],
        ignoreUriCase: false,
        memory: {
            dictionaryName: "string",
        },
        redis: {
            clusterMaxRedirections: 0,
            clusterNodes: [{
                ip: "string",
                port: 0,
            }],
            connectTimeout: 0,
            connectionIsProxied: false,
            database: 0,
            host: "string",
            keepaliveBacklog: 0,
            keepalivePoolSize: 0,
            password: "string",
            port: 0,
            readTimeout: 0,
            sendTimeout: 0,
            sentinelMaster: "string",
            sentinelNodes: [{
                host: "string",
                port: 0,
            }],
            sentinelPassword: "string",
            sentinelRole: "string",
            sentinelUsername: "string",
            serverName: "string",
            ssl: false,
            sslVerify: false,
            username: "string",
        },
        requestMethods: ["string"],
        responseCodes: [0],
        responseHeaders: {
            age: false,
            xCacheKey: false,
            xCacheStatus: false,
        },
        storageTtl: 0,
        strategy: "string",
        varyHeaders: ["string"],
        varyQueryParams: ["string"],
    },
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    gatewayPluginProxyCacheAdvancedId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});
Copy
type: konnect:GatewayPluginProxyCacheAdvanced
properties:
    config:
        bypassOnErr: false
        cacheControl: false
        cacheTtl: 0
        contentTypes:
            - string
        ignoreUriCase: false
        memory:
            dictionaryName: string
        redis:
            clusterMaxRedirections: 0
            clusterNodes:
                - ip: string
                  port: 0
            connectTimeout: 0
            connectionIsProxied: false
            database: 0
            host: string
            keepaliveBacklog: 0
            keepalivePoolSize: 0
            password: string
            port: 0
            readTimeout: 0
            sendTimeout: 0
            sentinelMaster: string
            sentinelNodes:
                - host: string
                  port: 0
            sentinelPassword: string
            sentinelRole: string
            sentinelUsername: string
            serverName: string
            ssl: false
            sslVerify: false
            username: string
        requestMethods:
            - string
        responseCodes:
            - 0
        responseHeaders:
            age: false
            xCacheKey: false
            xCacheStatus: false
        storageTtl: 0
        strategy: string
        varyHeaders:
            - string
        varyQueryParams:
            - string
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    gatewayPluginProxyCacheAdvancedId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
Copy

GatewayPluginProxyCacheAdvanced 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 GatewayPluginProxyCacheAdvanced resource accepts the following input properties:

Config This property is required. GatewayPluginProxyCacheAdvancedConfig
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginProxyCacheAdvancedConsumer
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 GatewayPluginProxyCacheAdvancedConsumerGroup
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
Enabled bool
Whether the plugin is applied.
GatewayPluginProxyCacheAdvancedId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginProxyCacheAdvancedOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Route GatewayPluginProxyCacheAdvancedRoute
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 GatewayPluginProxyCacheAdvancedService
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.
Config This property is required. GatewayPluginProxyCacheAdvancedConfigArgs
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer GatewayPluginProxyCacheAdvancedConsumerArgs
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 GatewayPluginProxyCacheAdvancedConsumerGroupArgs
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
Enabled bool
Whether the plugin is applied.
GatewayPluginProxyCacheAdvancedId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginProxyCacheAdvancedOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Route GatewayPluginProxyCacheAdvancedRouteArgs
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 GatewayPluginProxyCacheAdvancedServiceArgs
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.
config This property is required. GatewayPluginProxyCacheAdvancedConfig
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginProxyCacheAdvancedConsumer
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 GatewayPluginProxyCacheAdvancedConsumerGroup
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
enabled Boolean
Whether the plugin is applied.
gatewayPluginProxyCacheAdvancedId String
The ID of this resource.
instanceName String
ordering GatewayPluginProxyCacheAdvancedOrdering
protocols List<String>
A set of strings representing HTTP protocols.
route GatewayPluginProxyCacheAdvancedRoute
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 GatewayPluginProxyCacheAdvancedService
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.
config This property is required. GatewayPluginProxyCacheAdvancedConfig
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer GatewayPluginProxyCacheAdvancedConsumer
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 GatewayPluginProxyCacheAdvancedConsumerGroup
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
enabled boolean
Whether the plugin is applied.
gatewayPluginProxyCacheAdvancedId string
The ID of this resource.
instanceName string
ordering GatewayPluginProxyCacheAdvancedOrdering
protocols string[]
A set of strings representing HTTP protocols.
route GatewayPluginProxyCacheAdvancedRoute
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 GatewayPluginProxyCacheAdvancedService
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.
config This property is required. GatewayPluginProxyCacheAdvancedConfigArgs
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.
consumer GatewayPluginProxyCacheAdvancedConsumerArgs
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 GatewayPluginProxyCacheAdvancedConsumerGroupArgs
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
enabled bool
Whether the plugin is applied.
gateway_plugin_proxy_cache_advanced_id str
The ID of this resource.
instance_name str
ordering GatewayPluginProxyCacheAdvancedOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
route GatewayPluginProxyCacheAdvancedRouteArgs
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 GatewayPluginProxyCacheAdvancedServiceArgs
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.
config This property is required. Property Map
controlPlaneId This property is required. String
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.
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
enabled Boolean
Whether the plugin is applied.
gatewayPluginProxyCacheAdvancedId 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayPluginProxyCacheAdvanced resource produces the following output properties:

CreatedAt double
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt double
Unix epoch when the resource was last updated.
CreatedAt float64
Unix epoch when the resource was created.
Id string
The provider-assigned unique ID for this managed resource.
UpdatedAt float64
Unix epoch when the resource was last updated.
createdAt Double
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Double
Unix epoch when the resource was last updated.
createdAt number
Unix epoch when the resource was created.
id string
The provider-assigned unique ID for this managed resource.
updatedAt number
Unix epoch when the resource was last updated.
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.
createdAt Number
Unix epoch when the resource was created.
id String
The provider-assigned unique ID for this managed resource.
updatedAt Number
Unix epoch when the resource was last updated.

Look up Existing GatewayPluginProxyCacheAdvanced Resource

Get an existing GatewayPluginProxyCacheAdvanced 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?: GatewayPluginProxyCacheAdvancedState, opts?: CustomResourceOptions): GatewayPluginProxyCacheAdvanced
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginProxyCacheAdvancedConfigArgs] = None,
        consumer: Optional[GatewayPluginProxyCacheAdvancedConsumerArgs] = None,
        consumer_group: Optional[GatewayPluginProxyCacheAdvancedConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_proxy_cache_advanced_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginProxyCacheAdvancedOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginProxyCacheAdvancedRouteArgs] = None,
        service: Optional[GatewayPluginProxyCacheAdvancedServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginProxyCacheAdvanced
func GetGatewayPluginProxyCacheAdvanced(ctx *Context, name string, id IDInput, state *GatewayPluginProxyCacheAdvancedState, opts ...ResourceOption) (*GatewayPluginProxyCacheAdvanced, error)
public static GatewayPluginProxyCacheAdvanced Get(string name, Input<string> id, GatewayPluginProxyCacheAdvancedState? state, CustomResourceOptions? opts = null)
public static GatewayPluginProxyCacheAdvanced get(String name, Output<String> id, GatewayPluginProxyCacheAdvancedState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginProxyCacheAdvanced    get:      id: ${id}
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.
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.
The following state arguments are supported:
Config GatewayPluginProxyCacheAdvancedConfig
Consumer GatewayPluginProxyCacheAdvancedConsumer
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 GatewayPluginProxyCacheAdvancedConsumerGroup
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
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginProxyCacheAdvancedId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginProxyCacheAdvancedOrdering
Protocols List<string>
A set of strings representing HTTP protocols.
Route GatewayPluginProxyCacheAdvancedRoute
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 GatewayPluginProxyCacheAdvancedService
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.
Config GatewayPluginProxyCacheAdvancedConfigArgs
Consumer GatewayPluginProxyCacheAdvancedConsumerArgs
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 GatewayPluginProxyCacheAdvancedConsumerGroupArgs
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
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginProxyCacheAdvancedId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginProxyCacheAdvancedOrderingArgs
Protocols []string
A set of strings representing HTTP protocols.
Route GatewayPluginProxyCacheAdvancedRouteArgs
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 GatewayPluginProxyCacheAdvancedServiceArgs
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.
config GatewayPluginProxyCacheAdvancedConfig
consumer GatewayPluginProxyCacheAdvancedConsumer
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 GatewayPluginProxyCacheAdvancedConsumerGroup
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
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginProxyCacheAdvancedId String
The ID of this resource.
instanceName String
ordering GatewayPluginProxyCacheAdvancedOrdering
protocols List<String>
A set of strings representing HTTP protocols.
route GatewayPluginProxyCacheAdvancedRoute
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 GatewayPluginProxyCacheAdvancedService
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.
config GatewayPluginProxyCacheAdvancedConfig
consumer GatewayPluginProxyCacheAdvancedConsumer
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 GatewayPluginProxyCacheAdvancedConsumerGroup
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
controlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number
Unix epoch when the resource was created.
enabled boolean
Whether the plugin is applied.
gatewayPluginProxyCacheAdvancedId string
The ID of this resource.
instanceName string
ordering GatewayPluginProxyCacheAdvancedOrdering
protocols string[]
A set of strings representing HTTP protocols.
route GatewayPluginProxyCacheAdvancedRoute
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 GatewayPluginProxyCacheAdvancedService
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.
config GatewayPluginProxyCacheAdvancedConfigArgs
consumer GatewayPluginProxyCacheAdvancedConsumerArgs
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 GatewayPluginProxyCacheAdvancedConsumerGroupArgs
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
control_plane_id str
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_proxy_cache_advanced_id str
The ID of this resource.
instance_name str
ordering GatewayPluginProxyCacheAdvancedOrderingArgs
protocols Sequence[str]
A set of strings representing HTTP protocols.
route GatewayPluginProxyCacheAdvancedRouteArgs
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 GatewayPluginProxyCacheAdvancedServiceArgs
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.
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
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginProxyCacheAdvancedId 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.

Supporting Types

GatewayPluginProxyCacheAdvancedConfig
, GatewayPluginProxyCacheAdvancedConfigArgs

BypassOnErr bool
Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
CacheControl bool
When enabled, respect the Cache-Control behaviors defined in RFC7234.
CacheTtl double
TTL in seconds of cache entities.
ContentTypes List<string>
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
IgnoreUriCase bool
Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
Memory GatewayPluginProxyCacheAdvancedConfigMemory
Redis GatewayPluginProxyCacheAdvancedConfigRedis
RequestMethods List<string>
Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
ResponseCodes List<double>
Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
ResponseHeaders GatewayPluginProxyCacheAdvancedConfigResponseHeaders
Caching related diagnostic headers that should be included in cached responses
StorageTtl double
Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
Strategy string
The backing data store in which to hold cache entities. Accepted values are: memory and redis. must be one of ["memory", "redis"]
VaryHeaders List<string>
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
VaryQueryParams List<string>
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
BypassOnErr bool
Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
CacheControl bool
When enabled, respect the Cache-Control behaviors defined in RFC7234.
CacheTtl float64
TTL in seconds of cache entities.
ContentTypes []string
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
IgnoreUriCase bool
Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
Memory GatewayPluginProxyCacheAdvancedConfigMemory
Redis GatewayPluginProxyCacheAdvancedConfigRedis
RequestMethods []string
Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
ResponseCodes []float64
Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
ResponseHeaders GatewayPluginProxyCacheAdvancedConfigResponseHeaders
Caching related diagnostic headers that should be included in cached responses
StorageTtl float64
Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
Strategy string
The backing data store in which to hold cache entities. Accepted values are: memory and redis. must be one of ["memory", "redis"]
VaryHeaders []string
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
VaryQueryParams []string
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
bypassOnErr Boolean
Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cacheControl Boolean
When enabled, respect the Cache-Control behaviors defined in RFC7234.
cacheTtl Double
TTL in seconds of cache entities.
contentTypes List<String>
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignoreUriCase Boolean
Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory GatewayPluginProxyCacheAdvancedConfigMemory
redis GatewayPluginProxyCacheAdvancedConfigRedis
requestMethods List<String>
Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
responseCodes List<Double>
Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
responseHeaders GatewayPluginProxyCacheAdvancedConfigResponseHeaders
Caching related diagnostic headers that should be included in cached responses
storageTtl Double
Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy String
The backing data store in which to hold cache entities. Accepted values are: memory and redis. must be one of ["memory", "redis"]
varyHeaders List<String>
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
varyQueryParams List<String>
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
bypassOnErr boolean
Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cacheControl boolean
When enabled, respect the Cache-Control behaviors defined in RFC7234.
cacheTtl number
TTL in seconds of cache entities.
contentTypes string[]
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignoreUriCase boolean
Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory GatewayPluginProxyCacheAdvancedConfigMemory
redis GatewayPluginProxyCacheAdvancedConfigRedis
requestMethods string[]
Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
responseCodes number[]
Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
responseHeaders GatewayPluginProxyCacheAdvancedConfigResponseHeaders
Caching related diagnostic headers that should be included in cached responses
storageTtl number
Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy string
The backing data store in which to hold cache entities. Accepted values are: memory and redis. must be one of ["memory", "redis"]
varyHeaders string[]
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
varyQueryParams string[]
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
bypass_on_err bool
Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cache_control bool
When enabled, respect the Cache-Control behaviors defined in RFC7234.
cache_ttl float
TTL in seconds of cache entities.
content_types Sequence[str]
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignore_uri_case bool
Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory GatewayPluginProxyCacheAdvancedConfigMemory
redis GatewayPluginProxyCacheAdvancedConfigRedis
request_methods Sequence[str]
Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
response_codes Sequence[float]
Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
response_headers GatewayPluginProxyCacheAdvancedConfigResponseHeaders
Caching related diagnostic headers that should be included in cached responses
storage_ttl float
Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy str
The backing data store in which to hold cache entities. Accepted values are: memory and redis. must be one of ["memory", "redis"]
vary_headers Sequence[str]
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
vary_query_params Sequence[str]
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.
bypassOnErr Boolean
Unhandled errors while trying to retrieve a cache entry (such as redis down) are resolved with Bypass, with the request going upstream.
cacheControl Boolean
When enabled, respect the Cache-Control behaviors defined in RFC7234.
cacheTtl Number
TTL in seconds of cache entities.
contentTypes List<String>
Upstream response content types considered cacheable. The plugin performs an exact match against each specified value; for example, if the upstream is expected to respond with a application/json; charset=utf-8 content-type, the plugin configuration must contain said value or a Bypass cache status is returned.
ignoreUriCase Boolean
Determines whether to treat URIs as case sensitive. By default, case sensitivity is enabled. If set to true, requests are cached while ignoring case sensitivity in the URI.
memory Property Map
redis Property Map
requestMethods List<String>
Downstream request methods considered cacheable. Available options: HEAD, GET, POST, PATCH, PUT.
responseCodes List<Number>
Upstream response status code considered cacheable. The integers must be a value between 100 and 900.
responseHeaders Property Map
Caching related diagnostic headers that should be included in cached responses
storageTtl Number
Number of seconds to keep resources in the storage backend. This value is independent of cache_ttl or resource TTLs defined by Cache-Control behaviors.
strategy String
The backing data store in which to hold cache entities. Accepted values are: memory and redis. must be one of ["memory", "redis"]
varyHeaders List<String>
Relevant headers considered for the cache key. If undefined, none of the headers are taken into consideration.
varyQueryParams List<String>
Relevant query parameters considered for the cache key. If undefined, all params are taken into consideration.

GatewayPluginProxyCacheAdvancedConfigMemory
, GatewayPluginProxyCacheAdvancedConfigMemoryArgs

DictionaryName string
The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
DictionaryName string
The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
dictionaryName String
The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
dictionaryName string
The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
dictionary_name str
The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.
dictionaryName String
The name of the shared dictionary in which to hold cache entities when the memory strategy is selected. Note that this dictionary currently must be defined manually in the Kong Nginx template.

GatewayPluginProxyCacheAdvancedConfigRedis
, GatewayPluginProxyCacheAdvancedConfigRedisArgs

ClusterMaxRedirections double
Maximum retry attempts for redirection.
ClusterNodes List<GatewayPluginProxyCacheAdvancedConfigRedisClusterNode>
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.
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.
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.
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.
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.
ReadTimeout double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SendTimeout double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SentinelMaster string
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
SentinelNodes List<GatewayPluginProxyCacheAdvancedConfigRedisSentinelNode>
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.
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.
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.
ClusterNodes []GatewayPluginProxyCacheAdvancedConfigRedisClusterNode
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.
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.
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.
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.
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.
ReadTimeout float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SendTimeout float64
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
SentinelMaster string
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
SentinelNodes []GatewayPluginProxyCacheAdvancedConfigRedisSentinelNode
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.
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.
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.
clusterNodes List<GatewayPluginProxyCacheAdvancedConfigRedisClusterNode>
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.
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.
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.
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.
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.
readTimeout Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sendTimeout Double
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinelMaster String
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinelNodes List<GatewayPluginProxyCacheAdvancedConfigRedisSentinelNode>
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.
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.
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.
clusterNodes GatewayPluginProxyCacheAdvancedConfigRedisClusterNode[]
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.
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.
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.
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.
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.
readTimeout number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sendTimeout number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinelMaster string
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinelNodes GatewayPluginProxyCacheAdvancedConfigRedisSentinelNode[]
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.
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.
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.
cluster_nodes Sequence[GatewayPluginProxyCacheAdvancedConfigRedisClusterNode]
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.
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.
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.
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.
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.
read_timeout float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
send_timeout float
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sentinel_master str
Sentinel master to use for Redis connections. Defining this value implies using Redis Sentinel.
sentinel_nodes Sequence[GatewayPluginProxyCacheAdvancedConfigRedisSentinelNode]
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.
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.
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.
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.
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.
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.
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.
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.
readTimeout Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
sendTimeout Number
An integer representing a timeout in milliseconds. Must be between 0 and 2^31-2.
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.
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.
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.

GatewayPluginProxyCacheAdvancedConfigRedisClusterNode
, GatewayPluginProxyCacheAdvancedConfigRedisClusterNodeArgs

Ip string
A string representing a host name, such as example.com.
Port double
An integer representing a port number between 0 and 65535, inclusive.
Ip string
A string representing a host name, such as example.com.
Port float64
An integer representing a port number between 0 and 65535, inclusive.
ip String
A string representing a host name, such as example.com.
port Double
An integer representing a port number between 0 and 65535, inclusive.
ip string
A string representing a host name, such as example.com.
port number
An integer representing a port number between 0 and 65535, inclusive.
ip str
A string representing a host name, such as example.com.
port float
An integer representing a port number between 0 and 65535, inclusive.
ip String
A string representing a host name, such as example.com.
port Number
An integer representing a port number between 0 and 65535, inclusive.

GatewayPluginProxyCacheAdvancedConfigRedisSentinelNode
, GatewayPluginProxyCacheAdvancedConfigRedisSentinelNodeArgs

Host string
A string representing a host name, such as example.com.
Port double
An integer representing a port number between 0 and 65535, inclusive.
Host string
A string representing a host name, such as example.com.
Port float64
An integer representing a port number between 0 and 65535, inclusive.
host String
A string representing a host name, such as example.com.
port Double
An integer representing a port number between 0 and 65535, inclusive.
host string
A string representing a host name, such as example.com.
port number
An integer representing a port number between 0 and 65535, inclusive.
host str
A string representing a host name, such as example.com.
port float
An integer representing a port number between 0 and 65535, inclusive.
host String
A string representing a host name, such as example.com.
port Number
An integer representing a port number between 0 and 65535, inclusive.

GatewayPluginProxyCacheAdvancedConfigResponseHeaders
, GatewayPluginProxyCacheAdvancedConfigResponseHeadersArgs

age Boolean
xCacheKey Boolean
xCacheStatus Boolean
age boolean
xCacheKey boolean
xCacheStatus boolean
age Boolean
xCacheKey Boolean
xCacheStatus Boolean

GatewayPluginProxyCacheAdvancedConsumer
, GatewayPluginProxyCacheAdvancedConsumerArgs

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

GatewayPluginProxyCacheAdvancedConsumerGroup
, GatewayPluginProxyCacheAdvancedConsumerGroupArgs

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

GatewayPluginProxyCacheAdvancedOrdering
, GatewayPluginProxyCacheAdvancedOrderingArgs

GatewayPluginProxyCacheAdvancedOrderingAfter
, GatewayPluginProxyCacheAdvancedOrderingAfterArgs

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

GatewayPluginProxyCacheAdvancedOrderingBefore
, GatewayPluginProxyCacheAdvancedOrderingBeforeArgs

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

GatewayPluginProxyCacheAdvancedRoute
, GatewayPluginProxyCacheAdvancedRouteArgs

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

GatewayPluginProxyCacheAdvancedService
, GatewayPluginProxyCacheAdvancedServiceArgs

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

Import

$ pulumi import konnect:index/gatewayPluginProxyCacheAdvanced:GatewayPluginProxyCacheAdvanced my_konnect_gateway_plugin_proxy_cache_advanced "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
Copy

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 konnect Terraform Provider.