Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Kong Provider
  3. API Docs
  4. Plugin
Kong v4.5.8 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-kong

kong.Plugin

Explore with Pulumi AI

Kong v4.5.8 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-kong

# kong.Plugin

The plugin resource maps directly onto the json for the API endpoint in Kong. For more information on the parameters see the Kong Api create documentation. The config_json is passed through to the plugin to configure it as is.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as kong from "@pulumi/kong";

const rateLimit = new kong.Plugin("rate_limit", {
    name: "rate-limiting",
    configJson: `\x09{
\x09\x09"second": 5,
\x09\x09"hour" : 1000
\x09}
`,
});
Copy
import pulumi
import pulumi_kong as kong

rate_limit = kong.Plugin("rate_limit",
    name="rate-limiting",
    config_json="""\x09{
\x09\x09"second": 5,
\x09\x09"hour" : 1000
\x09}
""")
Copy
package main

import (
	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kong.NewPlugin(ctx, "rate_limit", &kong.PluginArgs{
			Name:       pulumi.String("rate-limiting"),
			ConfigJson: pulumi.String("	{\n		\"second\": 5,\n		\"hour\" : 1000\n	}\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kong = Pulumi.Kong;

return await Deployment.RunAsync(() => 
{
    var rateLimit = new Kong.Plugin("rate_limit", new()
    {
        Name = "rate-limiting",
        ConfigJson = @"	{
		""second"": 5,
		""hour"" : 1000
	}
",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kong.Plugin;
import com.pulumi.kong.PluginArgs;
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 rateLimit = new Plugin("rateLimit", PluginArgs.builder()
            .name("rate-limiting")
            .configJson("""
	{
		"second": 5,
		"hour" : 1000
	}
            """)
            .build());

    }
}
Copy
resources:
  rateLimit:
    type: kong:Plugin
    name: rate_limit
    properties:
      name: rate-limiting
      configJson: |
        	{
        		"second": 5,
        		"hour" : 1000
        	}
Copy

To apply a plugin to a consumer use the consumer_id property, for example:

import * as pulumi from "@pulumi/pulumi";
import * as kong from "@pulumi/kong";

const pluginConsumer = new kong.Consumer("plugin_consumer", {
    username: "PluginUser",
    customId: "567",
});
const rateLimit = new kong.Plugin("rate_limit", {
    name: "rate-limiting",
    consumerId: pluginConsumer.id,
    configJson: `\x09{
\x09\x09"second": 5,
\x09\x09"hour" : 1000
\x09}
`,
});
Copy
import pulumi
import pulumi_kong as kong

plugin_consumer = kong.Consumer("plugin_consumer",
    username="PluginUser",
    custom_id="567")
rate_limit = kong.Plugin("rate_limit",
    name="rate-limiting",
    consumer_id=plugin_consumer.id,
    config_json="""\x09{
\x09\x09"second": 5,
\x09\x09"hour" : 1000
\x09}
""")
Copy
package main

import (
	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		pluginConsumer, err := kong.NewConsumer(ctx, "plugin_consumer", &kong.ConsumerArgs{
			Username: pulumi.String("PluginUser"),
			CustomId: pulumi.String("567"),
		})
		if err != nil {
			return err
		}
		_, err = kong.NewPlugin(ctx, "rate_limit", &kong.PluginArgs{
			Name:       pulumi.String("rate-limiting"),
			ConsumerId: pluginConsumer.ID(),
			ConfigJson: pulumi.String("	{\n		\"second\": 5,\n		\"hour\" : 1000\n	}\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kong = Pulumi.Kong;

return await Deployment.RunAsync(() => 
{
    var pluginConsumer = new Kong.Consumer("plugin_consumer", new()
    {
        Username = "PluginUser",
        CustomId = "567",
    });

    var rateLimit = new Kong.Plugin("rate_limit", new()
    {
        Name = "rate-limiting",
        ConsumerId = pluginConsumer.Id,
        ConfigJson = @"	{
		""second"": 5,
		""hour"" : 1000
	}
",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kong.Consumer;
import com.pulumi.kong.ConsumerArgs;
import com.pulumi.kong.Plugin;
import com.pulumi.kong.PluginArgs;
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 pluginConsumer = new Consumer("pluginConsumer", ConsumerArgs.builder()
            .username("PluginUser")
            .customId("567")
            .build());

        var rateLimit = new Plugin("rateLimit", PluginArgs.builder()
            .name("rate-limiting")
            .consumerId(pluginConsumer.id())
            .configJson("""
	{
		"second": 5,
		"hour" : 1000
	}
            """)
            .build());

    }
}
Copy
resources:
  pluginConsumer:
    type: kong:Consumer
    name: plugin_consumer
    properties:
      username: PluginUser
      customId: '567'
  rateLimit:
    type: kong:Plugin
    name: rate_limit
    properties:
      name: rate-limiting
      consumerId: ${pluginConsumer.id}
      configJson: |
        	{
        		"second": 5,
        		"hour" : 1000
        	}
Copy

To apply a plugin to a service use the service_id property, for example:

import * as pulumi from "@pulumi/pulumi";
import * as kong from "@pulumi/kong";

const service = new kong.Service("service", {
    name: "test",
    protocol: "http",
    host: "test.org",
});
const rateLimit = new kong.Plugin("rate_limit", {
    name: "rate-limiting",
    serviceId: service.id,
    configJson: `\x09{
\x09\x09"second": 10,
\x09\x09"hour" : 2000
\x09}
`,
});
Copy
import pulumi
import pulumi_kong as kong

service = kong.Service("service",
    name="test",
    protocol="http",
    host="test.org")
rate_limit = kong.Plugin("rate_limit",
    name="rate-limiting",
    service_id=service.id,
    config_json="""\x09{
\x09\x09"second": 10,
\x09\x09"hour" : 2000
\x09}
""")
Copy
package main

import (
	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		service, err := kong.NewService(ctx, "service", &kong.ServiceArgs{
			Name:     pulumi.String("test"),
			Protocol: pulumi.String("http"),
			Host:     pulumi.String("test.org"),
		})
		if err != nil {
			return err
		}
		_, err = kong.NewPlugin(ctx, "rate_limit", &kong.PluginArgs{
			Name:       pulumi.String("rate-limiting"),
			ServiceId:  service.ID(),
			ConfigJson: pulumi.String("	{\n		\"second\": 10,\n		\"hour\" : 2000\n	}\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kong = Pulumi.Kong;

return await Deployment.RunAsync(() => 
{
    var service = new Kong.Service("service", new()
    {
        Name = "test",
        Protocol = "http",
        Host = "test.org",
    });

    var rateLimit = new Kong.Plugin("rate_limit", new()
    {
        Name = "rate-limiting",
        ServiceId = service.Id,
        ConfigJson = @"	{
		""second"": 10,
		""hour"" : 2000
	}
",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kong.Service;
import com.pulumi.kong.ServiceArgs;
import com.pulumi.kong.Plugin;
import com.pulumi.kong.PluginArgs;
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 service = new Service("service", ServiceArgs.builder()
            .name("test")
            .protocol("http")
            .host("test.org")
            .build());

        var rateLimit = new Plugin("rateLimit", PluginArgs.builder()
            .name("rate-limiting")
            .serviceId(service.id())
            .configJson("""
	{
		"second": 10,
		"hour" : 2000
	}
            """)
            .build());

    }
}
Copy
resources:
  service:
    type: kong:Service
    properties:
      name: test
      protocol: http
      host: test.org
  rateLimit:
    type: kong:Plugin
    name: rate_limit
    properties:
      name: rate-limiting
      serviceId: ${service.id}
      configJson: |
        	{
        		"second": 10,
        		"hour" : 2000
        	}
Copy

To apply a plugin to a route use the route_id property, for example:

import * as pulumi from "@pulumi/pulumi";
import * as kong from "@pulumi/kong";

const service = new kong.Service("service", {
    name: "test",
    protocol: "http",
    host: "test.org",
});
const rateLimit = new kong.Plugin("rate_limit", {
    name: "rate-limiting",
    enabled: true,
    serviceId: service.id,
    configJson: `\x09{
\x09\x09"second": 11,
\x09\x09"hour" : 4000
\x09}
`,
});
Copy
import pulumi
import pulumi_kong as kong

service = kong.Service("service",
    name="test",
    protocol="http",
    host="test.org")
rate_limit = kong.Plugin("rate_limit",
    name="rate-limiting",
    enabled=True,
    service_id=service.id,
    config_json="""\x09{
\x09\x09"second": 11,
\x09\x09"hour" : 4000
\x09}
""")
Copy
package main

import (
	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		service, err := kong.NewService(ctx, "service", &kong.ServiceArgs{
			Name:     pulumi.String("test"),
			Protocol: pulumi.String("http"),
			Host:     pulumi.String("test.org"),
		})
		if err != nil {
			return err
		}
		_, err = kong.NewPlugin(ctx, "rate_limit", &kong.PluginArgs{
			Name:       pulumi.String("rate-limiting"),
			Enabled:    pulumi.Bool(true),
			ServiceId:  service.ID(),
			ConfigJson: pulumi.String("	{\n		\"second\": 11,\n		\"hour\" : 4000\n	}\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Kong = Pulumi.Kong;

return await Deployment.RunAsync(() => 
{
    var service = new Kong.Service("service", new()
    {
        Name = "test",
        Protocol = "http",
        Host = "test.org",
    });

    var rateLimit = new Kong.Plugin("rate_limit", new()
    {
        Name = "rate-limiting",
        Enabled = true,
        ServiceId = service.Id,
        ConfigJson = @"	{
		""second"": 11,
		""hour"" : 4000
	}
",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.kong.Service;
import com.pulumi.kong.ServiceArgs;
import com.pulumi.kong.Plugin;
import com.pulumi.kong.PluginArgs;
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 service = new Service("service", ServiceArgs.builder()
            .name("test")
            .protocol("http")
            .host("test.org")
            .build());

        var rateLimit = new Plugin("rateLimit", PluginArgs.builder()
            .name("rate-limiting")
            .enabled(true)
            .serviceId(service.id())
            .configJson("""
	{
		"second": 11,
		"hour" : 4000
	}
            """)
            .build());

    }
}
Copy
resources:
  service:
    type: kong:Service
    properties:
      name: test
      protocol: http
      host: test.org
  rateLimit:
    type: kong:Plugin
    name: rate_limit
    properties:
      name: rate-limiting
      enabled: true
      serviceId: ${service.id}
      configJson: |
        	{
        		"second": 11,
        		"hour" : 4000
        	}
Copy

Create Plugin Resource

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

Constructor syntax

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

@overload
def Plugin(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           config_json: Optional[str] = None,
           consumer_id: Optional[str] = None,
           enabled: Optional[bool] = None,
           name: Optional[str] = None,
           route_id: Optional[str] = None,
           service_id: Optional[str] = None,
           strict_match: Optional[bool] = None,
           tags: Optional[Sequence[str]] = None)
func NewPlugin(ctx *Context, name string, args *PluginArgs, opts ...ResourceOption) (*Plugin, error)
public Plugin(string name, PluginArgs? args = null, CustomResourceOptions? opts = null)
public Plugin(String name, PluginArgs args)
public Plugin(String name, PluginArgs args, CustomResourceOptions options)

type: kong:Plugin
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 PluginArgs
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 PluginArgs
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 PluginArgs
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 PluginArgs
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. PluginArgs
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 pluginResource = new Kong.Plugin("pluginResource", new()
{
    ConfigJson = "string",
    ConsumerId = "string",
    Enabled = false,
    Name = "string",
    RouteId = "string",
    ServiceId = "string",
    StrictMatch = false,
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := kong.NewPlugin(ctx, "pluginResource", &kong.PluginArgs{
	ConfigJson:  pulumi.String("string"),
	ConsumerId:  pulumi.String("string"),
	Enabled:     pulumi.Bool(false),
	Name:        pulumi.String("string"),
	RouteId:     pulumi.String("string"),
	ServiceId:   pulumi.String("string"),
	StrictMatch: pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
})
Copy
var pluginResource = new Plugin("pluginResource", PluginArgs.builder()
    .configJson("string")
    .consumerId("string")
    .enabled(false)
    .name("string")
    .routeId("string")
    .serviceId("string")
    .strictMatch(false)
    .tags("string")
    .build());
Copy
plugin_resource = kong.Plugin("pluginResource",
    config_json="string",
    consumer_id="string",
    enabled=False,
    name="string",
    route_id="string",
    service_id="string",
    strict_match=False,
    tags=["string"])
Copy
const pluginResource = new kong.Plugin("pluginResource", {
    configJson: "string",
    consumerId: "string",
    enabled: false,
    name: "string",
    routeId: "string",
    serviceId: "string",
    strictMatch: false,
    tags: ["string"],
});
Copy
type: kong:Plugin
properties:
    configJson: string
    consumerId: string
    enabled: false
    name: string
    routeId: string
    serviceId: string
    strictMatch: false
    tags:
        - string
Copy

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

ConfigJson string
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
ConsumerId string
the consumer id you want to configure the plugin for
Enabled bool
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
Name Changes to this property will trigger replacement. string
RouteId string
the route id that you want to configure the plugin for
ServiceId string
the service id that you want to configure the plugin for
StrictMatch bool
Tags List<string>
A list of strings associated with the Plugin for grouping and filtering
ConfigJson string
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
ConsumerId string
the consumer id you want to configure the plugin for
Enabled bool
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
Name Changes to this property will trigger replacement. string
RouteId string
the route id that you want to configure the plugin for
ServiceId string
the service id that you want to configure the plugin for
StrictMatch bool
Tags []string
A list of strings associated with the Plugin for grouping and filtering
configJson String
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumerId String
the consumer id you want to configure the plugin for
enabled Boolean
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. String
routeId String
the route id that you want to configure the plugin for
serviceId String
the service id that you want to configure the plugin for
strictMatch Boolean
tags List<String>
A list of strings associated with the Plugin for grouping and filtering
configJson string
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumerId string
the consumer id you want to configure the plugin for
enabled boolean
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. string
routeId string
the route id that you want to configure the plugin for
serviceId string
the service id that you want to configure the plugin for
strictMatch boolean
tags string[]
A list of strings associated with the Plugin for grouping and filtering
config_json str
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumer_id str
the consumer id you want to configure the plugin for
enabled bool
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. str
route_id str
the route id that you want to configure the plugin for
service_id str
the service id that you want to configure the plugin for
strict_match bool
tags Sequence[str]
A list of strings associated with the Plugin for grouping and filtering
configJson String
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumerId String
the consumer id you want to configure the plugin for
enabled Boolean
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. String
routeId String
the route id that you want to configure the plugin for
serviceId String
the service id that you want to configure the plugin for
strictMatch Boolean
tags List<String>
A list of strings associated with the Plugin for grouping and filtering

Outputs

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

ComputedConfig string
Id string
The provider-assigned unique ID for this managed resource.
ComputedConfig string
Id string
The provider-assigned unique ID for this managed resource.
computedConfig String
id String
The provider-assigned unique ID for this managed resource.
computedConfig string
id string
The provider-assigned unique ID for this managed resource.
computed_config str
id str
The provider-assigned unique ID for this managed resource.
computedConfig String
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Plugin Resource

Get an existing Plugin 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?: PluginState, opts?: CustomResourceOptions): Plugin
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        computed_config: Optional[str] = None,
        config_json: Optional[str] = None,
        consumer_id: Optional[str] = None,
        enabled: Optional[bool] = None,
        name: Optional[str] = None,
        route_id: Optional[str] = None,
        service_id: Optional[str] = None,
        strict_match: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None) -> Plugin
func GetPlugin(ctx *Context, name string, id IDInput, state *PluginState, opts ...ResourceOption) (*Plugin, error)
public static Plugin Get(string name, Input<string> id, PluginState? state, CustomResourceOptions? opts = null)
public static Plugin get(String name, Output<String> id, PluginState state, CustomResourceOptions options)
resources:  _:    type: kong:Plugin    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:
ComputedConfig string
ConfigJson string
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
ConsumerId string
the consumer id you want to configure the plugin for
Enabled bool
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
Name Changes to this property will trigger replacement. string
RouteId string
the route id that you want to configure the plugin for
ServiceId string
the service id that you want to configure the plugin for
StrictMatch bool
Tags List<string>
A list of strings associated with the Plugin for grouping and filtering
ComputedConfig string
ConfigJson string
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
ConsumerId string
the consumer id you want to configure the plugin for
Enabled bool
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
Name Changes to this property will trigger replacement. string
RouteId string
the route id that you want to configure the plugin for
ServiceId string
the service id that you want to configure the plugin for
StrictMatch bool
Tags []string
A list of strings associated with the Plugin for grouping and filtering
computedConfig String
configJson String
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumerId String
the consumer id you want to configure the plugin for
enabled Boolean
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. String
routeId String
the route id that you want to configure the plugin for
serviceId String
the service id that you want to configure the plugin for
strictMatch Boolean
tags List<String>
A list of strings associated with the Plugin for grouping and filtering
computedConfig string
configJson string
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumerId string
the consumer id you want to configure the plugin for
enabled boolean
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. string
routeId string
the route id that you want to configure the plugin for
serviceId string
the service id that you want to configure the plugin for
strictMatch boolean
tags string[]
A list of strings associated with the Plugin for grouping and filtering
computed_config str
config_json str
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumer_id str
the consumer id you want to configure the plugin for
enabled bool
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. str
route_id str
the route id that you want to configure the plugin for
service_id str
the service id that you want to configure the plugin for
strict_match bool
tags Sequence[str]
A list of strings associated with the Plugin for grouping and filtering
computedConfig String
configJson String
this is the configuration json for how you want to configure the plugin. The json is passed straight through to kong as is. You can get the json config from the Kong documentation page of the plugin you are configuring
consumerId String
the consumer id you want to configure the plugin for
enabled Boolean
whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
name Changes to this property will trigger replacement. String
routeId String
the route id that you want to configure the plugin for
serviceId String
the service id that you want to configure the plugin for
strictMatch Boolean
tags List<String>
A list of strings associated with the Plugin for grouping and filtering

Import

To import a plugin:

$ pulumi import kong:index/plugin:Plugin <plugin_identifier> <plugin_id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Kong pulumi/pulumi-kong
License
Apache-2.0
Notes
This Pulumi package is based on the kong Terraform Provider.
Kong v4.5.8 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-kong