Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. GatewayBasicAuth
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.GatewayBasicAuth

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

GatewayBasicAuth Resource

Example Usage

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

const myGatewaybasicauth = new konnect.GatewayBasicAuth("myGatewaybasicauth", {
    consumer: {
        id: "...my_id...",
    },
    consumerId: "f28acbfa-c866-4587-b688-0208ac24df21",
    controlPlaneId: "9524ec7d-36d9-465d-a8c5-83a3c9390458",
    createdAt: 5,
    gatewayBasicAuthId: "...my_id...",
    password: "...my_password...",
    tags: ["..."],
    username: "...my_username...",
});
Copy
import pulumi
import pulumi_konnect as konnect

my_gatewaybasicauth = konnect.GatewayBasicAuth("myGatewaybasicauth",
    consumer={
        "id": "...my_id...",
    },
    consumer_id="f28acbfa-c866-4587-b688-0208ac24df21",
    control_plane_id="9524ec7d-36d9-465d-a8c5-83a3c9390458",
    created_at=5,
    gateway_basic_auth_id="...my_id...",
    password="...my_password...",
    tags=["..."],
    username="...my_username...")
Copy
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.NewGatewayBasicAuth(ctx, "myGatewaybasicauth", &konnect.GatewayBasicAuthArgs{
			Consumer: &konnect.GatewayBasicAuthConsumerArgs{
				Id: pulumi.String("...my_id..."),
			},
			ConsumerId:         pulumi.String("f28acbfa-c866-4587-b688-0208ac24df21"),
			ControlPlaneId:     pulumi.String("9524ec7d-36d9-465d-a8c5-83a3c9390458"),
			CreatedAt:          pulumi.Float64(5),
			GatewayBasicAuthId: pulumi.String("...my_id..."),
			Password:           pulumi.String("...my_password..."),
			Tags: pulumi.StringArray{
				pulumi.String("..."),
			},
			Username: pulumi.String("...my_username..."),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Konnect = Pulumi.Konnect;

return await Deployment.RunAsync(() => 
{
    var myGatewaybasicauth = new Konnect.GatewayBasicAuth("myGatewaybasicauth", new()
    {
        Consumer = new Konnect.Inputs.GatewayBasicAuthConsumerArgs
        {
            Id = "...my_id...",
        },
        ConsumerId = "f28acbfa-c866-4587-b688-0208ac24df21",
        ControlPlaneId = "9524ec7d-36d9-465d-a8c5-83a3c9390458",
        CreatedAt = 5,
        GatewayBasicAuthId = "...my_id...",
        Password = "...my_password...",
        Tags = new[]
        {
            "...",
        },
        Username = "...my_username...",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayBasicAuth;
import com.pulumi.konnect.GatewayBasicAuthArgs;
import com.pulumi.konnect.inputs.GatewayBasicAuthConsumerArgs;
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 myGatewaybasicauth = new GatewayBasicAuth("myGatewaybasicauth", GatewayBasicAuthArgs.builder()
            .consumer(GatewayBasicAuthConsumerArgs.builder()
                .id("...my_id...")
                .build())
            .consumerId("f28acbfa-c866-4587-b688-0208ac24df21")
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .createdAt(5)
            .gatewayBasicAuthId("...my_id...")
            .password("...my_password...")
            .tags("...")
            .username("...my_username...")
            .build());

    }
}
Copy
resources:
  myGatewaybasicauth:
    type: konnect:GatewayBasicAuth
    properties:
      consumer:
        id: '...my_id...'
      consumerId: f28acbfa-c866-4587-b688-0208ac24df21
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      createdAt: 5
      gatewayBasicAuthId: '...my_id...'
      password: '...my_password...'
      tags:
        - '...'
      username: '...my_username...'
Copy

Create GatewayBasicAuth Resource

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

Constructor syntax

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

@overload
def GatewayBasicAuth(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     consumer_id: Optional[str] = None,
                     control_plane_id: Optional[str] = None,
                     password: Optional[str] = None,
                     username: Optional[str] = None,
                     consumer: Optional[GatewayBasicAuthConsumerArgs] = None,
                     created_at: Optional[float] = None,
                     gateway_basic_auth_id: Optional[str] = None,
                     tags: Optional[Sequence[str]] = None)
func NewGatewayBasicAuth(ctx *Context, name string, args GatewayBasicAuthArgs, opts ...ResourceOption) (*GatewayBasicAuth, error)
public GatewayBasicAuth(string name, GatewayBasicAuthArgs args, CustomResourceOptions? opts = null)
public GatewayBasicAuth(String name, GatewayBasicAuthArgs args)
public GatewayBasicAuth(String name, GatewayBasicAuthArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayBasicAuthArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayBasicAuthArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayBasicAuthArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayBasicAuthArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayBasicAuthArgs
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 gatewayBasicAuthResource = new Konnect.GatewayBasicAuth("gatewayBasicAuthResource", new()
{
    ConsumerId = "string",
    ControlPlaneId = "string",
    Password = "string",
    Username = "string",
    Consumer = new Konnect.Inputs.GatewayBasicAuthConsumerArgs
    {
        Id = "string",
    },
    CreatedAt = 0,
    GatewayBasicAuthId = "string",
    Tags = new[]
    {
        "string",
    },
});
Copy
example, err := konnect.NewGatewayBasicAuth(ctx, "gatewayBasicAuthResource", &konnect.GatewayBasicAuthArgs{
ConsumerId: pulumi.String("string"),
ControlPlaneId: pulumi.String("string"),
Password: pulumi.String("string"),
Username: pulumi.String("string"),
Consumer: &.GatewayBasicAuthConsumerArgs{
Id: pulumi.String("string"),
},
CreatedAt: pulumi.Float64(0),
GatewayBasicAuthId: pulumi.String("string"),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})
Copy
var gatewayBasicAuthResource = new GatewayBasicAuth("gatewayBasicAuthResource", GatewayBasicAuthArgs.builder()
    .consumerId("string")
    .controlPlaneId("string")
    .password("string")
    .username("string")
    .consumer(GatewayBasicAuthConsumerArgs.builder()
        .id("string")
        .build())
    .createdAt(0)
    .gatewayBasicAuthId("string")
    .tags("string")
    .build());
Copy
gateway_basic_auth_resource = konnect.GatewayBasicAuth("gatewayBasicAuthResource",
    consumer_id="string",
    control_plane_id="string",
    password="string",
    username="string",
    consumer={
        "id": "string",
    },
    created_at=0,
    gateway_basic_auth_id="string",
    tags=["string"])
Copy
const gatewayBasicAuthResource = new konnect.GatewayBasicAuth("gatewayBasicAuthResource", {
    consumerId: "string",
    controlPlaneId: "string",
    password: "string",
    username: "string",
    consumer: {
        id: "string",
    },
    createdAt: 0,
    gatewayBasicAuthId: "string",
    tags: ["string"],
});
Copy
type: konnect:GatewayBasicAuth
properties:
    consumer:
        id: string
    consumerId: string
    controlPlaneId: string
    createdAt: 0
    gatewayBasicAuthId: string
    password: string
    tags:
        - string
    username: string
Copy

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

ConsumerId This property is required. string
Consumer ID for nested entities. Requires replacement if changed.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Password This property is required. string
Requires replacement if changed.
Username This property is required. string
Requires replacement if changed.
Consumer GatewayBasicAuthConsumer
Requires replacement if changed.
CreatedAt double
Unix epoch when the resource was created. Requires replacement if changed.
GatewayBasicAuthId string
Requires replacement if changed.
Tags List<string>
Requires replacement if changed.
ConsumerId This property is required. string
Consumer ID for nested entities. Requires replacement if changed.
ControlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Password This property is required. string
Requires replacement if changed.
Username This property is required. string
Requires replacement if changed.
Consumer GatewayBasicAuthConsumerArgs
Requires replacement if changed.
CreatedAt float64
Unix epoch when the resource was created. Requires replacement if changed.
GatewayBasicAuthId string
Requires replacement if changed.
Tags []string
Requires replacement if changed.
consumerId This property is required. String
Consumer ID for nested entities. Requires replacement if changed.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
password This property is required. String
Requires replacement if changed.
username This property is required. String
Requires replacement if changed.
consumer GatewayBasicAuthConsumer
Requires replacement if changed.
createdAt Double
Unix epoch when the resource was created. Requires replacement if changed.
gatewayBasicAuthId String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.
consumerId This property is required. string
Consumer ID for nested entities. Requires replacement if changed.
controlPlaneId This property is required. string
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
password This property is required. string
Requires replacement if changed.
username This property is required. string
Requires replacement if changed.
consumer GatewayBasicAuthConsumer
Requires replacement if changed.
createdAt number
Unix epoch when the resource was created. Requires replacement if changed.
gatewayBasicAuthId string
Requires replacement if changed.
tags string[]
Requires replacement if changed.
consumer_id This property is required. str
Consumer ID for nested entities. Requires replacement if changed.
control_plane_id This property is required. str
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
password This property is required. str
Requires replacement if changed.
username This property is required. str
Requires replacement if changed.
consumer GatewayBasicAuthConsumerArgs
Requires replacement if changed.
created_at float
Unix epoch when the resource was created. Requires replacement if changed.
gateway_basic_auth_id str
Requires replacement if changed.
tags Sequence[str]
Requires replacement if changed.
consumerId This property is required. String
Consumer ID for nested entities. Requires replacement if changed.
controlPlaneId This property is required. String
The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
password This property is required. String
Requires replacement if changed.
username This property is required. String
Requires replacement if changed.
consumer Property Map
Requires replacement if changed.
createdAt Number
Unix epoch when the resource was created. Requires replacement if changed.
gatewayBasicAuthId String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayBasicAuth resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GatewayBasicAuth Resource

Get an existing GatewayBasicAuth 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?: GatewayBasicAuthState, opts?: CustomResourceOptions): GatewayBasicAuth
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        consumer: Optional[GatewayBasicAuthConsumerArgs] = None,
        consumer_id: Optional[str] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        gateway_basic_auth_id: Optional[str] = None,
        password: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        username: Optional[str] = None) -> GatewayBasicAuth
func GetGatewayBasicAuth(ctx *Context, name string, id IDInput, state *GatewayBasicAuthState, opts ...ResourceOption) (*GatewayBasicAuth, error)
public static GatewayBasicAuth Get(string name, Input<string> id, GatewayBasicAuthState? state, CustomResourceOptions? opts = null)
public static GatewayBasicAuth get(String name, Output<String> id, GatewayBasicAuthState state, CustomResourceOptions options)
resources:  _:    type: konnect:GatewayBasicAuth    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 GatewayBasicAuthConsumer
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. Requires replacement if changed.
GatewayBasicAuthId string
Requires replacement if changed.
Password string
Requires replacement if changed.
Tags List<string>
Requires replacement if changed.
Username string
Requires replacement if changed.
Consumer GatewayBasicAuthConsumerArgs
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. Requires replacement if changed.
GatewayBasicAuthId string
Requires replacement if changed.
Password string
Requires replacement if changed.
Tags []string
Requires replacement if changed.
Username string
Requires replacement if changed.
consumer GatewayBasicAuthConsumer
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. Requires replacement if changed.
gatewayBasicAuthId String
Requires replacement if changed.
password String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.
username String
Requires replacement if changed.
consumer GatewayBasicAuthConsumer
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. Requires replacement if changed.
gatewayBasicAuthId string
Requires replacement if changed.
password string
Requires replacement if changed.
tags string[]
Requires replacement if changed.
username string
Requires replacement if changed.
consumer GatewayBasicAuthConsumerArgs
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. Requires replacement if changed.
gateway_basic_auth_id str
Requires replacement if changed.
password str
Requires replacement if changed.
tags Sequence[str]
Requires replacement if changed.
username 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. Requires replacement if changed.
gatewayBasicAuthId String
Requires replacement if changed.
password String
Requires replacement if changed.
tags List<String>
Requires replacement if changed.
username String
Requires replacement if changed.

Supporting Types

GatewayBasicAuthConsumer
, GatewayBasicAuthConsumerArgs

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/gatewayBasicAuth:GatewayBasicAuth my_konnect_gateway_basic_auth "{ \"id\": \"80db1b58-ca7c-4d21-b92a-64eb07725872\", \"consumer_id\": \"f28acbfa-c866-4587-b688-0208ac24df21\", \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\"}"
Copy

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

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect