konnect 2.4.1, Mar 13 25

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

konnect.GatewayPluginBasicAuth

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.GatewayPluginBasicAuth;
import com.pulumi.konnect.GatewayPluginBasicAuthArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginBasicAuthServiceArgs;
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 myGatewaypluginbasicauth = new GatewayPluginBasicAuth("myGatewaypluginbasicauth", GatewayPluginBasicAuthArgs.builder()
            .config(GatewayPluginBasicAuthConfigArgs.builder()
                .anonymous("...my_anonymous...")
                .hide_credentials(false)
                .realm("...my_realm...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginBasicAuthId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginBasicAuthOrderingArgs.builder()
                .after(GatewayPluginBasicAuthOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginBasicAuthOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("http")
            .route(GatewayPluginBasicAuthRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginBasicAuthServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewaypluginbasicauth:
    type: konnect:GatewayPluginBasicAuth
    properties:
      config:
        anonymous: '...my_anonymous...'
        hide_credentials: false
        realm: '...my_realm...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginBasicAuthId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - http
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginBasicAuth Resource

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

Constructor syntax

new GatewayPluginBasicAuth(name: string, args: GatewayPluginBasicAuthArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayPluginBasicAuth(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           config: Optional[GatewayPluginBasicAuthConfigArgs] = None,
                           control_plane_id: Optional[str] = None,
                           enabled: Optional[bool] = None,
                           gateway_plugin_basic_auth_id: Optional[str] = None,
                           instance_name: Optional[str] = None,
                           ordering: Optional[GatewayPluginBasicAuthOrderingArgs] = None,
                           protocols: Optional[Sequence[str]] = None,
                           route: Optional[GatewayPluginBasicAuthRouteArgs] = None,
                           service: Optional[GatewayPluginBasicAuthServiceArgs] = None,
                           tags: Optional[Sequence[str]] = None)

func NewGatewayPluginBasicAuth(ctx *Context, name string, args GatewayPluginBasicAuthArgs, opts ...ResourceOption) (*GatewayPluginBasicAuth, error)

public GatewayPluginBasicAuth(string name, GatewayPluginBasicAuthArgs args, CustomResourceOptions? opts = null)

public GatewayPluginBasicAuth(String name, GatewayPluginBasicAuthArgs args)
public GatewayPluginBasicAuth(String name, GatewayPluginBasicAuthArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginBasicAuth
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 GatewayPluginBasicAuthArgs: 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 GatewayPluginBasicAuthArgs: 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 GatewayPluginBasicAuthArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args GatewayPluginBasicAuthArgs: 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 gatewayPluginBasicAuthResource = new Konnect.GatewayPluginBasicAuth("gatewayPluginBasicAuthResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginBasicAuthConfigArgs
    {
        Anonymous = "string",
        HideCredentials = false,
        Realm = "string",
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginBasicAuthId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginBasicAuthOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginBasicAuthOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginBasicAuthOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginBasicAuthRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginBasicAuthServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginBasicAuth(ctx, "gatewayPluginBasicAuthResource", &konnect.GatewayPluginBasicAuthArgs{
Config: &.GatewayPluginBasicAuthConfigArgs{
Anonymous: pulumi.String("string"),
HideCredentials: pulumi.Bool(false),
Realm: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginBasicAuthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginBasicAuthOrderingArgs{
After: &.GatewayPluginBasicAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginBasicAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginBasicAuthRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginBasicAuthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginBasicAuthResource = new GatewayPluginBasicAuth("gatewayPluginBasicAuthResource", GatewayPluginBasicAuthArgs.builder()
    .config(GatewayPluginBasicAuthConfigArgs.builder()
        .anonymous("string")
        .hideCredentials(false)
        .realm("string")
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginBasicAuthId("string")
    .instanceName("string")
    .ordering(GatewayPluginBasicAuthOrderingArgs.builder()
        .after(GatewayPluginBasicAuthOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginBasicAuthOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginBasicAuthRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginBasicAuthServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_basic_auth_resource = konnect.GatewayPluginBasicAuth("gatewayPluginBasicAuthResource",
    config={
        "anonymous": "string",
        "hide_credentials": False,
        "realm": "string",
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_basic_auth_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginBasicAuthResource = new konnect.GatewayPluginBasicAuth("gatewayPluginBasicAuthResource", {
    config: {
        anonymous: "string",
        hideCredentials: false,
        realm: "string",
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginBasicAuthId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginBasicAuth
properties:
    config:
        anonymous: string
        hideCredentials: false
        realm: string
    controlPlaneId: string
    enabled: false
    gatewayPluginBasicAuthId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

Config GatewayPluginBasicAuthConfig
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.
GatewayPluginBasicAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginBasicAuthOrdering
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 GatewayPluginBasicAuthRoute: 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 GatewayPluginBasicAuthService: 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 GatewayPluginBasicAuthConfigArgs
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.
GatewayPluginBasicAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginBasicAuthOrderingArgs
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 GatewayPluginBasicAuthRouteArgs: 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 GatewayPluginBasicAuthServiceArgs: 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 GatewayPluginBasicAuthConfig
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.
gatewayPluginBasicAuthId String: The ID of this resource.
instanceName String
ordering GatewayPluginBasicAuthOrdering
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 GatewayPluginBasicAuthRoute: 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 GatewayPluginBasicAuthService: 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 GatewayPluginBasicAuthConfig
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.
gatewayPluginBasicAuthId string: The ID of this resource.
instanceName string
ordering GatewayPluginBasicAuthOrdering
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 GatewayPluginBasicAuthRoute: 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 GatewayPluginBasicAuthService: 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 GatewayPluginBasicAuthConfigArgs
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_basic_auth_id str: The ID of this resource.
instance_name str
ordering GatewayPluginBasicAuthOrderingArgs
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 GatewayPluginBasicAuthRouteArgs: 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 GatewayPluginBasicAuthServiceArgs: 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.
gatewayPluginBasicAuthId 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 GatewayPluginBasicAuth 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 GatewayPluginBasicAuth Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginBasicAuthConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_basic_auth_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginBasicAuthOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginBasicAuthRouteArgs] = None,
        service: Optional[GatewayPluginBasicAuthServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginBasicAuth

func GetGatewayPluginBasicAuth(ctx *Context, name string, id IDInput, state *GatewayPluginBasicAuthState, opts ...ResourceOption) (*GatewayPluginBasicAuth, error)

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

public static GatewayPluginBasicAuth get(String name, Output<String> id, GatewayPluginBasicAuthState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginBasicAuth    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 GatewayPluginBasicAuthConfig
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.
GatewayPluginBasicAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginBasicAuthOrdering
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 GatewayPluginBasicAuthRoute: 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 GatewayPluginBasicAuthService: 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 GatewayPluginBasicAuthConfigArgs
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.
GatewayPluginBasicAuthId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginBasicAuthOrderingArgs
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 GatewayPluginBasicAuthRouteArgs: 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 GatewayPluginBasicAuthServiceArgs: 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 GatewayPluginBasicAuthConfig
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.
gatewayPluginBasicAuthId String: The ID of this resource.
instanceName String
ordering GatewayPluginBasicAuthOrdering
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 GatewayPluginBasicAuthRoute: 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 GatewayPluginBasicAuthService: 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 GatewayPluginBasicAuthConfig
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.
gatewayPluginBasicAuthId string: The ID of this resource.
instanceName string
ordering GatewayPluginBasicAuthOrdering
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 GatewayPluginBasicAuthRoute: 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 GatewayPluginBasicAuthService: 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 GatewayPluginBasicAuthConfigArgs
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_basic_auth_id str: The ID of this resource.
instance_name str
ordering GatewayPluginBasicAuthOrderingArgs
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 GatewayPluginBasicAuthRouteArgs: 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 GatewayPluginBasicAuthServiceArgs: 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.
gatewayPluginBasicAuthId 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

GatewayPluginBasicAuthConfig, GatewayPluginBasicAuthConfigArgs

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. Please 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 will strip the credential from the request (i.e. the Authorization header) before proxying it.
Realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

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. Please 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 will strip the credential from the request (i.e. the Authorization header) before proxying it.
Realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

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. Please 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 will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm String: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

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. Please 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 will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm string: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

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. Please 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 will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm str: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

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. Please 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 will strip the credential from the request (i.e. the Authorization header) before proxying it.
realm String: When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.

GatewayPluginBasicAuthOrdering, GatewayPluginBasicAuthOrderingArgs

After GatewayPluginBasicAuthOrderingAfter
Before GatewayPluginBasicAuthOrderingBefore

After GatewayPluginBasicAuthOrderingAfter
Before GatewayPluginBasicAuthOrderingBefore

after GatewayPluginBasicAuthOrderingAfter
before GatewayPluginBasicAuthOrderingBefore

after GatewayPluginBasicAuthOrderingAfter
before GatewayPluginBasicAuthOrderingBefore

after GatewayPluginBasicAuthOrderingAfter
before GatewayPluginBasicAuthOrderingBefore

after Property Map
before Property Map

GatewayPluginBasicAuthOrderingAfter, GatewayPluginBasicAuthOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginBasicAuthOrderingBefore, GatewayPluginBasicAuthOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginBasicAuthRoute, GatewayPluginBasicAuthRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginBasicAuthService, GatewayPluginBasicAuthServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginBasicAuth:GatewayPluginBasicAuth my_konnect_gateway_plugin_basic_auth "{ \"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.GatewayPluginBasicAuth

On this page

On this page

Example Usage

Create GatewayPluginBasicAuth Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginBasicAuth Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginBasicAuth Resource

Supporting Types

GatewayPluginBasicAuthConfig, GatewayPluginBasicAuthConfigArgs

GatewayPluginBasicAuthOrdering, GatewayPluginBasicAuthOrderingArgs

GatewayPluginBasicAuthOrderingAfter, GatewayPluginBasicAuthOrderingAfterArgs

GatewayPluginBasicAuthOrderingBefore, GatewayPluginBasicAuthOrderingBeforeArgs

GatewayPluginBasicAuthRoute, GatewayPluginBasicAuthRouteArgs

GatewayPluginBasicAuthService, GatewayPluginBasicAuthServiceArgs

Import

Package Details

On this page

On this page