@pulumi/kong/consumerBasicAuth.d.ts

A Pulumi package for creating and managing Kong resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * ## # kong.ConsumerBasicAuth
 *
 * Consumer basic auth is a resource that allows you to configure the basic auth plugin for a consumer.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as kong from "@pulumi/kong";
 *
 * const myConsumer = new kong.Consumer("my_consumer", {
 *     username: "User1",
 *     customId: "123",
 * });
 * const basicAuthPlugin = new kong.Plugin("basic_auth_plugin", {name: "basic-auth"});
 * const consumerBasicAuth = new kong.ConsumerBasicAuth("consumer_basic_auth", {
 *     consumerId: myConsumer.id,
 *     username: "foo_updated",
 *     password: "bar_updated",
 *     tags: [
 *         "myTag",
 *         "anotherTag",
 *     ],
 * });
 * ```
 */
export declare class ConsumerBasicAuth extends pulumi.CustomResource {
    /**
     * Get an existing ConsumerBasicAuth resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConsumerBasicAuthState, opts?: pulumi.CustomResourceOptions): ConsumerBasicAuth;
    /**
     * Returns true if the given object is an instance of ConsumerBasicAuth.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    static isInstance(obj: any): obj is ConsumerBasicAuth;
    /**
     * the id of the consumer to be configured with basic auth
     */
    readonly consumerId: pulumi.Output<string>;
    /**
     * password to be used for basic auth
     */
    readonly password: pulumi.Output<string>;
    /**
     * A list of strings associated with the consumer basic auth for grouping and filtering
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * username to be used for basic auth
     */
    readonly username: pulumi.Output<string>;
    /**
     * Create a ConsumerBasicAuth resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: ConsumerBasicAuthArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering ConsumerBasicAuth resources.
 */
export interface ConsumerBasicAuthState {
    /**
     * the id of the consumer to be configured with basic auth
     */
    consumerId?: pulumi.Input<string>;
    /**
     * password to be used for basic auth
     */
    password?: pulumi.Input<string>;
    /**
     * A list of strings associated with the consumer basic auth for grouping and filtering
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * username to be used for basic auth
     */
    username?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a ConsumerBasicAuth resource.
 */
export interface ConsumerBasicAuthArgs {
    /**
     * the id of the consumer to be configured with basic auth
     */
    consumerId: pulumi.Input<string>;
    /**
     * password to be used for basic auth
     */
    password: pulumi.Input<string>;
    /**
     * A list of strings associated with the consumer basic auth for grouping and filtering
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * username to be used for basic auth
     */
    username: pulumi.Input<string>;
}