@pulumiverse/cockroach/getConnectionString.d.ts

A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Generic connection string for a cluster.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cockroach from "@pulumi/cockroach";
 *
 * const config = new pulumi.Config();
 * const clusterId = config.require("clusterId");
 * const sqlUserName = config.require("sqlUserName");
 * const sqlUserPassword = config.require("sqlUserPassword");
 * const database = config.require("database");
 * const os = config.require("os");
 * const cockroach = cockroach.getConnectionString({
 *     id: clusterId,
 *     sqlUser: sqlUserName,
 *     password: sqlUserPassword,
 *     database: database,
 *     os: os,
 * });
 * ```
 */
export declare function getConnectionString(args: GetConnectionStringArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectionStringResult>;
/**
 * A collection of arguments for invoking getConnectionString.
 */
export interface GetConnectionStringArgs {
    database?: string;
    id: string;
    os?: string;
    password?: string;
    sqlUser?: string;
}
/**
 * A collection of values returned by getConnectionString.
 */
export interface GetConnectionStringResult {
    readonly connectionParams: outputs.GetConnectionStringConnectionParams;
    readonly connectionString: string;
    readonly database: string;
    readonly id: string;
    readonly os: string;
    readonly password?: string;
    readonly sqlUser?: string;
}
/**
 * Generic connection string for a cluster.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as cockroach from "@pulumi/cockroach";
 *
 * const config = new pulumi.Config();
 * const clusterId = config.require("clusterId");
 * const sqlUserName = config.require("sqlUserName");
 * const sqlUserPassword = config.require("sqlUserPassword");
 * const database = config.require("database");
 * const os = config.require("os");
 * const cockroach = cockroach.getConnectionString({
 *     id: clusterId,
 *     sqlUser: sqlUserName,
 *     password: sqlUserPassword,
 *     database: database,
 *     os: os,
 * });
 * ```
 */
export declare function getConnectionStringOutput(args: GetConnectionStringOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectionStringResult>;
/**
 * A collection of arguments for invoking getConnectionString.
 */
export interface GetConnectionStringOutputArgs {
    database?: pulumi.Input<string>;
    id: pulumi.Input<string>;
    os?: pulumi.Input<string>;
    password?: pulumi.Input<string>;
    sqlUser?: pulumi.Input<string>;
}