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

konnect.GatewayPluginVaultAuth

Explore with Pulumi AI

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

    GatewayPluginVaultAuth 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.GatewayPluginVaultAuth;
import com.pulumi.konnect.GatewayPluginVaultAuthArgs;
import com.pulumi.konnect.inputs.GatewayPluginVaultAuthConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginVaultAuthOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginVaultAuthOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginVaultAuthOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginVaultAuthRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginVaultAuthServiceArgs;
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 myGatewaypluginvaultauth = new GatewayPluginVaultAuth("myGatewaypluginvaultauth", GatewayPluginVaultAuthArgs.builder()
            .config(GatewayPluginVaultAuthConfigArgs.builder()
                .access_token_name("...my_access_token_name...")
                .anonymous("...my_anonymous...")
                .hide_credentials(false)
                .run_on_preflight(false)
                .secret_token_name("...my_secret_token_name...")
                .tokens_in_body(true)
                .vault("...my_vault...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(true)
            .gatewayPluginVaultAuthId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginVaultAuthOrderingArgs.builder()
                .after(GatewayPluginVaultAuthOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginVaultAuthOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpcs")
            .route(GatewayPluginVaultAuthRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginVaultAuthServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

    resources:
  myGatewaypluginvaultauth:
    type: konnect:GatewayPluginVaultAuth
    properties:
      config:
        access_token_name: '...my_access_token_name...'
        anonymous: '...my_anonymous...'
        hide_credentials: false
        run_on_preflight: false
        secret_token_name: '...my_secret_token_name...'
        tokens_in_body: true
        vault: '...my_vault...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: true
      gatewayPluginVaultAuthId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpcs
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

    Create GatewayPluginVaultAuth Resource

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

    Constructor syntax

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

@overload
def GatewayPluginVaultAuth(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           config: Optional[GatewayPluginVaultAuthConfigArgs] = None,
                           control_plane_id: Optional[str] = None,
                           enabled: Optional[bool] = None,
                           gateway_plugin_vault_auth_id: Optional[str] = None,
                           instance_name: Optional[str] = None,
                           ordering: Optional[GatewayPluginVaultAuthOrderingArgs] = None,
                           protocols: Optional[Sequence[str]] = None,
                           route: Optional[GatewayPluginVaultAuthRouteArgs] = None,
                           service: Optional[GatewayPluginVaultAuthServiceArgs] = None,
                           tags: Optional[Sequence[str]] = None)
    func NewGatewayPluginVaultAuth(ctx *Context, name string, args GatewayPluginVaultAuthArgs, opts ...ResourceOption) (*GatewayPluginVaultAuth, error)
    public GatewayPluginVaultAuth(string name, GatewayPluginVaultAuthArgs args, CustomResourceOptions? opts = null)
    public GatewayPluginVaultAuth(String name, GatewayPluginVaultAuthArgs args)
public GatewayPluginVaultAuth(String name, GatewayPluginVaultAuthArgs args, CustomResourceOptions options)

    type: konnect:GatewayPluginVaultAuth
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 GatewayPluginVaultAuthArgs
    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 GatewayPluginVaultAuthArgs
    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 GatewayPluginVaultAuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayPluginVaultAuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayPluginVaultAuthArgs
    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 gatewayPluginVaultAuthResource = new Konnect.GatewayPluginVaultAuth("gatewayPluginVaultAuthResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginVaultAuthConfigArgs
    {
        AccessTokenName = "string",
        Anonymous = "string",
        HideCredentials = false,
        RunOnPreflight = false,
        SecretTokenName = "string",
        TokensInBody = false,
        Vault = "string",
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginVaultAuthId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginVaultAuthOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginVaultAuthOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginVaultAuthOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginVaultAuthRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginVaultAuthServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayPluginVaultAuth(ctx, "gatewayPluginVaultAuthResource", &konnect.GatewayPluginVaultAuthArgs{
Config: &.GatewayPluginVaultAuthConfigArgs{
AccessTokenName: pulumi.String("string"),
Anonymous: pulumi.String("string"),
HideCredentials: pulumi.Bool(false),
RunOnPreflight: pulumi.Bool(false),
SecretTokenName: pulumi.String("string"),
TokensInBody: pulumi.Bool(false),
Vault: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginVaultAuthId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginVaultAuthOrderingArgs{
After: &.GatewayPluginVaultAuthOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginVaultAuthOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginVaultAuthRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginVaultAuthServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayPluginVaultAuthResource = new GatewayPluginVaultAuth("gatewayPluginVaultAuthResource", GatewayPluginVaultAuthArgs.builder()
    .config(GatewayPluginVaultAuthConfigArgs.builder()
        .accessTokenName("string")
        .anonymous("string")
        .hideCredentials(false)
        .runOnPreflight(false)
        .secretTokenName("string")
        .tokensInBody(false)
        .vault("string")
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginVaultAuthId("string")
    .instanceName("string")
    .ordering(GatewayPluginVaultAuthOrderingArgs.builder()
        .after(GatewayPluginVaultAuthOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginVaultAuthOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginVaultAuthRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginVaultAuthServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

    gateway_plugin_vault_auth_resource = konnect.GatewayPluginVaultAuth("gatewayPluginVaultAuthResource",
    config={
        "access_token_name": "string",
        "anonymous": "string",
        "hide_credentials": False,
        "run_on_preflight": False,
        "secret_token_name": "string",
        "tokens_in_body": False,
        "vault": "string",
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_vault_auth_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

    const gatewayPluginVaultAuthResource = new konnect.GatewayPluginVaultAuth("gatewayPluginVaultAuthResource", {
    config: {
        accessTokenName: "string",
        anonymous: "string",
        hideCredentials: false,
        runOnPreflight: false,
        secretTokenName: "string",
        tokensInBody: false,
        vault: "string",
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginVaultAuthId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

    type: konnect:GatewayPluginVaultAuth
properties:
    config:
        accessTokenName: string
        anonymous: string
        hideCredentials: false
        runOnPreflight: false
        secretTokenName: string
        tokensInBody: false
        vault: string
    controlPlaneId: string
    enabled: false
    gatewayPluginVaultAuthId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

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

    Config GatewayPluginVaultAuthConfig
    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.
    GatewayPluginVaultAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginVaultAuthOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginVaultAuthRoute
    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 GatewayPluginVaultAuthService
    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 GatewayPluginVaultAuthConfigArgs
    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.
    GatewayPluginVaultAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginVaultAuthOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginVaultAuthRouteArgs
    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 GatewayPluginVaultAuthServiceArgs
    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 GatewayPluginVaultAuthConfig
    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.
    gatewayPluginVaultAuthId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginVaultAuthOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginVaultAuthRoute
    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 GatewayPluginVaultAuthService
    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 GatewayPluginVaultAuthConfig
    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.
    gatewayPluginVaultAuthId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginVaultAuthOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginVaultAuthRoute
    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 GatewayPluginVaultAuthService
    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 GatewayPluginVaultAuthConfigArgs
    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_vault_auth_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginVaultAuthOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginVaultAuthRouteArgs
    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 GatewayPluginVaultAuthServiceArgs
    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.
    gatewayPluginVaultAuthId String
    The ID of this resource.
    instanceName String
    ordering Property Map
    protocols List<String>
    A set of strings representing HTTP protocols.
    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 GatewayPluginVaultAuth 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 GatewayPluginVaultAuth Resource

    Get an existing GatewayPluginVaultAuth 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?: GatewayPluginVaultAuthState, opts?: CustomResourceOptions): GatewayPluginVaultAuth
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginVaultAuthConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_vault_auth_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginVaultAuthOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginVaultAuthRouteArgs] = None,
        service: Optional[GatewayPluginVaultAuthServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginVaultAuth
    func GetGatewayPluginVaultAuth(ctx *Context, name string, id IDInput, state *GatewayPluginVaultAuthState, opts ...ResourceOption) (*GatewayPluginVaultAuth, error)
    public static GatewayPluginVaultAuth Get(string name, Input<string> id, GatewayPluginVaultAuthState? state, CustomResourceOptions? opts = null)
    public static GatewayPluginVaultAuth get(String name, Output<String> id, GatewayPluginVaultAuthState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayPluginVaultAuth    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 GatewayPluginVaultAuthConfig
    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.
    GatewayPluginVaultAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginVaultAuthOrdering
    Protocols List<string>
    A set of strings representing HTTP protocols.
    Route GatewayPluginVaultAuthRoute
    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 GatewayPluginVaultAuthService
    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 GatewayPluginVaultAuthConfigArgs
    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.
    GatewayPluginVaultAuthId string
    The ID of this resource.
    InstanceName string
    Ordering GatewayPluginVaultAuthOrderingArgs
    Protocols []string
    A set of strings representing HTTP protocols.
    Route GatewayPluginVaultAuthRouteArgs
    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 GatewayPluginVaultAuthServiceArgs
    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 GatewayPluginVaultAuthConfig
    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.
    gatewayPluginVaultAuthId String
    The ID of this resource.
    instanceName String
    ordering GatewayPluginVaultAuthOrdering
    protocols List<String>
    A set of strings representing HTTP protocols.
    route GatewayPluginVaultAuthRoute
    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 GatewayPluginVaultAuthService
    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 GatewayPluginVaultAuthConfig
    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.
    gatewayPluginVaultAuthId string
    The ID of this resource.
    instanceName string
    ordering GatewayPluginVaultAuthOrdering
    protocols string[]
    A set of strings representing HTTP protocols.
    route GatewayPluginVaultAuthRoute
    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 GatewayPluginVaultAuthService
    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 GatewayPluginVaultAuthConfigArgs
    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_vault_auth_id str
    The ID of this resource.
    instance_name str
    ordering GatewayPluginVaultAuthOrderingArgs
    protocols Sequence[str]
    A set of strings representing HTTP protocols.
    route GatewayPluginVaultAuthRouteArgs
    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 GatewayPluginVaultAuthServiceArgs
    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.
    gatewayPluginVaultAuthId String
    The ID of this resource.
    instanceName String
    ordering Property Map
    protocols List<String>
    A set of strings representing HTTP protocols.
    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

    GatewayPluginVaultAuthConfig, GatewayPluginVaultAuthConfigArgs

    AccessTokenName string
    Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    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. 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 header or querystring containing the key) before proxying it.
    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 will always be allowed.
    SecretTokenName string
    Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    TokensInBody bool
    If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are application/www-form-urlencoded, application/json, and multipart/form-data.
    Vault string
    A reference to an existing vault object within the database. vault entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.
    AccessTokenName string
    Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    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. 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 header or querystring containing the key) before proxying it.
    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 will always be allowed.
    SecretTokenName string
    Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    TokensInBody bool
    If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are application/www-form-urlencoded, application/json, and multipart/form-data.
    Vault string
    A reference to an existing vault object within the database. vault entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.
    accessTokenName String
    Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    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. 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 header or querystring containing the key) before proxying it.
    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 will always be allowed.
    secretTokenName String
    Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    tokensInBody Boolean
    If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are application/www-form-urlencoded, application/json, and multipart/form-data.
    vault String
    A reference to an existing vault object within the database. vault entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.
    accessTokenName string
    Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    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. 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 header or querystring containing the key) before proxying it.
    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 will always be allowed.
    secretTokenName string
    Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    tokensInBody boolean
    If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are application/www-form-urlencoded, application/json, and multipart/form-data.
    vault string
    A reference to an existing vault object within the database. vault entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.
    access_token_name str
    Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    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. 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 header or querystring containing the key) before proxying it.
    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 will always be allowed.
    secret_token_name str
    Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    tokens_in_body bool
    If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are application/www-form-urlencoded, application/json, and multipart/form-data.
    vault str
    A reference to an existing vault object within the database. vault entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.
    accessTokenName String
    Describes an array of comma-separated parameter names where the plugin looks for an access token. The client must send the access token in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    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. 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 header or querystring containing the key) before proxying it.
    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 will always be allowed.
    secretTokenName String
    Describes an array of comma-separated parameter names where the plugin looks for a secret token. The client must send the secret in one of those key names, and the plugin will try to read the credential from a header or the querystring parameter with the same name. The key names can only contain [a-z], [A-Z], [0-9], [_], and [-].
    tokensInBody Boolean
    If enabled, the plugin will read the request body (if said request has one and its MIME type is supported) and try to find the key in it. Supported MIME types are application/www-form-urlencoded, application/json, and multipart/form-data.
    vault String
    A reference to an existing vault object within the database. vault entities define the connection and authentication parameters used to connect to a Vault HTTP(S) API.

    GatewayPluginVaultAuthOrdering, GatewayPluginVaultAuthOrderingArgs

    GatewayPluginVaultAuthOrderingAfter, GatewayPluginVaultAuthOrderingAfterArgs

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

    GatewayPluginVaultAuthOrderingBefore, GatewayPluginVaultAuthOrderingBeforeArgs

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

    GatewayPluginVaultAuthRoute, GatewayPluginVaultAuthRouteArgs

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

    GatewayPluginVaultAuthService, GatewayPluginVaultAuthServiceArgs

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

    Import

    $ pulumi import konnect:index/gatewayPluginVaultAuth:GatewayPluginVaultAuth my_konnect_gateway_plugin_vault_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