@pulumi/digitalocean/getDatabaseCluster.d.ts

A Pulumi package for creating and managing DigitalOcean cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
 * Provides information on a DigitalOcean database cluster resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const example = digitalocean.getDatabaseCluster({
 *     name: "example-cluster",
 * });
 * export const databaseOutput = example.then(example => example.uri);
 * ```
 */
export declare function getDatabaseCluster(args: GetDatabaseClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabaseClusterResult>;
/**
 * A collection of arguments for invoking getDatabaseCluster.
 */
export interface GetDatabaseClusterArgs {
    /**
     * The name of the database cluster.
     */
    name: string;
    tags?: string[];
}
/**
 * A collection of values returned by getDatabaseCluster.
 */
export interface GetDatabaseClusterResult {
    /**
     * Name of the cluster's default database.
     */
    readonly database: string;
    /**
     * Database engine used by the cluster (ex. `pg` for PostgreSQL).
     */
    readonly engine: string;
    /**
     * Database cluster's hostname.
     */
    readonly host: string;
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    /**
     * Defines when the automatic maintenance should be performed for the database cluster.
     */
    readonly maintenanceWindows: outputs.GetDatabaseClusterMaintenanceWindow[];
    readonly name: string;
    /**
     * Number of nodes that will be included in the cluster.
     */
    readonly nodeCount: number;
    /**
     * Password for the cluster's default user.
     */
    readonly password: string;
    /**
     * Network port that the database cluster is listening on.
     */
    readonly port: number;
    /**
     * Same as `host`, but only accessible from resources within the account and in the same region.
     */
    readonly privateHost: string;
    /**
     * The ID of the VPC where the database cluster is located.
     */
    readonly privateNetworkUuid: string;
    /**
     * Same as `uri`, but only accessible from resources within the account and in the same region.
     */
    readonly privateUri: string;
    /**
     * The ID of the project that the database cluster is assigned to.
     */
    readonly projectId: string;
    /**
     * DigitalOcean region where the cluster will reside.
     */
    readonly region: string;
    /**
     * Database droplet size associated with the cluster (ex. `db-s-1vcpu-1gb`).
     */
    readonly size: string;
    readonly storageSizeMib: string;
    readonly tags?: string[];
    /**
     * Name of the OpenSearch dashboard db.
     */
    readonly uiDatabase: string;
    /**
     * Hostname for the OpenSearch dashboard.
     */
    readonly uiHost: string;
    /**
     * Password for the OpenSearch dashboard's default user.
     */
    readonly uiPassword: string;
    /**
     * Network port that the OpenSearch dashboard is listening on.
     */
    readonly uiPort: number;
    /**
     * The full URI for connecting to the OpenSearch dashboard.
     */
    readonly uiUri: string;
    /**
     * Username for OpenSearch dashboard's default user.
     */
    readonly uiUser: string;
    /**
     * The full URI for connecting to the database cluster.
     */
    readonly uri: string;
    /**
     * The uniform resource name of the database cluster.
     */
    readonly urn: string;
    /**
     * Username for the cluster's default user.
     */
    readonly user: string;
    /**
     * Engine version used by the cluster (ex. `11` for PostgreSQL 11).
     */
    readonly version: string;
}
/**
 * Provides information on a DigitalOcean database cluster resource.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as digitalocean from "@pulumi/digitalocean";
 *
 * const example = digitalocean.getDatabaseCluster({
 *     name: "example-cluster",
 * });
 * export const databaseOutput = example.then(example => example.uri);
 * ```
 */
export declare function getDatabaseClusterOutput(args: GetDatabaseClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatabaseClusterResult>;
/**
 * A collection of arguments for invoking getDatabaseCluster.
 */
export interface GetDatabaseClusterOutputArgs {
    /**
     * The name of the database cluster.
     */
    name: pulumi.Input<string>;
    tags?: pulumi.Input<pulumi.Input<string>[]>;
}