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

konnect.GatewayKeyAuth

Explore with Pulumi AI

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

    GatewayKeyAuth Resource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as konnect from "@pulumi/konnect";

const myGatewaykeyauth = new konnect.GatewayKeyAuth("myGatewaykeyauth", {
    consumer: {
        id: "...my_id...",
    },
    consumerId: "f28acbfa-c866-4587-b688-0208ac24df21",
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    gatewayKeyAuthId: "...my_id...",
    key: "...my_key...",
    tags: ["..."],
});

    import pulumi
import pulumi_konnect as konnect

my_gatewaykeyauth = konnect.GatewayKeyAuth("myGatewaykeyauth",
    consumer={
        "id": "...my_id...",
    },
    consumer_id="f28acbfa-c866-4587-b688-0208ac24df21",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    gateway_key_auth_id="...my_id...",
    key="...my_key...",
    tags=["..."])

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/konnect/v2/konnect"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := konnect.NewGatewayKeyAuth(ctx, "myGatewaykeyauth", &konnect.GatewayKeyAuthArgs{
			Consumer: &konnect.GatewayKeyAuthConsumerArgs{
				Id: pulumi.String("...my_id..."),
			},
			ConsumerId:       pulumi.String("f28acbfa-c866-4587-b688-0208ac24df21"),
			ControlPlaneId:   pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			GatewayKeyAuthId: pulumi.String("...my_id..."),
			Key:              pulumi.String("...my_key..."),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewaykeyauth = new Konnect.GatewayKeyAuth("myGatewaykeyauth", new()
    {
        Consumer = new Konnect.Inputs.GatewayKeyAuthConsumerArgs
        {
            Id = "...my_id...",
        },
        ConsumerId = "f28acbfa-c866-4587-b688-0208ac24df21",
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        GatewayKeyAuthId = "...my_id...",
        Key = "...my_key...",
        Tags = new[]
        {
            "...",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayKeyAuth;
import com.pulumi.konnect.GatewayKeyAuthArgs;
import com.pulumi.konnect.inputs.GatewayKeyAuthConsumerArgs;
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 myGatewaykeyauth = new GatewayKeyAuth("myGatewaykeyauth", GatewayKeyAuthArgs.builder()
            .consumer(GatewayKeyAuthConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerId("f28acbfa-c866-4587-b688-0208ac24df21")
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .gatewayKeyAuthId("...my_id...")
            .key("...my_key...")
            .tags("...")
            .build());

    }
}

    resources:
  myGatewaykeyauth:
    type: konnect:GatewayKeyAuth
    properties:
      consumer:
        id: '...my_id...'
      consumerId: f28acbfa-c866-4587-b688-0208ac24df21
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      gatewayKeyAuthId: '...my_id...'
      key: '...my_key...'
      tags:
        - '...'

    Create GatewayKeyAuth Resource

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

    Constructor syntax

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

@overload
def GatewayKeyAuth(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   consumer_id: Optional[str] = None,
                   control_plane_id: Optional[str] = None,
                   key: Optional[str] = None,
                   consumer: Optional[GatewayKeyAuthConsumerArgs] = None,
                   gateway_key_auth_id: Optional[str] = None,
                   tags: Optional[Sequence[str]] = None)
    func NewGatewayKeyAuth(ctx *Context, name string, args GatewayKeyAuthArgs, opts ...ResourceOption) (*GatewayKeyAuth, error)
    public GatewayKeyAuth(string name, GatewayKeyAuthArgs args, CustomResourceOptions? opts = null)
    public GatewayKeyAuth(String name, GatewayKeyAuthArgs args)
public GatewayKeyAuth(String name, GatewayKeyAuthArgs args, CustomResourceOptions options)

    type: konnect:GatewayKeyAuth
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 GatewayKeyAuthArgs
    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 GatewayKeyAuthArgs
    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 GatewayKeyAuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayKeyAuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayKeyAuthArgs
    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 gatewayKeyAuthResource = new Konnect.GatewayKeyAuth("gatewayKeyAuthResource", new()
{
    ConsumerId = "string",
    ControlPlaneId = "string",
    Key = "string",
    Consumer = new Konnect.Inputs.GatewayKeyAuthConsumerArgs
    {
        Id = "string",
    },
    GatewayKeyAuthId = "string",
    Tags = new[]
    {
        "string",
    },
});

    example, err := konnect.NewGatewayKeyAuth(ctx, "gatewayKeyAuthResource", &konnect.GatewayKeyAuthArgs{
ConsumerId: pulumi.String("string"),
ControlPlaneId: pulumi.String("string"),
Key: pulumi.String("string"),
Consumer: &.GatewayKeyAuthConsumerArgs{
Id: pulumi.String("string"),
},
GatewayKeyAuthId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

    var gatewayKeyAuthResource = new GatewayKeyAuth("gatewayKeyAuthResource", GatewayKeyAuthArgs.builder()
    .consumerId("string")
    .controlPlaneId("string")
    .key("string")
    .consumer(GatewayKeyAuthConsumerArgs.builder()
        .id("string")
        .build())
    .gatewayKeyAuthId("string")
    .tags("string")
    .build());

    gateway_key_auth_resource = konnect.GatewayKeyAuth("gatewayKeyAuthResource",
    consumer_id="string",
    control_plane_id="string",
    key="string",
    consumer={
        "id": "string",
    },
    gateway_key_auth_id="string",
    tags=["string"])

    const gatewayKeyAuthResource = new konnect.GatewayKeyAuth("gatewayKeyAuthResource", {
    consumerId: "string",
    controlPlaneId: "string",
    key: "string",
    consumer: {
        id: "string",
    },
    gatewayKeyAuthId: "string",
    tags: ["string"],
});

    type: konnect:GatewayKeyAuth
properties:
    consumer:
        id: string
    consumerId: string
    controlPlaneId: string
    gatewayKeyAuthId: string
    key: string
    tags:
        - string

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

    ConsumerId string
    Consumer ID for nested entities. Requires replacement if changed.
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Key string
    Requires replacement if changed.
    Consumer GatewayKeyAuthConsumer
    Requires replacement if changed.
    GatewayKeyAuthId string
    Requires replacement if changed.
    Tags List<string>
    Requires replacement if changed.
    ConsumerId string
    Consumer ID for nested entities. Requires replacement if changed.
    ControlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    Key string
    Requires replacement if changed.
    Consumer GatewayKeyAuthConsumerArgs
    Requires replacement if changed.
    GatewayKeyAuthId string
    Requires replacement if changed.
    Tags []string
    Requires replacement if changed.
    consumerId String
    Consumer ID for nested entities. Requires replacement if changed.
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    key String
    Requires replacement if changed.
    consumer GatewayKeyAuthConsumer
    Requires replacement if changed.
    gatewayKeyAuthId String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.
    consumerId string
    Consumer ID for nested entities. Requires replacement if changed.
    controlPlaneId string
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    key string
    Requires replacement if changed.
    consumer GatewayKeyAuthConsumer
    Requires replacement if changed.
    gatewayKeyAuthId string
    Requires replacement if changed.
    tags string[]
    Requires replacement if changed.
    consumer_id str
    Consumer ID for nested entities. Requires replacement if changed.
    control_plane_id str
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    key str
    Requires replacement if changed.
    consumer GatewayKeyAuthConsumerArgs
    Requires replacement if changed.
    gateway_key_auth_id str
    Requires replacement if changed.
    tags Sequence[str]
    Requires replacement if changed.
    consumerId String
    Consumer ID for nested entities. Requires replacement if changed.
    controlPlaneId String
    The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
    key String
    Requires replacement if changed.
    consumer Property Map
    Requires replacement if changed.
    gatewayKeyAuthId String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GatewayKeyAuth 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.
    CreatedAt float64
    Unix epoch when the resource was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdAt Double
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.
    createdAt number
    Unix epoch when the resource was created.
    id string
    The provider-assigned unique ID for this managed resource.
    created_at float
    Unix epoch when the resource was created.
    id str
    The provider-assigned unique ID for this managed resource.
    createdAt Number
    Unix epoch when the resource was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing GatewayKeyAuth Resource

    Get an existing GatewayKeyAuth 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?: GatewayKeyAuthState, opts?: CustomResourceOptions): GatewayKeyAuth
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer: Optional[GatewayKeyAuthConsumerArgs] = None,
        consumer_id: Optional[str] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        gateway_key_auth_id: Optional[str] = None,
        key: Optional[str] = None,
        tags: Optional[Sequence[str]] = None) -> GatewayKeyAuth
    func GetGatewayKeyAuth(ctx *Context, name string, id IDInput, state *GatewayKeyAuthState, opts ...ResourceOption) (*GatewayKeyAuth, error)
    public static GatewayKeyAuth Get(string name, Input<string> id, GatewayKeyAuthState? state, CustomResourceOptions? opts = null)
    public static GatewayKeyAuth get(String name, Output<String> id, GatewayKeyAuthState state, CustomResourceOptions options)
    resources:  _:    type: konnect:GatewayKeyAuth    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:
    Consumer GatewayKeyAuthConsumer
    Requires replacement if changed.
    ConsumerId string
    Consumer ID for nested entities. Requires replacement if changed.
    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.
    GatewayKeyAuthId string
    Requires replacement if changed.
    Key string
    Requires replacement if changed.
    Tags List<string>
    Requires replacement if changed.
    Consumer GatewayKeyAuthConsumerArgs
    Requires replacement if changed.
    ConsumerId string
    Consumer ID for nested entities. Requires replacement if changed.
    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.
    GatewayKeyAuthId string
    Requires replacement if changed.
    Key string
    Requires replacement if changed.
    Tags []string
    Requires replacement if changed.
    consumer GatewayKeyAuthConsumer
    Requires replacement if changed.
    consumerId String
    Consumer ID for nested entities. Requires replacement if changed.
    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.
    gatewayKeyAuthId String
    Requires replacement if changed.
    key String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.
    consumer GatewayKeyAuthConsumer
    Requires replacement if changed.
    consumerId string
    Consumer ID for nested entities. Requires replacement if changed.
    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.
    gatewayKeyAuthId string
    Requires replacement if changed.
    key string
    Requires replacement if changed.
    tags string[]
    Requires replacement if changed.
    consumer GatewayKeyAuthConsumerArgs
    Requires replacement if changed.
    consumer_id str
    Consumer ID for nested entities. Requires replacement if changed.
    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.
    gateway_key_auth_id str
    Requires replacement if changed.
    key str
    Requires replacement if changed.
    tags Sequence[str]
    Requires replacement if changed.
    consumer Property Map
    Requires replacement if changed.
    consumerId String
    Consumer ID for nested entities. Requires replacement if changed.
    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.
    gatewayKeyAuthId String
    Requires replacement if changed.
    key String
    Requires replacement if changed.
    tags List<String>
    Requires replacement if changed.

    Supporting Types

    GatewayKeyAuthConsumer, GatewayKeyAuthConsumerArgs

    Id string
    Requires replacement if changed.
    Id string
    Requires replacement if changed.
    id String
    Requires replacement if changed.
    id string
    Requires replacement if changed.
    id str
    Requires replacement if changed.
    id String
    Requires replacement if changed.

    Import

    $ pulumi import konnect:index/gatewayKeyAuth:GatewayKeyAuth my_konnect_gateway_key_auth "{ \"consumer_id\": \"f28acbfa-c866-4587-b688-0208ac24df21\", \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"key_auth_id\": \"\"}"

    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