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

konnect.GatewayPluginLdapAuth

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

    GatewayPluginLdapAuth 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.GatewayPluginLdapAuth;
import com.pulumi.konnect.GatewayPluginLdapAuthArgs;
import com.pulumi.konnect.inputs.GatewayPluginLdapAuthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginLdapAuthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginLdapAuthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginLdapAuthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginLdapAuthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginLdapAuthServiceArgs;
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 myGatewaypluginldapauth = new GatewayPluginLdapAuth("myGatewaypluginldapauth", GatewayPluginLdapAuthArgs.builder()
            .config(GatewayPluginLdapAuthConfigArgs.builder()
                .anonymous("...my_anonymous...")
                .attribute("...my_attribute...")
                .base_dn("...my_base_dn...")
                .cache_ttl(0.75)
                .header_type("...my_header_type...")
                .hide_credentials(false)
                .keepalive(2.29)
                .ldap_host("...my_ldap_host...")
                .ldap_port(57764)
                .ldaps(true)
                .realm("...my_realm...")
                .start_tls(false)
                .timeout(2.42)
                .verify_ldap_host(true)
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginLdapAuthId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginLdapAuthOrderingArgs.builder()
                .after(GatewayPluginLdapAuthOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginLdapAuthOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("wss")
            .route(GatewayPluginLdapAuthRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginLdapAuthServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

    resources:
  myGatewaypluginldapauth:
    type: konnect:GatewayPluginLdapAuth
    properties:
      config:
        anonymous: '...my_anonymous...'
        attribute: '...my_attribute...'
        base_dn: '...my_base_dn...'
        cache_ttl: 0.75
        header_type: '...my_header_type...'
        hide_credentials: false
        keepalive: 2.29
        ldap_host: '...my_ldap_host...'
        ldap_port: 57764
        ldaps: true
        realm: '...my_realm...'
        start_tls: false
        timeout: 2.42
        verify_ldap_host: true
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginLdapAuthId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - wss
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

    Create GatewayPluginLdapAuth Resource

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

    Constructor syntax

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

@overload
def GatewayPluginLdapAuth(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          config: Optional[GatewayPluginLdapAuthConfigArgs] = None,
                          control_plane_id: Optional[str] = None,
                          enabled: Optional[bool] = None,
                          gateway_plugin_ldap_auth_id: Optional[str] = None,
                          instance_name: Optional[str] = None,
                          ordering: Optional[GatewayPluginLdapAuthOrderingArgs] = None,
                          protocols: Optional[Sequence[str]] = None,
                          route: Optional[GatewayPluginLdapAuthRouteArgs] = None,
                          service: Optional[GatewayPluginLdapAuthServiceArgs] = None,
                          tags: Optional[Sequence[str]] = None)
    func NewGatewayPluginLdapAuth(ctx *Context, name string, args GatewayPluginLdapAuthArgs, opts ...ResourceOption) (*GatewayPluginLdapAuth, error)
    public GatewayPluginLdapAuth(string name, GatewayPluginLdapAuthArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginLdapAuth(String name, GatewayPluginLdapAuthArgs args)
public GatewayPluginLdapAuth(String name, GatewayPluginLdapAuthArgs args, CustomResourceOptions options)

    type: konnect:GatewayPluginLdapAuth
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 GatewayPluginLdapAuthArgs
    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 GatewayPluginLdapAuthArgs
    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 GatewayPluginLdapAuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginLdapAuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginLdapAuthArgs
    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 gatewayPluginLdapAuthResource = new Konnect.GatewayPluginLdapAuth("gatewayPluginLdapAuthResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginLdapAuthConfigArgs
    {
        Anonymous = "string",
        Attribute = "string",
        BaseDn = "string",
        CacheTtl = 0,
        HeaderType = "string",
        HideCredentials = false,
        Keepalive = 0,
        LdapHost = "string",
        LdapPort = 0,
        Ldaps = false,
        Realm = "string",
        StartTls = false,
        Timeout = 0,
        VerifyLdapHost = false,
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginLdapAuthId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginLdapAuthOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginLdapAuthOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginLdapAuthOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginLdapAuthRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginLdapAuthServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayPluginLdapAuth(ctx, "gatewayPluginLdapAuthResource", &konnect.GatewayPluginLdapAuthArgs{
Config: &.GatewayPluginLdapAuthConfigArgs{
Anonymous: pulumi.String("string"),
Attribute: pulumi.String("string"),
BaseDn: pulumi.String("string"),
CacheTtl: pulumi.Float64(0),
HeaderType: pulumi.String("string"),
HideCredentials: pulumi.Bool(false),
Keepalive: pulumi.Float64(0),
LdapHost: pulumi.String("string"),
LdapPort: pulumi.Float64(0),
Ldaps: pulumi.Bool(false),
Realm: pulumi.String("string"),
StartTls: pulumi.Bool(false),
Timeout: pulumi.Float64(0),
VerifyLdapHost: pulumi.Bool(false),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginLdapAuthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginLdapAuthOrderingArgs{
After: &.GatewayPluginLdapAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginLdapAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginLdapAuthRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginLdapAuthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayPluginLdapAuthResource = new GatewayPluginLdapAuth("gatewayPluginLdapAuthResource", GatewayPluginLdapAuthArgs.builder()
    .config(GatewayPluginLdapAuthConfigArgs.builder()
        .anonymous("string")
        .attribute("string")
        .baseDn("string")
        .cacheTtl(0)
        .headerType("string")
        .hideCredentials(false)
        .keepalive(0)
        .ldapHost("string")
        .ldapPort(0)
        .ldaps(false)
        .realm("string")
        .startTls(false)
        .timeout(0)
        .verifyLdapHost(false)
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginLdapAuthId("string")
    .instanceName("string")
    .ordering(GatewayPluginLdapAuthOrderingArgs.builder()
        .after(GatewayPluginLdapAuthOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginLdapAuthOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginLdapAuthRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginLdapAuthServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

    gateway_plugin_ldap_auth_resource = konnect.GatewayPluginLdapAuth("gatewayPluginLdapAuthResource",
    config={
        "anonymous": "string",
        "attribute": "string",
        "base_dn": "string",
        "cache_ttl": 0,
        "header_type": "string",
        "hide_credentials": False,
        "keepalive": 0,
        "ldap_host": "string",
        "ldap_port": 0,
        "ldaps": False,
        "realm": "string",
        "start_tls": False,
        "timeout": 0,
        "verify_ldap_host": False,
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_ldap_auth_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

    const gatewayPluginLdapAuthResource = new konnect.GatewayPluginLdapAuth("gatewayPluginLdapAuthResource", {
    config: {
        anonymous: "string",
        attribute: "string",
        baseDn: "string",
        cacheTtl: 0,
        headerType: "string",
        hideCredentials: false,
        keepalive: 0,
        ldapHost: "string",
        ldapPort: 0,
        ldaps: false,
        realm: "string",
        startTls: false,
        timeout: 0,
        verifyLdapHost: false,
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginLdapAuthId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

    type: konnect:GatewayPluginLdapAuth
properties:
    config:
        anonymous: string
        attribute: string
        baseDn: string
        cacheTtl: 0
        headerType: string
        hideCredentials: false
        keepalive: 0
        ldapHost: string
        ldapPort: 0
        ldaps: false
        realm: string
        startTls: false
        timeout: 0
        verifyLdapHost: false
    controlPlaneId: string
    enabled: false
    gatewayPluginLdapAuthId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

    Config GatewayPluginLdapAuthConfig
    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.
    GatewayPluginLdapAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginLdapAuthOrdering
    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 GatewayPluginLdapAuthRoute
    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 GatewayPluginLdapAuthService
    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 GatewayPluginLdapAuthConfigArgs
    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.
    GatewayPluginLdapAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginLdapAuthOrderingArgs
    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 GatewayPluginLdapAuthRouteArgs
    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 GatewayPluginLdapAuthServiceArgs
    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 GatewayPluginLdapAuthConfig
    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.
    gatewayPluginLdapAuthId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginLdapAuthOrdering
    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 GatewayPluginLdapAuthRoute
    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 GatewayPluginLdapAuthService
    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 GatewayPluginLdapAuthConfig
    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.
    gatewayPluginLdapAuthId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginLdapAuthOrdering
    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 GatewayPluginLdapAuthRoute
    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 GatewayPluginLdapAuthService
    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 GatewayPluginLdapAuthConfigArgs
    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_ldap_auth_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginLdapAuthOrderingArgs
    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 GatewayPluginLdapAuthRouteArgs
    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 GatewayPluginLdapAuthServiceArgs
    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.
    gatewayPluginLdapAuthId 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 GatewayPluginLdapAuth 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 GatewayPluginLdapAuth Resource

    Get an existing GatewayPluginLdapAuth 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?: GatewayPluginLdapAuthState, opts?: CustomResourceOptions): GatewayPluginLdapAuth
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginLdapAuthConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_ldap_auth_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginLdapAuthOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginLdapAuthRouteArgs] = None,
        service: Optional[GatewayPluginLdapAuthServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginLdapAuth
    func GetGatewayPluginLdapAuth(ctx *Context, name string, id IDInput, state *GatewayPluginLdapAuthState, opts ...ResourceOption) (*GatewayPluginLdapAuth, error)
    public static GatewayPluginLdapAuth Get(string name, Input<string> id, GatewayPluginLdapAuthState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginLdapAuth get(String name, Output<String> id, GatewayPluginLdapAuthState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginLdapAuth    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 GatewayPluginLdapAuthConfig
    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.
    GatewayPluginLdapAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginLdapAuthOrdering
    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 GatewayPluginLdapAuthRoute
    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 GatewayPluginLdapAuthService
    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 GatewayPluginLdapAuthConfigArgs
    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.
    GatewayPluginLdapAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginLdapAuthOrderingArgs
    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 GatewayPluginLdapAuthRouteArgs
    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 GatewayPluginLdapAuthServiceArgs
    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 GatewayPluginLdapAuthConfig
    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.
    gatewayPluginLdapAuthId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginLdapAuthOrdering
    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 GatewayPluginLdapAuthRoute
    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 GatewayPluginLdapAuthService
    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 GatewayPluginLdapAuthConfig
    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.
    gatewayPluginLdapAuthId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginLdapAuthOrdering
    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 GatewayPluginLdapAuthRoute
    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 GatewayPluginLdapAuthService
    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 GatewayPluginLdapAuthConfigArgs
    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_ldap_auth_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginLdapAuthOrderingArgs
    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 GatewayPluginLdapAuthRouteArgs
    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 GatewayPluginLdapAuthServiceArgs
    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.
    gatewayPluginLdapAuthId 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

    GatewayPluginLdapAuthConfig, GatewayPluginLdapAuthConfigArgs

    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 fails with an authentication failure 4xx.
    Attribute string
    Attribute to be used to search the user; e.g. cn
    BaseDn string
    Base DN as the starting point for the search; e.g., dc=example,dc=com
    CacheTtl double
    Cache expiry time in seconds.
    HeaderType string
    An optional string to use as part of the Authorization header
    HideCredentials bool
    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
    Keepalive double
    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
    LdapHost string
    A string representing a host name, such as example.com.
    LdapPort double
    An integer representing a port number between 0 and 65535, inclusive.
    Ldaps bool
    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
    Realm string
    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
    StartTls bool
    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.
    Timeout double
    An optional timeout in milliseconds when waiting for connection with LDAP server.
    VerifyLdapHost bool
    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.
    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 fails with an authentication failure 4xx.
    Attribute string
    Attribute to be used to search the user; e.g. cn
    BaseDn string
    Base DN as the starting point for the search; e.g., dc=example,dc=com
    CacheTtl float64
    Cache expiry time in seconds.
    HeaderType string
    An optional string to use as part of the Authorization header
    HideCredentials bool
    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
    Keepalive float64
    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
    LdapHost string
    A string representing a host name, such as example.com.
    LdapPort float64
    An integer representing a port number between 0 and 65535, inclusive.
    Ldaps bool
    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
    Realm string
    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
    StartTls bool
    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.
    Timeout float64
    An optional timeout in milliseconds when waiting for connection with LDAP server.
    VerifyLdapHost bool
    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.
    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 fails with an authentication failure 4xx.
    attribute String
    Attribute to be used to search the user; e.g. cn
    baseDn String
    Base DN as the starting point for the search; e.g., dc=example,dc=com
    cacheTtl Double
    Cache expiry time in seconds.
    headerType String
    An optional string to use as part of the Authorization header
    hideCredentials Boolean
    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
    keepalive Double
    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
    ldapHost String
    A string representing a host name, such as example.com.
    ldapPort Double
    An integer representing a port number between 0 and 65535, inclusive.
    ldaps Boolean
    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
    realm String
    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
    startTls Boolean
    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.
    timeout Double
    An optional timeout in milliseconds when waiting for connection with LDAP server.
    verifyLdapHost Boolean
    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.
    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 fails with an authentication failure 4xx.
    attribute string
    Attribute to be used to search the user; e.g. cn
    baseDn string
    Base DN as the starting point for the search; e.g., dc=example,dc=com
    cacheTtl number
    Cache expiry time in seconds.
    headerType string
    An optional string to use as part of the Authorization header
    hideCredentials boolean
    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
    keepalive number
    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
    ldapHost string
    A string representing a host name, such as example.com.
    ldapPort number
    An integer representing a port number between 0 and 65535, inclusive.
    ldaps boolean
    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
    realm string
    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
    startTls boolean
    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.
    timeout number
    An optional timeout in milliseconds when waiting for connection with LDAP server.
    verifyLdapHost boolean
    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.
    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 fails with an authentication failure 4xx.
    attribute str
    Attribute to be used to search the user; e.g. cn
    base_dn str
    Base DN as the starting point for the search; e.g., dc=example,dc=com
    cache_ttl float
    Cache expiry time in seconds.
    header_type str
    An optional string to use as part of the Authorization header
    hide_credentials bool
    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
    keepalive float
    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
    ldap_host str
    A string representing a host name, such as example.com.
    ldap_port float
    An integer representing a port number between 0 and 65535, inclusive.
    ldaps bool
    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
    realm str
    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
    start_tls bool
    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.
    timeout float
    An optional timeout in milliseconds when waiting for connection with LDAP server.
    verify_ldap_host bool
    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.
    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 fails with an authentication failure 4xx.
    attribute String
    Attribute to be used to search the user; e.g. cn
    baseDn String
    Base DN as the starting point for the search; e.g., dc=example,dc=com
    cacheTtl Number
    Cache expiry time in seconds.
    headerType String
    An optional string to use as part of the Authorization header
    hideCredentials Boolean
    An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
    keepalive Number
    An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
    ldapHost String
    A string representing a host name, such as example.com.
    ldapPort Number
    An integer representing a port number between 0 and 65535, inclusive.
    ldaps Boolean
    Set to true to connect using the LDAPS protocol (LDAP over TLS). When ldaps is configured, you must use port 636. If the ldap setting is enabled, ensure the start_tls setting is disabled.
    realm String
    When authentication fails the plugin sends WWW-Authenticate header with realm attribute value.
    startTls Boolean
    Set it to true to issue StartTLS (Transport Layer Security) extended operation over ldap connection. If the start_tls setting is enabled, ensure the ldaps setting is disabled.
    timeout Number
    An optional timeout in milliseconds when waiting for connection with LDAP server.
    verifyLdapHost Boolean
    Set to true to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by the lua_ssl_trusted_certificate directive.

    GatewayPluginLdapAuthOrdering, GatewayPluginLdapAuthOrderingArgs

    GatewayPluginLdapAuthOrderingAfter, GatewayPluginLdapAuthOrderingAfterArgs

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

    GatewayPluginLdapAuthOrderingBefore, GatewayPluginLdapAuthOrderingBeforeArgs

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

    GatewayPluginLdapAuthRoute, GatewayPluginLdapAuthRouteArgs

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

    GatewayPluginLdapAuthService, GatewayPluginLdapAuthServiceArgs

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

    Import

    $ pulumi import konnect:index/gatewayPluginLdapAuth:GatewayPluginLdapAuth my_konnect_gateway_plugin_ldap_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 logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect