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

konnect.GatewayCustomPlugin

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
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,
                        config: Optional[Any] = None,
                        control_plane_id: Optional[str] = None,
                        consumer: Optional[GatewayCustomPluginConsumerArgs] = None,
                        consumer_group: Optional[GatewayCustomPluginConsumerGroupArgs] = None,
                        enabled: Optional[bool] = None,
                        instance_name: Optional[str] = None,
                        name: Optional[str] = None,
                        ordering: Optional[GatewayCustomPluginOrderingArgs] = None,
                        protocols: Optional[Sequence[str]] = None,
                        route: Optional[GatewayCustomPluginRouteArgs] = None,
                        service: Optional[GatewayCustomPluginServiceArgs] = None,
                        tags: Optional[Sequence[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.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayCustomPluginArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. GatewayCustomPluginArgs
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. GatewayCustomPluginArgs
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. 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()
{
    Config = "any",
    ControlPlaneId = "string",
    Consumer = new Konnect.Inputs.GatewayCustomPluginConsumerArgs
    {
        Id = "string",
    },
    ConsumerGroup = new Konnect.Inputs.GatewayCustomPluginConsumerGroupArgs
    {
        Id = "string",
    },
    Enabled = false,
    InstanceName = "string",
    Name = "string",
    Ordering = new Konnect.Inputs.GatewayCustomPluginOrderingArgs
    {
        After = new Konnect.Inputs.GatewayCustomPluginOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayCustomPluginOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayCustomPluginRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayCustomPluginServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayCustomPlugin(ctx, "gatewayCustomPluginResource", &konnect.GatewayCustomPluginArgs{
Config: pulumi.Any("any"),
ControlPlaneId: pulumi.String("string"),
Consumer: &.GatewayCustomPluginConsumerArgs{
Id: pulumi.String("string"),
},
ConsumerGroup: &.GatewayCustomPluginConsumerGroupArgs{
Id: pulumi.String("string"),
},
Enabled: pulumi.Bool(false),
InstanceName: pulumi.String("string"),
Name: pulumi.String("string"),
Ordering: &.GatewayCustomPluginOrderingArgs{
After: &.GatewayCustomPluginOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayCustomPluginOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayCustomPluginRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayCustomPluginServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayCustomPluginResource = new GatewayCustomPlugin("gatewayCustomPluginResource", GatewayCustomPluginArgs.builder()
    .config("any")
    .controlPlaneId("string")
    .consumer(GatewayCustomPluginConsumerArgs.builder()
        .id("string")
        .build())
    .consumerGroup(GatewayCustomPluginConsumerGroupArgs.builder()
        .id("string")
        .build())
    .enabled(false)
    .instanceName("string")
    .name("string")
    .ordering(GatewayCustomPluginOrderingArgs.builder()
        .after(GatewayCustomPluginOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayCustomPluginOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayCustomPluginRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayCustomPluginServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());
Copy
gateway_custom_plugin_resource = konnect.GatewayCustomPlugin("gatewayCustomPluginResource",
    config="any",
    control_plane_id="string",
    consumer={
        "id": "string",
    },
    consumer_group={
        "id": "string",
    },
    enabled=False,
    instance_name="string",
    name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])
Copy
const gatewayCustomPluginResource = new konnect.GatewayCustomPlugin("gatewayCustomPluginResource", {
    config: "any",
    controlPlaneId: "string",
    consumer: {
        id: "string",
    },
    consumerGroup: {
        id: "string",
    },
    enabled: false,
    instanceName: "string",
    name: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});
Copy
type: konnect:GatewayCustomPlugin
properties:
    config: any
    consumer:
        id: string
    consumerGroup:
        id: string
    controlPlaneId: string
    enabled: false
    instanceName: string
    name: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
Copy

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 This property is required. object
Configuration
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer 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
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.
Config This property is required. interface{}
Configuration
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Consumer 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
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.
config This property is required. Object
Configuration
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer 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
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.
config This property is required. any
Configuration
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer 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
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.
config This property is required. Any
Configuration
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer 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
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.
config This property is required. Any
Configuration
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
consumer Property Map
If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.
consumerGroup Property Map
enabled Boolean
Whether the plugin is applied.
instanceName String
name String
Plugin Name
ordering Property Map
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.

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.
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,
        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,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayCustomPluginRouteArgs] = None,
        service: Optional[GatewayCustomPluginServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = 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}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Config 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
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.
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
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.
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
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.
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
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.
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
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.
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
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.

Supporting Types

GatewayCustomPluginConsumer
, GatewayCustomPluginConsumerArgs

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

GatewayCustomPluginConsumerGroup
, GatewayCustomPluginConsumerGroupArgs

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 string[]
accesses Sequence[str]
accesses List<String>

GatewayCustomPluginOrderingBefore
, GatewayCustomPluginOrderingBeforeArgs

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

GatewayCustomPluginRoute
, GatewayCustomPluginRouteArgs

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

GatewayCustomPluginService
, GatewayCustomPluginServiceArgs

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 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect