Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayPluginKeyAuth
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayPluginKeyAuth

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayPluginKeyAuth Resource

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginKeyAuth;
import com.pulumi.konnect.GatewayPluginKeyAuthArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthServiceArgs;
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 myGatewaypluginkeyauth = new GatewayPluginKeyAuth("myGatewaypluginkeyauth", GatewayPluginKeyAuthArgs.builder()
            .config(GatewayPluginKeyAuthConfigArgs.builder()
                .anonymous("...my_anonymous...")
                .hide_credentials(false)
                .key_in_body(false)
                .key_in_header(false)
                .key_in_query(true)
                .key_names("...")
                .realm("...my_realm...")
                .run_on_preflight(false)
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(5)
            .enabled(true)
            .gatewayPluginKeyAuthId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginKeyAuthOrderingArgs.builder()
                .after(GatewayPluginKeyAuthOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginKeyAuthOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("https")
            .route(GatewayPluginKeyAuthRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginKeyAuthServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .updatedAt(0)
            .build());

    }
}
Copy
resources:
  myGatewaypluginkeyauth:
    type: konnect:GatewayPluginKeyAuth
    properties:
      config:
        anonymous: '...my_anonymous...'
        hide_credentials: false
        key_in_body: false
        key_in_header: false
        key_in_query: true
        key_names:
          - '...'
        realm: '...my_realm...'
        run_on_preflight: false
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 5
      enabled: true
      gatewayPluginKeyAuthId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - https
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'
      updatedAt: 0
Copy

Create GatewayPluginKeyAuth Resource

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

Constructor syntax

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

@overload
def GatewayPluginKeyAuth(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         control_plane_id: Optional[str] = None,
                         config: Optional[GatewayPluginKeyAuthConfigArgs] = None,
                         created_at: Optional[float] = None,
                         enabled: Optional[bool] = None,
                         gateway_plugin_key_auth_id: Optional[str] = None,
                         instance_name: Optional[str] = None,
                         ordering: Optional[GatewayPluginKeyAuthOrderingArgs] = None,
                         protocols: Optional[Sequence[str]] = None,
                         route: Optional[GatewayPluginKeyAuthRouteArgs] = None,
                         service: Optional[GatewayPluginKeyAuthServiceArgs] = None,
                         tags: Optional[Sequence[str]] = None,
                         updated_at: Optional[float] = None)
func NewGatewayPluginKeyAuth(ctx *Context, name string, args GatewayPluginKeyAuthArgs, opts ...ResourceOption) (*GatewayPluginKeyAuth, error)
public GatewayPluginKeyAuth(string name, GatewayPluginKeyAuthArgs args, CustomResourceOptions? opts = null)
public GatewayPluginKeyAuth(String name, GatewayPluginKeyAuthArgs args)
public GatewayPluginKeyAuth(String name, GatewayPluginKeyAuthArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginKeyAuth
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. GatewayPluginKeyAuthArgs
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. GatewayPluginKeyAuthArgs
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. GatewayPluginKeyAuthArgs
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. GatewayPluginKeyAuthArgs
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. GatewayPluginKeyAuthArgs
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 gatewayPluginKeyAuthResource = new Konnect.GatewayPluginKeyAuth("gatewayPluginKeyAuthResource", new()
{
    ControlPlaneId = "string",
    Config = new Konnect.Inputs.GatewayPluginKeyAuthConfigArgs
    {
        Anonymous = "string",
        HideCredentials = false,
        KeyInBody = false,
        KeyInHeader = false,
        KeyInQuery = false,
        KeyNames = new[]
        {
            "string",
        },
        Realm = "string",
        RunOnPreflight = false,
    },
    CreatedAt = 0,
    Enabled = false,
    GatewayPluginKeyAuthId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginKeyAuthOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginKeyAuthOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginKeyAuthOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginKeyAuthRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginKeyAuthServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
    UpdatedAt = 0,
});
Copy
example, err := konnect.NewGatewayPluginKeyAuth(ctx, "gatewayPluginKeyAuthResource", &konnect.GatewayPluginKeyAuthArgs{
ControlPlaneId: pulumi.String("string"),
Config: &.GatewayPluginKeyAuthConfigArgs{
Anonymous: pulumi.String("string"),
HideCredentials: pulumi.Bool(false),
KeyInBody: pulumi.Bool(false),
KeyInHeader: pulumi.Bool(false),
KeyInQuery: pulumi.Bool(false),
KeyNames: pulumi.StringArray{
pulumi.String("string"),
},
Realm: pulumi.String("string"),
RunOnPreflight: pulumi.Bool(false),
},
CreatedAt: pulumi.Float64(0),
Enabled: pulumi.Bool(false),
GatewayPluginKeyAuthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginKeyAuthOrderingArgs{
After: &.GatewayPluginKeyAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginKeyAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginKeyAuthRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginKeyAuthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
UpdatedAt: pulumi.Float64(0),
})
Copy
var gatewayPluginKeyAuthResource = new GatewayPluginKeyAuth("gatewayPluginKeyAuthResource", GatewayPluginKeyAuthArgs.builder()
    .controlPlaneId("string")
    .config(GatewayPluginKeyAuthConfigArgs.builder()
        .anonymous("string")
        .hideCredentials(false)
        .keyInBody(false)
        .keyInHeader(false)
        .keyInQuery(false)
        .keyNames("string")
        .realm("string")
        .runOnPreflight(false)
        .build())
    .createdAt(0)
    .enabled(false)
    .gatewayPluginKeyAuthId("string")
    .instanceName("string")
    .ordering(GatewayPluginKeyAuthOrderingArgs.builder()
        .after(GatewayPluginKeyAuthOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginKeyAuthOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginKeyAuthRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginKeyAuthServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .updatedAt(0)
    .build());
Copy
gateway_plugin_key_auth_resource = konnect.GatewayPluginKeyAuth("gatewayPluginKeyAuthResource",
    control_plane_id="string",
    config={
        "anonymous": "string",
        "hide_credentials": False,
        "key_in_body": False,
        "key_in_header": False,
        "key_in_query": False,
        "key_names": ["string"],
        "realm": "string",
        "run_on_preflight": False,
    },
    created_at=0,
    enabled=False,
    gateway_plugin_key_auth_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"],
    updated_at=0)
Copy
const gatewayPluginKeyAuthResource = new konnect.GatewayPluginKeyAuth("gatewayPluginKeyAuthResource", {
    controlPlaneId: "string",
    config: {
        anonymous: "string",
        hideCredentials: false,
        keyInBody: false,
        keyInHeader: false,
        keyInQuery: false,
        keyNames: ["string"],
        realm: "string",
        runOnPreflight: false,
    },
    createdAt: 0,
    enabled: false,
    gatewayPluginKeyAuthId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
    updatedAt: 0,
});
Copy
type: konnect:GatewayPluginKeyAuth
properties:
    config:
        anonymous: string
        hideCredentials: false
        keyInBody: false
        keyInHeader: false
        keyInQuery: false
        keyNames:
            - string
        realm: string
        runOnPreflight: false
    controlPlaneId: string
    createdAt: 0
    enabled: false
    gatewayPluginKeyAuthId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string
    updatedAt: 0
Copy

GatewayPluginKeyAuth 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 GatewayPluginKeyAuth 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.
Config GatewayPluginKeyAuthConfig
CreatedAt double
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginKeyAuthId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthOrdering
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 GatewayPluginKeyAuthRoute
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 GatewayPluginKeyAuthService
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.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Config GatewayPluginKeyAuthConfigArgs
CreatedAt float64
Unix epoch when the resource was created.
Enabled bool
Whether the plugin is applied.
GatewayPluginKeyAuthId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthOrderingArgs
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 GatewayPluginKeyAuthRouteArgs
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 GatewayPluginKeyAuthServiceArgs
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.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginKeyAuthConfig
createdAt Double
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginKeyAuthId String
The ID of this resource.
instanceName String
ordering GatewayPluginKeyAuthOrdering
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 GatewayPluginKeyAuthRoute
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 GatewayPluginKeyAuthService
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.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config GatewayPluginKeyAuthConfig
createdAt number
Unix epoch when the resource was created.
enabled boolean
Whether the plugin is applied.
gatewayPluginKeyAuthId string
The ID of this resource.
instanceName string
ordering GatewayPluginKeyAuthOrdering
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 GatewayPluginKeyAuthRoute
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 GatewayPluginKeyAuthService
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.
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.
config GatewayPluginKeyAuthConfigArgs
created_at float
Unix epoch when the resource was created.
enabled bool
Whether the plugin is applied.
gateway_plugin_key_auth_id str
The ID of this resource.
instance_name str
ordering GatewayPluginKeyAuthOrderingArgs
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 GatewayPluginKeyAuthRouteArgs
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 GatewayPluginKeyAuthServiceArgs
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.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
config Property Map
createdAt Number
Unix epoch when the resource was created.
enabled Boolean
Whether the plugin is applied.
gatewayPluginKeyAuthId String
The ID of this resource.
instanceName String
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.

Outputs

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

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

Look up Existing GatewayPluginKeyAuth Resource

Get an existing GatewayPluginKeyAuth 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?: GatewayPluginKeyAuthState, opts?: CustomResourceOptions): GatewayPluginKeyAuth
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginKeyAuthConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_key_auth_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginKeyAuthOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginKeyAuthRouteArgs] = None,
        service: Optional[GatewayPluginKeyAuthServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginKeyAuth
func GetGatewayPluginKeyAuth(ctx *Context, name string, id IDInput, state *GatewayPluginKeyAuthState, opts ...ResourceOption) (*GatewayPluginKeyAuth, error)
public static GatewayPluginKeyAuth Get(string name, Input<string> id, GatewayPluginKeyAuthState? state, CustomResourceOptions? opts = null)
public static GatewayPluginKeyAuth get(String name, Output<String> id, GatewayPluginKeyAuthState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayPluginKeyAuth    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 GatewayPluginKeyAuthConfig
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.
GatewayPluginKeyAuthId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthOrdering
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 GatewayPluginKeyAuthRoute
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 GatewayPluginKeyAuthService
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 GatewayPluginKeyAuthConfigArgs
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.
GatewayPluginKeyAuthId string
The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthOrderingArgs
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 GatewayPluginKeyAuthRouteArgs
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 GatewayPluginKeyAuthServiceArgs
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 GatewayPluginKeyAuthConfig
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.
gatewayPluginKeyAuthId String
The ID of this resource.
instanceName String
ordering GatewayPluginKeyAuthOrdering
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 GatewayPluginKeyAuthRoute
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 GatewayPluginKeyAuthService
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 GatewayPluginKeyAuthConfig
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.
gatewayPluginKeyAuthId string
The ID of this resource.
instanceName string
ordering GatewayPluginKeyAuthOrdering
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 GatewayPluginKeyAuthRoute
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 GatewayPluginKeyAuthService
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 GatewayPluginKeyAuthConfigArgs
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.
gateway_plugin_key_auth_id str
The ID of this resource.
instance_name str
ordering GatewayPluginKeyAuthOrderingArgs
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 GatewayPluginKeyAuthRouteArgs
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 GatewayPluginKeyAuthServiceArgs
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 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.
gatewayPluginKeyAuthId String
The ID of this resource.
instanceName String
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

GatewayPluginKeyAuthConfig
, GatewayPluginKeyAuthConfigArgs

Anonymous string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx.
HideCredentials bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request.
KeyInBody bool
If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
KeyInHeader bool
If enabled (default), the plugin reads the request header and tries to find the key in it.
KeyInQuery bool
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
KeyNames List<string>
Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
Realm string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RunOnPreflight bool
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.
Anonymous string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx.
HideCredentials bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request.
KeyInBody bool
If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
KeyInHeader bool
If enabled (default), the plugin reads the request header and tries to find the key in it.
KeyInQuery bool
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
KeyNames []string
Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
Realm string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
RunOnPreflight bool
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.
anonymous String
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx.
hideCredentials Boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request.
keyInBody Boolean
If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
keyInHeader Boolean
If enabled (default), the plugin reads the request header and tries to find the key in it.
keyInQuery Boolean
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
keyNames List<String>
Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
realm String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight Boolean
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.
anonymous string
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx.
hideCredentials boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request.
keyInBody boolean
If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
keyInHeader boolean
If enabled (default), the plugin reads the request header and tries to find the key in it.
keyInQuery boolean
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
keyNames string[]
Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
realm string
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight boolean
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.
anonymous str
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx.
hide_credentials bool
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request.
key_in_body bool
If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
key_in_header bool
If enabled (default), the plugin reads the request header and tries to find the key in it.
key_in_query bool
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
key_names Sequence[str]
Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
realm str
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
run_on_preflight bool
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.
anonymous String
An optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request will fail with an authentication failure 4xx.
hideCredentials Boolean
An optional boolean value telling the plugin to show or hide the credential from the upstream service. If true, the plugin strips the credential from the request.
keyInBody Boolean
If enabled, the plugin reads the request body. Supported MIME types: application/www-form-urlencoded, application/json, and multipart/form-data.
keyInHeader Boolean
If enabled (default), the plugin reads the request header and tries to find the key in it.
keyInQuery Boolean
If enabled (default), the plugin reads the query parameter in the request and tries to find the key in it.
keyNames List<String>
Describes an array of parameter names where the plugin will look for a key. The key names may only contain [a-z], [A-Z], [0-9], [_] underscore, and [-] hyphen.
realm String
When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
runOnPreflight Boolean
A boolean value that indicates whether the plugin should run (and try to authenticate) on OPTIONS preflight requests. If set to false, then OPTIONS requests are always allowed.

GatewayPluginKeyAuthOrdering
, GatewayPluginKeyAuthOrderingArgs

GatewayPluginKeyAuthOrderingAfter
, GatewayPluginKeyAuthOrderingAfterArgs

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

GatewayPluginKeyAuthOrderingBefore
, GatewayPluginKeyAuthOrderingBeforeArgs

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

GatewayPluginKeyAuthRoute
, GatewayPluginKeyAuthRouteArgs

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

GatewayPluginKeyAuthService
, GatewayPluginKeyAuthServiceArgs

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

Import

$ pulumi import konnect:index/gatewayPluginKeyAuth:GatewayPluginKeyAuth my_konnect_gateway_plugin_key_auth "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"
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.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect