1. Packages
  2. Kong
  3. API Docs
  4. ConsumerBasicAuth
Kong v4.5.1 published on Friday, Jan 19, 2024 by Pulumi

kong.ConsumerBasicAuth

Explore with Pulumi AI

kong logo
Kong v4.5.1 published on Friday, Jan 19, 2024 by Pulumi

    # kong.ConsumerBasicAuth

    Consumer basic auth is a resource that allows you to configure the basic auth plugin for a consumer.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Kong = Pulumi.Kong;
    
    return await Deployment.RunAsync(() => 
    {
        var myConsumer = new Kong.Consumer("myConsumer", new()
        {
            CustomId = "123",
            Username = "User1",
        });
    
        var basicAuthPlugin = new Kong.Plugin("basicAuthPlugin");
    
        var consumerBasicAuth = new Kong.ConsumerBasicAuth("consumerBasicAuth", new()
        {
            ConsumerId = myConsumer.Id,
            Password = "bar_updated",
            Tags = new[]
            {
                "myTag",
                "anotherTag",
            },
            Username = "foo_updated",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		myConsumer, err := kong.NewConsumer(ctx, "myConsumer", &kong.ConsumerArgs{
    			CustomId: pulumi.String("123"),
    			Username: pulumi.String("User1"),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = kong.NewPlugin(ctx, "basicAuthPlugin", nil)
    		if err != nil {
    			return err
    		}
    		_, err = kong.NewConsumerBasicAuth(ctx, "consumerBasicAuth", &kong.ConsumerBasicAuthArgs{
    			ConsumerId: myConsumer.ID(),
    			Password:   pulumi.String("bar_updated"),
    			Tags: pulumi.StringArray{
    				pulumi.String("myTag"),
    				pulumi.String("anotherTag"),
    			},
    			Username: pulumi.String("foo_updated"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.kong.Consumer;
    import com.pulumi.kong.ConsumerArgs;
    import com.pulumi.kong.Plugin;
    import com.pulumi.kong.ConsumerBasicAuth;
    import com.pulumi.kong.ConsumerBasicAuthArgs;
    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 myConsumer = new Consumer("myConsumer", ConsumerArgs.builder()        
                .customId("123")
                .username("User1")
                .build());
    
            var basicAuthPlugin = new Plugin("basicAuthPlugin");
    
            var consumerBasicAuth = new ConsumerBasicAuth("consumerBasicAuth", ConsumerBasicAuthArgs.builder()        
                .consumerId(myConsumer.id())
                .password("bar_updated")
                .tags(            
                    "myTag",
                    "anotherTag")
                .username("foo_updated")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_kong as kong
    
    my_consumer = kong.Consumer("myConsumer",
        custom_id="123",
        username="User1")
    basic_auth_plugin = kong.Plugin("basicAuthPlugin")
    consumer_basic_auth = kong.ConsumerBasicAuth("consumerBasicAuth",
        consumer_id=my_consumer.id,
        password="bar_updated",
        tags=[
            "myTag",
            "anotherTag",
        ],
        username="foo_updated")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as kong from "@pulumi/kong";
    
    const myConsumer = new kong.Consumer("myConsumer", {
        customId: "123",
        username: "User1",
    });
    const basicAuthPlugin = new kong.Plugin("basicAuthPlugin", {});
    const consumerBasicAuth = new kong.ConsumerBasicAuth("consumerBasicAuth", {
        consumerId: myConsumer.id,
        password: "bar_updated",
        tags: [
            "myTag",
            "anotherTag",
        ],
        username: "foo_updated",
    });
    
    resources:
      myConsumer:
        type: kong:Consumer
        properties:
          customId: '123'
          username: User1
      basicAuthPlugin:
        type: kong:Plugin
      consumerBasicAuth:
        type: kong:ConsumerBasicAuth
        properties:
          consumerId: ${myConsumer.id}
          password: bar_updated
          tags:
            - myTag
            - anotherTag
          username: foo_updated
    

    Create ConsumerBasicAuth Resource

    new ConsumerBasicAuth(name: string, args: ConsumerBasicAuthArgs, opts?: CustomResourceOptions);
    @overload
    def ConsumerBasicAuth(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          consumer_id: Optional[str] = None,
                          password: Optional[str] = None,
                          tags: Optional[Sequence[str]] = None,
                          username: Optional[str] = None)
    @overload
    def ConsumerBasicAuth(resource_name: str,
                          args: ConsumerBasicAuthArgs,
                          opts: Optional[ResourceOptions] = None)
    func NewConsumerBasicAuth(ctx *Context, name string, args ConsumerBasicAuthArgs, opts ...ResourceOption) (*ConsumerBasicAuth, error)
    public ConsumerBasicAuth(string name, ConsumerBasicAuthArgs args, CustomResourceOptions? opts = null)
    public ConsumerBasicAuth(String name, ConsumerBasicAuthArgs args)
    public ConsumerBasicAuth(String name, ConsumerBasicAuthArgs args, CustomResourceOptions options)
    
    type: kong:ConsumerBasicAuth
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args ConsumerBasicAuthArgs
    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 ConsumerBasicAuthArgs
    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 ConsumerBasicAuthArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConsumerBasicAuthArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConsumerBasicAuthArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ConsumerBasicAuth Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConsumerBasicAuth resource accepts the following input properties:

    ConsumerId string
    the id of the consumer to be configured with basic auth
    Password string
    password to be used for basic auth
    Username string
    username to be used for basic auth
    Tags List<string>
    A list of strings associated with the consumer basic auth for grouping and filtering
    ConsumerId string
    the id of the consumer to be configured with basic auth
    Password string
    password to be used for basic auth
    Username string
    username to be used for basic auth
    Tags []string
    A list of strings associated with the consumer basic auth for grouping and filtering
    consumerId String
    the id of the consumer to be configured with basic auth
    password String
    password to be used for basic auth
    username String
    username to be used for basic auth
    tags List<String>
    A list of strings associated with the consumer basic auth for grouping and filtering
    consumerId string
    the id of the consumer to be configured with basic auth
    password string
    password to be used for basic auth
    username string
    username to be used for basic auth
    tags string[]
    A list of strings associated with the consumer basic auth for grouping and filtering
    consumer_id str
    the id of the consumer to be configured with basic auth
    password str
    password to be used for basic auth
    username str
    username to be used for basic auth
    tags Sequence[str]
    A list of strings associated with the consumer basic auth for grouping and filtering
    consumerId String
    the id of the consumer to be configured with basic auth
    password String
    password to be used for basic auth
    username String
    username to be used for basic auth
    tags List<String>
    A list of strings associated with the consumer basic auth for grouping and filtering

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConsumerBasicAuth 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 ConsumerBasicAuth Resource

    Get an existing ConsumerBasicAuth 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?: ConsumerBasicAuthState, opts?: CustomResourceOptions): ConsumerBasicAuth
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            consumer_id: Optional[str] = None,
            password: Optional[str] = None,
            tags: Optional[Sequence[str]] = None,
            username: Optional[str] = None) -> ConsumerBasicAuth
    func GetConsumerBasicAuth(ctx *Context, name string, id IDInput, state *ConsumerBasicAuthState, opts ...ResourceOption) (*ConsumerBasicAuth, error)
    public static ConsumerBasicAuth Get(string name, Input<string> id, ConsumerBasicAuthState? state, CustomResourceOptions? opts = null)
    public static ConsumerBasicAuth get(String name, Output<String> id, ConsumerBasicAuthState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    ConsumerId string
    the id of the consumer to be configured with basic auth
    Password string
    password to be used for basic auth
    Tags List<string>
    A list of strings associated with the consumer basic auth for grouping and filtering
    Username string
    username to be used for basic auth
    ConsumerId string
    the id of the consumer to be configured with basic auth
    Password string
    password to be used for basic auth
    Tags []string
    A list of strings associated with the consumer basic auth for grouping and filtering
    Username string
    username to be used for basic auth
    consumerId String
    the id of the consumer to be configured with basic auth
    password String
    password to be used for basic auth
    tags List<String>
    A list of strings associated with the consumer basic auth for grouping and filtering
    username String
    username to be used for basic auth
    consumerId string
    the id of the consumer to be configured with basic auth
    password string
    password to be used for basic auth
    tags string[]
    A list of strings associated with the consumer basic auth for grouping and filtering
    username string
    username to be used for basic auth
    consumer_id str
    the id of the consumer to be configured with basic auth
    password str
    password to be used for basic auth
    tags Sequence[str]
    A list of strings associated with the consumer basic auth for grouping and filtering
    username str
    username to be used for basic auth
    consumerId String
    the id of the consumer to be configured with basic auth
    password String
    password to be used for basic auth
    tags List<String>
    A list of strings associated with the consumer basic auth for grouping and filtering
    username String
    username to be used for basic auth

    Package Details

    Repository
    Kong pulumi/pulumi-kong
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the kong Terraform Provider.
    kong logo
    Kong v4.5.1 published on Friday, Jan 19, 2024 by Pulumi