Plugin

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

Argument reference

  • plugin_name - (Required) the name of the plugin you want to configure
  • consumer_id - (Optional) the consumer id you want to configure the plugin for
  • service_id - (Optional) the service id that you want to configure the plugin for
  • route_id - (Optional) the route id that you want to configure the plugin for
  • enabled - (Optional) whether the plugin is enabled or not, use if you want to keep the plugin installed but disable it
  • config_json - (Optional) 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
  • tags - (Optional) A list of strings associated with the Plugin for grouping and filtering

Example Usage

using Pulumi;
using Kong = Pulumi.Kong;

class MyStack : Stack
{
    public MyStack()
    {
        var rateLimit = new Kong.Plugin("rateLimit", new Kong.PluginArgs
        {
            ConfigJson = @"	{
		""second"": 5,
		""hour"" : 1000
	}

",
        });
    }

}
package main

import (
	"fmt"

	"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, "rateLimit", &kong.PluginArgs{
			ConfigJson: pulumi.String(fmt.Sprintf("%v%v%v%v%v", "	{\n", "		\"second\": 5,\n", "		\"hour\" : 1000\n", "	}\n", "\n")),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_kong as kong

rate_limit = kong.Plugin("rateLimit", config_json="""	{
		"second": 5,
		"hour" : 1000
	}

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

const rateLimit = new kong.Plugin("rate_limit", {
    configJson: `	{
		"second": 5,
		"hour" : 1000
	}
`,
});

Create a Plugin Resource

new Plugin(name: string, args?: PluginArgs, opts?: CustomResourceOptions);
@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)
@overload
def Plugin(resource_name: str,
           args: Optional[PluginArgs] = None,
           opts: Optional[ResourceOptions] = None)
func NewPlugin(ctx *Context, name string, args *PluginArgs, opts ...ResourceOption) (*Plugin, error)
public Plugin(string name, PluginArgs? args = null, CustomResourceOptions? opts = null)
name 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 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 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 string
The unique name of the resource.
args PluginArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

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

The Plugin resource accepts the following input properties:

ConfigJson string
plugin configuration in JSON format, configuration must be a valid JSON object.
ConsumerId string
Enabled bool
Name string
RouteId string
ServiceId string
StrictMatch bool
Tags List<string>
ConfigJson string
plugin configuration in JSON format, configuration must be a valid JSON object.
ConsumerId string
Enabled bool
Name string
RouteId string
ServiceId string
StrictMatch bool
Tags []string
configJson string
plugin configuration in JSON format, configuration must be a valid JSON object.
consumerId string
enabled boolean
name string
routeId string
serviceId string
strictMatch boolean
tags string[]
config_json str
plugin configuration in JSON format, configuration must be a valid JSON object.
consumer_id str
enabled bool
name str
route_id str
service_id str
strict_match bool
tags Sequence[str]

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.
computed_config str
id str
The provider-assigned unique ID for this managed resource.

Look up an 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)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

ComputedConfig string
ConfigJson string
plugin configuration in JSON format, configuration must be a valid JSON object.
ConsumerId string
Enabled bool
Name string
RouteId string
ServiceId string
StrictMatch bool
Tags List<string>
ComputedConfig string
ConfigJson string
plugin configuration in JSON format, configuration must be a valid JSON object.
ConsumerId string
Enabled bool
Name string
RouteId string
ServiceId string
StrictMatch bool
Tags []string
computedConfig string
configJson string
plugin configuration in JSON format, configuration must be a valid JSON object.
consumerId string
enabled boolean
name string
routeId string
serviceId string
strictMatch boolean
tags string[]
computed_config str
config_json str
plugin configuration in JSON format, configuration must be a valid JSON object.
consumer_id str
enabled bool
name str
route_id str
service_id str
strict_match bool
tags Sequence[str]

Import

To import a plugin

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

Package Details

Repository
https://github.com/pulumi/pulumi-kong
License
Apache-2.0
Notes
This Pulumi package is based on the kong Terraform Provider.