Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Konnect Provider
  4. API Docs
  5. GatewayCustomPlugin
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

konnect.GatewayCustomPlugin

konnect
Viewing docs for konnect 3.28.0
published on Friday, Nov 6, 2026 by kong
Schema (JSON)
kong/terraform-provider-konnect

    Gateway Custom Plugin Resource

    Create GatewayCustomPlugin Resource

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

    Constructor syntax

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

@overload
def GatewayCustomPlugin(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        control_plane_id: Optional[str] = None,
                        config: Optional[Any] = None,
                        instance_name: Optional[str] = None,
                        consumer_group: Optional[GatewayCustomPluginConsumerGroupArgs] = None,
                        consumer: Optional[GatewayCustomPluginConsumerArgs] = None,
                        enabled: Optional[bool] = None,
                        condition: Optional[str] = None,
                        name: Optional[str] = None,
                        ordering: Optional[GatewayCustomPluginOrderingArgs] = None,
                        partials: Optional[Sequence[GatewayCustomPluginPartialArgs]] = None,
                        protocols: Optional[Sequence[str]] = None,
                        route: Optional[GatewayCustomPluginRouteArgs] = None,
                        service: Optional[GatewayCustomPluginServiceArgs] = None,
                        tags: Optional[Sequence[str]] = None,
                        workspace: Optional[str] = None)
    func NewGatewayCustomPlugin(ctx *Context, name string, args GatewayCustomPluginArgs, opts ...ResourceOption) (*GatewayCustomPlugin, error)
    public GatewayCustomPlugin(string name, GatewayCustomPluginArgs args, CustomResourceOptions? opts = null)
    public GatewayCustomPlugin(String name, GatewayCustomPluginArgs args)
public GatewayCustomPlugin(String name, GatewayCustomPluginArgs args, CustomResourceOptions options)

    type: konnect:GatewayCustomPlugin
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "konnect_gateway_custom_plugin" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args GatewayCustomPluginArgs
    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 GatewayCustomPluginArgs
    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 GatewayCustomPluginArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayCustomPluginArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayCustomPluginArgs
    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 gatewayCustomPluginResource = new Konnect.GatewayCustomPlugin("gatewayCustomPluginResource", new()
{
    ControlPlaneId = "string",
    Config = "any",
    InstanceName = "string",
    ConsumerGroup = new Konnect.Inputs.GatewayCustomPluginConsumerGroupArgs
    {
        Id = "string",
    },
    Consumer = new Konnect.Inputs.GatewayCustomPluginConsumerArgs
    {
        Id = "string",
    },
    Enabled = false,
    Condition = "string",
    Name = "string",
    Ordering = new Konnect.Inputs.GatewayCustomPluginOrderingArgs
    {
        After = new Konnect.Inputs.GatewayCustomPluginOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayCustomPluginOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Partials = new[]
    {
        new Konnect.Inputs.GatewayCustomPluginPartialArgs
        {
            Id = "string",
            Name = "string",
            Path = "string",
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayCustomPluginRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayCustomPluginServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    Workspace = "string",
});

    example, err := konnect.NewGatewayCustomPlugin(ctx, "gatewayCustomPluginResource", &konnect.GatewayCustomPluginArgs{
	ControlPlaneId: pulumi.String("string"),
	Config:         pulumi.Any("any"),
	InstanceName:   pulumi.String("string"),
	ConsumerGroup: &konnect.GatewayCustomPluginConsumerGroupArgs{
		Id: pulumi.String("string"),
	},
	Consumer: &konnect.GatewayCustomPluginConsumerArgs{
		Id: pulumi.String("string"),
	},
	Enabled:   pulumi.Bool(false),
	Condition: pulumi.String("string"),
	Name:      pulumi.String("string"),
	Ordering: &konnect.GatewayCustomPluginOrderingArgs{
		After: &konnect.GatewayCustomPluginOrderingAfterArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
		Before: &konnect.GatewayCustomPluginOrderingBeforeArgs{
			Accesses: pulumi.StringArray{
				pulumi.String("string"),
			},
		},
	},
	Partials: konnect.GatewayCustomPluginPartialArray{
		&konnect.GatewayCustomPluginPartialArgs{
			Id:   pulumi.String("string"),
			Name: pulumi.String("string"),
			Path: pulumi.String("string"),
		},
	},
	Protocols: pulumi.StringArray{
		pulumi.String("string"),
	},
	Route: &konnect.GatewayCustomPluginRouteArgs{
		Id: pulumi.String("string"),
	},
	Service: &konnect.GatewayCustomPluginServiceArgs{
		Id: pulumi.String("string"),
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	Workspace: pulumi.String("string"),
})

    resource "konnect_gateway_custom_plugin" "gatewayCustomPluginResource" {
  lifecycle {
    create_before_destroy = true
  }
  control_plane_id = "string"
  config           = "any"
  instance_name    = "string"
  consumer_group = {
    id = "string"
  }
  consumer = {
    id = "string"
  }
  enabled   = false
  condition = "string"
  name      = "string"
  ordering = {
    after = {
      accesses = ["string"]
    }
    before = {
      accesses = ["string"]
    }
  }
  partials {
    id   = "string"
    name = "string"
    path = "string"
  }
  protocols = ["string"]
  route = {
    id = "string"
  }
  service = {
    id = "string"
  }
  tags      = ["string"]
  workspace = "string"
}

    var gatewayCustomPluginResource = new GatewayCustomPlugin("gatewayCustomPluginResource", GatewayCustomPluginArgs.builder()
    .controlPlaneId("string")
    .config("any")
    .instanceName("string")
    .consumerGroup(GatewayCustomPluginConsumerGroupArgs.builder()
        .id("string")
        .build())
    .consumer(GatewayCustomPluginConsumerArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .condition("string")
    .name("string")
    .ordering(GatewayCustomPluginOrderingArgs.builder()
        .after(GatewayCustomPluginOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayCustomPluginOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .partials(GatewayCustomPluginPartialArgs.builder()
        .id("string")
        .name("string")
        .path("string")
        .build())
    .protocols("string")
    .route(GatewayCustomPluginRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayCustomPluginServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .workspace("string")
    .build());

    gateway_custom_plugin_resource = konnect.GatewayCustomPlugin("gatewayCustomPluginResource",
    control_plane_id="string",
    config="any",
    instance_name="string",
    consumer_group={
        "id": "string",
    },
    consumer={
        "id": "string",
    },
    enabled=False,
    condition="string",
    name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    partials=[{
        "id": "string",
        "name": "string",
        "path": "string",
    }],
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    workspace="string")

    const gatewayCustomPluginResource = new konnect.GatewayCustomPlugin("gatewayCustomPluginResource", {
    controlPlaneId: "string",
    config: "any",
    instanceName: "string",
    consumerGroup: {
        id: "string",
    },
    consumer: {
        id: "string",
    },
    enabled: false,
    condition: "string",
    name: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    partials: [{
        id: "string",
        name: "string",
        path: "string",
    }],
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    workspace: "string",
});

    type: konnect:GatewayCustomPlugin
properties:
    condition: string
    config: any
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    instanceName: string
    name: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    partials:
        - id: string
          name: string
          path: string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    workspace: string

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

    Config object
    Configuration
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    Consumer GatewayCustomPluginConsumer
    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 GatewayCustomPluginConsumerGroup
    Enabled bool
    Whether the plugin is applied.
    InstanceName string
    Name string
    Plugin Name
    Ordering GatewayCustomPluginOrdering
    Partials List<GatewayCustomPluginPartial>
    A list of partials to be used by the plugin.
    Protocols List<string>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    Route GatewayCustomPluginRoute
    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 GatewayCustomPluginService
    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.
    Workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    Config interface{}
    Configuration
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    Consumer GatewayCustomPluginConsumerArgs
    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 GatewayCustomPluginConsumerGroupArgs
    Enabled bool
    Whether the plugin is applied.
    InstanceName string
    Name string
    Plugin Name
    Ordering GatewayCustomPluginOrderingArgs
    Partials []GatewayCustomPluginPartialArgs
    A list of partials to be used by the plugin.
    Protocols []string
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    Route GatewayCustomPluginRouteArgs
    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 GatewayCustomPluginServiceArgs
    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.
    Workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    config any
    Configuration
    control_plane_id string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    consumer object
    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 object
    enabled bool
    Whether the plugin is applied.
    instance_name string
    name string
    Plugin Name
    ordering object
    partials list(object)
    A list of partials to be used by the plugin.
    protocols list(string)
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route object
    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 object
    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.
    workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    config Object
    Configuration
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    condition String
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    consumer GatewayCustomPluginConsumer
    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 GatewayCustomPluginConsumerGroup
    enabled Boolean
    Whether the plugin is applied.
    instanceName String
    name String
    Plugin Name
    ordering GatewayCustomPluginOrdering
    partials List<GatewayCustomPluginPartial>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route GatewayCustomPluginRoute
    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 GatewayCustomPluginService
    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.
    workspace String
    The name of the workspace. Default: "default"; Requires replacement if changed.
    config any
    Configuration
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    consumer GatewayCustomPluginConsumer
    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 GatewayCustomPluginConsumerGroup
    enabled boolean
    Whether the plugin is applied.
    instanceName string
    name string
    Plugin Name
    ordering GatewayCustomPluginOrdering
    partials GatewayCustomPluginPartial[]
    A list of partials to be used by the plugin.
    protocols string[]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route GatewayCustomPluginRoute
    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 GatewayCustomPluginService
    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.
    workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    config Any
    Configuration
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    condition str
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    consumer GatewayCustomPluginConsumerArgs
    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 GatewayCustomPluginConsumerGroupArgs
    enabled bool
    Whether the plugin is applied.
    instance_name str
    name str
    Plugin Name
    ordering GatewayCustomPluginOrderingArgs
    partials Sequence[GatewayCustomPluginPartialArgs]
    A list of partials to be used by the plugin.
    protocols Sequence[str]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route GatewayCustomPluginRouteArgs
    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 GatewayCustomPluginServiceArgs
    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.
    workspace str
    The name of the workspace. Default: "default"; Requires replacement if changed.
    config Any
    Configuration
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    condition String
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    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
    enabled Boolean
    Whether the plugin is applied.
    instanceName String
    name String
    Plugin Name
    ordering Property Map
    partials List<Property Map>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    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.
    workspace String
    The name of the workspace. Default: "default"; Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayCustomPlugin 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.
    created_at number
    Unix epoch when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at number
    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 GatewayCustomPlugin Resource

    Get an existing GatewayCustomPlugin 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?: GatewayCustomPluginState, opts?: CustomResourceOptions): GatewayCustomPlugin
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        condition: Optional[str] = None,
        config: Optional[Any] = None,
        consumer: Optional[GatewayCustomPluginConsumerArgs] = None,
        consumer_group: Optional[GatewayCustomPluginConsumerGroupArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        instance_name: Optional[str] = None,
        name: Optional[str] = None,
        ordering: Optional[GatewayCustomPluginOrderingArgs] = None,
        partials: Optional[Sequence[GatewayCustomPluginPartialArgs]] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayCustomPluginRouteArgs] = None,
        service: Optional[GatewayCustomPluginServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None,
        workspace: Optional[str] = None) -> GatewayCustomPlugin
    func GetGatewayCustomPlugin(ctx *Context, name string, id IDInput, state *GatewayCustomPluginState, opts ...ResourceOption) (*GatewayCustomPlugin, error)
    public static GatewayCustomPlugin Get(string name, Input<string> id, GatewayCustomPluginState? state, CustomResourceOptions? opts = null)
    public static GatewayCustomPlugin get(String name, Output<String> id, GatewayCustomPluginState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayCustomPlugin    get:      id: ${id}
    import {
  to = konnect_gateway_custom_plugin.example
  id = "${id}"
}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    Config object
    Configuration
    Consumer GatewayCustomPluginConsumer
    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 GatewayCustomPluginConsumerGroup
    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.
    InstanceName string
    Name string
    Plugin Name
    Ordering GatewayCustomPluginOrdering
    Partials List<GatewayCustomPluginPartial>
    A list of partials to be used by the plugin.
    Protocols List<string>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    Route GatewayCustomPluginRoute
    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 GatewayCustomPluginService
    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.
    Workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    Condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    Config interface{}
    Configuration
    Consumer GatewayCustomPluginConsumerArgs
    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 GatewayCustomPluginConsumerGroupArgs
    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.
    InstanceName string
    Name string
    Plugin Name
    Ordering GatewayCustomPluginOrderingArgs
    Partials []GatewayCustomPluginPartialArgs
    A list of partials to be used by the plugin.
    Protocols []string
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    Route GatewayCustomPluginRouteArgs
    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 GatewayCustomPluginServiceArgs
    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.
    Workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    config any
    Configuration
    consumer object
    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 object
    control_plane_id string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    created_at number
    Unix epoch when the resource was created.
    enabled bool
    Whether the plugin is applied.
    instance_name string
    name string
    Plugin Name
    ordering object
    partials list(object)
    A list of partials to be used by the plugin.
    protocols list(string)
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route object
    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 object
    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.
    updated_at number
    Unix epoch when the resource was last updated.
    workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    condition String
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    config Object
    Configuration
    consumer GatewayCustomPluginConsumer
    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 GatewayCustomPluginConsumerGroup
    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.
    instanceName String
    name String
    Plugin Name
    ordering GatewayCustomPluginOrdering
    partials List<GatewayCustomPluginPartial>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route GatewayCustomPluginRoute
    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 GatewayCustomPluginService
    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.
    workspace String
    The name of the workspace. Default: "default"; Requires replacement if changed.
    condition string
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    config any
    Configuration
    consumer GatewayCustomPluginConsumer
    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 GatewayCustomPluginConsumerGroup
    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.
    instanceName string
    name string
    Plugin Name
    ordering GatewayCustomPluginOrdering
    partials GatewayCustomPluginPartial[]
    A list of partials to be used by the plugin.
    protocols string[]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route GatewayCustomPluginRoute
    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 GatewayCustomPluginService
    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.
    workspace string
    The name of the workspace. Default: "default"; Requires replacement if changed.
    condition str
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    config Any
    Configuration
    consumer GatewayCustomPluginConsumerArgs
    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 GatewayCustomPluginConsumerGroupArgs
    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.
    instance_name str
    name str
    Plugin Name
    ordering GatewayCustomPluginOrderingArgs
    partials Sequence[GatewayCustomPluginPartialArgs]
    A list of partials to be used by the plugin.
    protocols Sequence[str]
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    route GatewayCustomPluginRouteArgs
    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 GatewayCustomPluginServiceArgs
    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.
    workspace str
    The name of the workspace. Default: "default"; Requires replacement if changed.
    condition String
    An expression used for conditional control over plugin execution. If the expression evaluates to true during the request flow, the plugin is executed; otherwise, it is skipped.
    config Any
    Configuration
    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
    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.
    instanceName String
    name String
    Plugin Name
    ordering Property Map
    partials List<Property Map>
    A list of partials to be used by the plugin.
    protocols List<String>
    A list of the request protocols that will trigger this plugin. The default value, as well as the possible values allowed on this field, may change depending on the plugin type. For example, plugins that only work in stream mode will only support "tcp" and "tls".
    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.
    workspace String
    The name of the workspace. Default: "default"; Requires replacement if changed.

    Supporting Types

    GatewayCustomPluginConsumer, GatewayCustomPluginConsumerArgs

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

    GatewayCustomPluginConsumerGroup, GatewayCustomPluginConsumerGroupArgs

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

    GatewayCustomPluginOrdering, GatewayCustomPluginOrderingArgs

    GatewayCustomPluginOrderingAfter, GatewayCustomPluginOrderingAfterArgs

    Accesses List<string>
    Accesses []string
    accesses list(string)
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GatewayCustomPluginOrderingBefore, GatewayCustomPluginOrderingBeforeArgs

    Accesses List<string>
    Accesses []string
    accesses list(string)
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GatewayCustomPluginPartial, GatewayCustomPluginPartialArgs

    Id string
    A string representing a UUID (universally unique identifier).
    Name string
    A unique string representing a UTF-8 encoded name.
    Path string
    Not Null
    Id string
    A string representing a UUID (universally unique identifier).
    Name string
    A unique string representing a UTF-8 encoded name.
    Path string
    Not Null
    id string
    A string representing a UUID (universally unique identifier).
    name string
    A unique string representing a UTF-8 encoded name.
    path string
    Not Null
    id String
    A string representing a UUID (universally unique identifier).
    name String
    A unique string representing a UTF-8 encoded name.
    path String
    Not Null
    id string
    A string representing a UUID (universally unique identifier).
    name string
    A unique string representing a UTF-8 encoded name.
    path string
    Not Null
    id str
    A string representing a UUID (universally unique identifier).
    name str
    A unique string representing a UTF-8 encoded name.
    path str
    Not Null
    id String
    A string representing a UUID (universally unique identifier).
    name String
    A unique string representing a UTF-8 encoded name.
    path String
    Not Null

    GatewayCustomPluginRoute, GatewayCustomPluginRouteArgs

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

    GatewayCustomPluginService, GatewayCustomPluginServiceArgs

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

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect
    Viewing docs for konnect 3.28.0
    published on Friday, Nov 6, 2026 by kong
    Schema (JSON)
    kong/terraform-provider-konnect

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial