konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginKeyAuthEnc

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

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.GatewayPluginKeyAuthEnc;
import com.pulumi.konnect.GatewayPluginKeyAuthEncArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthEncConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthEncOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthEncOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthEncOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthEncRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginKeyAuthEncServiceArgs;
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 myGatewaypluginkeyauthenc = new GatewayPluginKeyAuthEnc("myGatewaypluginkeyauthenc", GatewayPluginKeyAuthEncArgs.builder()
            .config(GatewayPluginKeyAuthEncConfigArgs.builder()
                .anonymous("...my_anonymous...")
                .hide_credentials(false)
                .key_in_body(false)
                .key_in_header(false)
                .key_in_query(false)
                .key_names("...")
                .realm("...my_realm...")
                .run_on_preflight(true)
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginKeyAuthEncId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginKeyAuthEncOrderingArgs.builder()
                .after(GatewayPluginKeyAuthEncOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginKeyAuthEncOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("http")
            .route(GatewayPluginKeyAuthEncRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginKeyAuthEncServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginkeyauthenc:
    type: konnect:GatewayPluginKeyAuthEnc
    properties:
      config:
        anonymous: '...my_anonymous...'
        hide_credentials: false
        key_in_body: false
        key_in_header: false
        key_in_query: false
        key_names:
          - '...'
        realm: '...my_realm...'
        run_on_preflight: true
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginKeyAuthEncId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - http
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginKeyAuthEnc Resource

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

Constructor syntax

new GatewayPluginKeyAuthEnc(name: string, args: GatewayPluginKeyAuthEncArgs, opts?: CustomResourceOptions);

@overload
def GatewayPluginKeyAuthEnc(resource_name: str,
                            args: GatewayPluginKeyAuthEncArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginKeyAuthEnc(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            config: Optional[GatewayPluginKeyAuthEncConfigArgs] = None,
                            control_plane_id: Optional[str] = None,
                            enabled: Optional[bool] = None,
                            gateway_plugin_key_auth_enc_id: Optional[str] = None,
                            instance_name: Optional[str] = None,
                            ordering: Optional[GatewayPluginKeyAuthEncOrderingArgs] = None,
                            protocols: Optional[Sequence[str]] = None,
                            route: Optional[GatewayPluginKeyAuthEncRouteArgs] = None,
                            service: Optional[GatewayPluginKeyAuthEncServiceArgs] = None,
                            tags: Optional[Sequence[str]] = None)

func NewGatewayPluginKeyAuthEnc(ctx *Context, name string, args GatewayPluginKeyAuthEncArgs, opts ...ResourceOption) (*GatewayPluginKeyAuthEnc, error)

public GatewayPluginKeyAuthEnc(string name, GatewayPluginKeyAuthEncArgs args, CustomResourceOptions? opts = null)

public GatewayPluginKeyAuthEnc(String name, GatewayPluginKeyAuthEncArgs args)
public GatewayPluginKeyAuthEnc(String name, GatewayPluginKeyAuthEncArgs args, CustomResourceOptions options)

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

Parameters

name string: The unique name of the resource.
args GatewayPluginKeyAuthEncArgs: 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 GatewayPluginKeyAuthEncArgs: 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 GatewayPluginKeyAuthEncArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayPluginKeyAuthEncArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayPluginKeyAuthEncArgs: 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 gatewayPluginKeyAuthEncResource = new Konnect.GatewayPluginKeyAuthEnc("gatewayPluginKeyAuthEncResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginKeyAuthEncConfigArgs
    {
        Anonymous = "string",
        HideCredentials = false,
        KeyInBody = false,
        KeyInHeader = false,
        KeyInQuery = false,
        KeyNames = new[]
        {
            "string",
        },
        Realm = "string",
        RunOnPreflight = false,
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginKeyAuthEncId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginKeyAuthEncOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginKeyAuthEncOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginKeyAuthEncOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginKeyAuthEncRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginKeyAuthEncServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginKeyAuthEnc(ctx, "gatewayPluginKeyAuthEncResource", &konnect.GatewayPluginKeyAuthEncArgs{
Config: &.GatewayPluginKeyAuthEncConfigArgs{
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),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginKeyAuthEncId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginKeyAuthEncOrderingArgs{
After: &.GatewayPluginKeyAuthEncOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginKeyAuthEncOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginKeyAuthEncRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginKeyAuthEncServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginKeyAuthEncResource = new GatewayPluginKeyAuthEnc("gatewayPluginKeyAuthEncResource", GatewayPluginKeyAuthEncArgs.builder()
    .config(GatewayPluginKeyAuthEncConfigArgs.builder()
        .anonymous("string")
        .hideCredentials(false)
        .keyInBody(false)
        .keyInHeader(false)
        .keyInQuery(false)
        .keyNames("string")
        .realm("string")
        .runOnPreflight(false)
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginKeyAuthEncId("string")
    .instanceName("string")
    .ordering(GatewayPluginKeyAuthEncOrderingArgs.builder()
        .after(GatewayPluginKeyAuthEncOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginKeyAuthEncOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginKeyAuthEncRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginKeyAuthEncServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_key_auth_enc_resource = konnect.GatewayPluginKeyAuthEnc("gatewayPluginKeyAuthEncResource",
    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,
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_key_auth_enc_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginKeyAuthEncResource = new konnect.GatewayPluginKeyAuthEnc("gatewayPluginKeyAuthEncResource", {
    config: {
        anonymous: "string",
        hideCredentials: false,
        keyInBody: false,
        keyInHeader: false,
        keyInQuery: false,
        keyNames: ["string"],
        realm: "string",
        runOnPreflight: false,
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginKeyAuthEncId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginKeyAuthEnc
properties:
    config:
        anonymous: string
        hideCredentials: false
        keyInBody: false
        keyInHeader: false
        keyInQuery: false
        keyNames:
            - string
        realm: string
        runOnPreflight: false
    controlPlaneId: string
    enabled: false
    gatewayPluginKeyAuthEncId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginKeyAuthEncConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool: Whether the plugin is applied.
GatewayPluginKeyAuthEncId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthEncOrdering
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 GatewayPluginKeyAuthEncRoute: 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 GatewayPluginKeyAuthEncService: 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 GatewayPluginKeyAuthEncConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool: Whether the plugin is applied.
GatewayPluginKeyAuthEncId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthEncOrderingArgs
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 GatewayPluginKeyAuthEncRouteArgs: 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 GatewayPluginKeyAuthEncServiceArgs: 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 GatewayPluginKeyAuthEncConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean: Whether the plugin is applied.
gatewayPluginKeyAuthEncId String: The ID of this resource.
instanceName String
ordering GatewayPluginKeyAuthEncOrdering
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 GatewayPluginKeyAuthEncRoute: 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 GatewayPluginKeyAuthEncService: 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 GatewayPluginKeyAuthEncConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled boolean: Whether the plugin is applied.
gatewayPluginKeyAuthEncId string: The ID of this resource.
instanceName string
ordering GatewayPluginKeyAuthEncOrdering
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 GatewayPluginKeyAuthEncRoute: 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 GatewayPluginKeyAuthEncService: 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 GatewayPluginKeyAuthEncConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled bool: Whether the plugin is applied.
gateway_plugin_key_auth_enc_id str: The ID of this resource.
instance_name str
ordering GatewayPluginKeyAuthEncOrderingArgs
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 GatewayPluginKeyAuthEncRouteArgs: 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 GatewayPluginKeyAuthEncServiceArgs: 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 Property Map
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean: Whether the plugin is applied.
gatewayPluginKeyAuthEncId 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayPluginKeyAuthEnc 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 GatewayPluginKeyAuthEnc Resource

Get an existing GatewayPluginKeyAuthEnc 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?: GatewayPluginKeyAuthEncState, opts?: CustomResourceOptions): GatewayPluginKeyAuthEnc

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginKeyAuthEncConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_key_auth_enc_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginKeyAuthEncOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginKeyAuthEncRouteArgs] = None,
        service: Optional[GatewayPluginKeyAuthEncServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginKeyAuthEnc

func GetGatewayPluginKeyAuthEnc(ctx *Context, name string, id IDInput, state *GatewayPluginKeyAuthEncState, opts ...ResourceOption) (*GatewayPluginKeyAuthEnc, error)

public static GatewayPluginKeyAuthEnc Get(string name, Input<string> id, GatewayPluginKeyAuthEncState? state, CustomResourceOptions? opts = null)

public static GatewayPluginKeyAuthEnc get(String name, Output<String> id, GatewayPluginKeyAuthEncState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginKeyAuthEnc    get:      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:

Config GatewayPluginKeyAuthEncConfig
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.
GatewayPluginKeyAuthEncId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthEncOrdering
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 GatewayPluginKeyAuthEncRoute: 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 GatewayPluginKeyAuthEncService: 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 GatewayPluginKeyAuthEncConfigArgs
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.
GatewayPluginKeyAuthEncId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginKeyAuthEncOrderingArgs
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 GatewayPluginKeyAuthEncRouteArgs: 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 GatewayPluginKeyAuthEncServiceArgs: 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 GatewayPluginKeyAuthEncConfig
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.
gatewayPluginKeyAuthEncId String: The ID of this resource.
instanceName String
ordering GatewayPluginKeyAuthEncOrdering
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 GatewayPluginKeyAuthEncRoute: 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 GatewayPluginKeyAuthEncService: 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 GatewayPluginKeyAuthEncConfig
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.
gatewayPluginKeyAuthEncId string: The ID of this resource.
instanceName string
ordering GatewayPluginKeyAuthEncOrdering
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 GatewayPluginKeyAuthEncRoute: 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 GatewayPluginKeyAuthEncService: 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 GatewayPluginKeyAuthEncConfigArgs
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_enc_id str: The ID of this resource.
instance_name str
ordering GatewayPluginKeyAuthEncOrderingArgs
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 GatewayPluginKeyAuthEncRouteArgs: 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 GatewayPluginKeyAuthEncServiceArgs: 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.
gatewayPluginKeyAuthEncId 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

GatewayPluginKeyAuthEncConfig, GatewayPluginKeyAuthEncConfigArgs

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. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
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 (i.e., the header, query string, or request body containing the key) before proxying it.
KeyInBody bool: If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. 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 client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. 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. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
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 (i.e., the header, query string, or request body containing the key) before proxying it.
KeyInBody bool: If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. 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 client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. 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. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
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 (i.e., the header, query string, or request body containing the key) before proxying it.
keyInBody Boolean: If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. 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 client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. 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. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
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 (i.e., the header, query string, or request body containing the key) before proxying it.
keyInBody boolean: If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. 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 client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. 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. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
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 (i.e., the header, query string, or request body containing the key) before proxying it.
key_in_body bool: If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. 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 client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. 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. Note that this value must refer to the consumer id or username attribute, and not its custom_id.
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 (i.e., the header, query string, or request body containing the key) before proxying it.
keyInBody Boolean: If enabled, the plugin reads the request body (if said request has one and its MIME type is supported) and tries to find the key in it. 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 client must send the authentication key in one of those key names, and the plugin will try to read the credential from a header, request body, or query string parameter with the same name. 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.

GatewayPluginKeyAuthEncOrdering, GatewayPluginKeyAuthEncOrderingArgs

After GatewayPluginKeyAuthEncOrderingAfter
Before GatewayPluginKeyAuthEncOrderingBefore

After GatewayPluginKeyAuthEncOrderingAfter
Before GatewayPluginKeyAuthEncOrderingBefore

after GatewayPluginKeyAuthEncOrderingAfter
before GatewayPluginKeyAuthEncOrderingBefore

after GatewayPluginKeyAuthEncOrderingAfter
before GatewayPluginKeyAuthEncOrderingBefore

after GatewayPluginKeyAuthEncOrderingAfter
before GatewayPluginKeyAuthEncOrderingBefore

after Property Map
before Property Map

GatewayPluginKeyAuthEncOrderingAfter, GatewayPluginKeyAuthEncOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginKeyAuthEncOrderingBefore, GatewayPluginKeyAuthEncOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginKeyAuthEncRoute, GatewayPluginKeyAuthEncRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginKeyAuthEncService, GatewayPluginKeyAuthEncServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginKeyAuthEnc:GatewayPluginKeyAuthEnc my_konnect_gateway_plugin_key_auth_enc "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.GatewayPluginKeyAuthEnc

On this page

On this page

Example Usage

Create GatewayPluginKeyAuthEnc Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginKeyAuthEnc Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginKeyAuthEnc Resource

Supporting Types

GatewayPluginKeyAuthEncConfig, GatewayPluginKeyAuthEncConfigArgs

GatewayPluginKeyAuthEncOrdering, GatewayPluginKeyAuthEncOrderingArgs

GatewayPluginKeyAuthEncOrderingAfter, GatewayPluginKeyAuthEncOrderingAfterArgs

GatewayPluginKeyAuthEncOrderingBefore, GatewayPluginKeyAuthEncOrderingBeforeArgs

GatewayPluginKeyAuthEncRoute, GatewayPluginKeyAuthEncRouteArgs

GatewayPluginKeyAuthEncService, GatewayPluginKeyAuthEncServiceArgs

Import

Package Details

On this page

On this page