Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayCustomPluginSchema
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayCustomPluginSchema

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

GatewayCustomPluginSchema Resource

Example Usage

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

const myGatewaycustompluginschema = new konnect.GatewayCustomPluginSchema("myGatewaycustompluginschema", {
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    luaSchema: "return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewaycustompluginschema = konnect.GatewayCustomPluginSchema("myGatewaycustompluginschema",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    lua_schema="return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v2/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewGatewayCustomPluginSchema(ctx, "myGatewaycustompluginschema", &konnect.GatewayCustomPluginSchemaArgs{
			ControlPlaneId: pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			LuaSchema:      pulumi.String("return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewaycustompluginschema = new Konnect.GatewayCustomPluginSchema("myGatewaycustompluginschema", new()
    {
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        LuaSchema = "return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayCustomPluginSchema;
import com.pulumi.konnect.GatewayCustomPluginSchemaArgs;
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 myGatewaycustompluginschema = new GatewayCustomPluginSchema("myGatewaycustompluginschema", GatewayCustomPluginSchemaArgs.builder()
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .luaSchema("return { name = \\\"myplugin\\\", fields = { { config = { type = \\\"record\\\", fields = { } } } } }")
            .build());

    }
}
Copy
resources:
  myGatewaycustompluginschema:
    type: konnect:GatewayCustomPluginSchema
    properties:
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      luaSchema: return { name = \"myplugin\", fields = { { config = { type = \"record\", fields = { } } } } }
Copy

Create GatewayCustomPluginSchema Resource

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

Constructor syntax

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

@overload
def GatewayCustomPluginSchema(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              control_plane_id: Optional[str] = None,
                              lua_schema: Optional[str] = None)
func NewGatewayCustomPluginSchema(ctx *Context, name string, args GatewayCustomPluginSchemaArgs, opts ...ResourceOption) (*GatewayCustomPluginSchema, error)
public GatewayCustomPluginSchema(string name, GatewayCustomPluginSchemaArgs args, CustomResourceOptions? opts = null)
public GatewayCustomPluginSchema(String name, GatewayCustomPluginSchemaArgs args)
public GatewayCustomPluginSchema(String name, GatewayCustomPluginSchemaArgs args, CustomResourceOptions options)

type: konnect:GatewayCustomPluginSchema
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. GatewayCustomPluginSchemaArgs
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. GatewayCustomPluginSchemaArgs
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. GatewayCustomPluginSchemaArgs
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. GatewayCustomPluginSchemaArgs
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. GatewayCustomPluginSchemaArgs
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 gatewayCustomPluginSchemaResource = new Konnect.GatewayCustomPluginSchema("gatewayCustomPluginSchemaResource", new()
{
    ControlPlaneId = "string",
    LuaSchema = "string",
});
Copy
example, err := konnect.NewGatewayCustomPluginSchema(ctx, "gatewayCustomPluginSchemaResource", &konnect.GatewayCustomPluginSchemaArgs{
ControlPlaneId: pulumi.String("string"),
LuaSchema: pulumi.String("string"),
})
Copy
var gatewayCustomPluginSchemaResource = new GatewayCustomPluginSchema("gatewayCustomPluginSchemaResource", GatewayCustomPluginSchemaArgs.builder()
    .controlPlaneId("string")
    .luaSchema("string")
    .build());
Copy
gateway_custom_plugin_schema_resource = konnect.GatewayCustomPluginSchema("gatewayCustomPluginSchemaResource",
    control_plane_id="string",
    lua_schema="string")
Copy
const gatewayCustomPluginSchemaResource = new konnect.GatewayCustomPluginSchema("gatewayCustomPluginSchemaResource", {
    controlPlaneId: "string",
    luaSchema: "string",
});
Copy
type: konnect:GatewayCustomPluginSchema
properties:
    controlPlaneId: string
    luaSchema: string
Copy

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

ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
LuaSchema This property is required. string
The custom plugin schema; jq -Rs '.' schema.lua.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
LuaSchema This property is required. string
The custom plugin schema; jq -Rs '.' schema.lua.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
luaSchema This property is required. String
The custom plugin schema; jq -Rs '.' schema.lua.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
luaSchema This property is required. string
The custom plugin schema; jq -Rs '.' schema.lua.
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.
lua_schema This property is required. str
The custom plugin schema; jq -Rs '.' schema.lua.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
luaSchema This property is required. String
The custom plugin schema; jq -Rs '.' schema.lua.

Outputs

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

CreatedAt double
An ISO-8604 timestamp representation of custom plugin schema creation date.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The custom plugin name determined by the custom plugin schema.
UpdatedAt double
An ISO-8604 timestamp representation of custom plugin schema update date.
CreatedAt float64
An ISO-8604 timestamp representation of custom plugin schema creation date.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The custom plugin name determined by the custom plugin schema.
UpdatedAt float64
An ISO-8604 timestamp representation of custom plugin schema update date.
createdAt Double
An ISO-8604 timestamp representation of custom plugin schema creation date.
id String
The provider-assigned unique ID for this managed resource.
name String
The custom plugin name determined by the custom plugin schema.
updatedAt Double
An ISO-8604 timestamp representation of custom plugin schema update date.
createdAt number
An ISO-8604 timestamp representation of custom plugin schema creation date.
id string
The provider-assigned unique ID for this managed resource.
name string
The custom plugin name determined by the custom plugin schema.
updatedAt number
An ISO-8604 timestamp representation of custom plugin schema update date.
created_at float
An ISO-8604 timestamp representation of custom plugin schema creation date.
id str
The provider-assigned unique ID for this managed resource.
name str
The custom plugin name determined by the custom plugin schema.
updated_at float
An ISO-8604 timestamp representation of custom plugin schema update date.
createdAt Number
An ISO-8604 timestamp representation of custom plugin schema creation date.
id String
The provider-assigned unique ID for this managed resource.
name String
The custom plugin name determined by the custom plugin schema.
updatedAt Number
An ISO-8604 timestamp representation of custom plugin schema update date.

Look up Existing GatewayCustomPluginSchema Resource

Get an existing GatewayCustomPluginSchema 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?: GatewayCustomPluginSchemaState, opts?: CustomResourceOptions): GatewayCustomPluginSchema
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        lua_schema: Optional[str] = None,
        name: Optional[str] = None,
        updated_at: Optional[float] = None) -> GatewayCustomPluginSchema
func GetGatewayCustomPluginSchema(ctx *Context, name string, id IDInput, state *GatewayCustomPluginSchemaState, opts ...ResourceOption) (*GatewayCustomPluginSchema, error)
public static GatewayCustomPluginSchema Get(string name, Input<string> id, GatewayCustomPluginSchemaState? state, CustomResourceOptions? opts = null)
public static GatewayCustomPluginSchema get(String name, Output<String> id, GatewayCustomPluginSchemaState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayCustomPluginSchema    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:
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double
An ISO-8604 timestamp representation of custom plugin schema creation date.
LuaSchema string
The custom plugin schema; jq -Rs '.' schema.lua.
Name string
The custom plugin name determined by the custom plugin schema.
UpdatedAt double
An ISO-8604 timestamp representation of custom plugin schema update date.
ControlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64
An ISO-8604 timestamp representation of custom plugin schema creation date.
LuaSchema string
The custom plugin schema; jq -Rs '.' schema.lua.
Name string
The custom plugin name determined by the custom plugin schema.
UpdatedAt float64
An ISO-8604 timestamp representation of custom plugin schema update date.
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double
An ISO-8604 timestamp representation of custom plugin schema creation date.
luaSchema String
The custom plugin schema; jq -Rs '.' schema.lua.
name String
The custom plugin name determined by the custom plugin schema.
updatedAt Double
An ISO-8604 timestamp representation of custom plugin schema update date.
controlPlaneId string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number
An ISO-8604 timestamp representation of custom plugin schema creation date.
luaSchema string
The custom plugin schema; jq -Rs '.' schema.lua.
name string
The custom plugin name determined by the custom plugin schema.
updatedAt number
An ISO-8604 timestamp representation of custom plugin schema update date.
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
An ISO-8604 timestamp representation of custom plugin schema creation date.
lua_schema str
The custom plugin schema; jq -Rs '.' schema.lua.
name str
The custom plugin name determined by the custom plugin schema.
updated_at float
An ISO-8604 timestamp representation of custom plugin schema update date.
controlPlaneId String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number
An ISO-8604 timestamp representation of custom plugin schema creation date.
luaSchema String
The custom plugin schema; jq -Rs '.' schema.lua.
name String
The custom plugin name determined by the custom plugin schema.
updatedAt Number
An ISO-8604 timestamp representation of custom plugin schema update date.

Import

$ pulumi import konnect:index/gatewayCustomPluginSchema:GatewayCustomPluginSchema my_konnect_gateway_custom_plugin_schema "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"name\": \"myplugin\"}"
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.
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect