@pulumiverse/cockroach
Version:
A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.
70 lines (69 loc) • 2.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* CockroachDB Cloud cluster. Can be Dedicated or Serverless.
*
* ## 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 cockroach = cockroach.getCockroachCluster({
* id: clusterId,
* });
* ```
*/
export declare function getCockroachCluster(args: GetCockroachClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetCockroachClusterResult>;
/**
* A collection of arguments for invoking getCockroachCluster.
*/
export interface GetCockroachClusterArgs {
id: string;
}
/**
* A collection of values returned by getCockroachCluster.
*/
export interface GetCockroachClusterResult {
readonly accountId: string;
readonly backupConfig: outputs.GetCockroachClusterBackupConfig;
readonly cloudProvider: string;
readonly cockroachVersion: string;
readonly creatorId: string;
readonly dedicated: outputs.GetCockroachClusterDedicated;
readonly deleteProtection: boolean;
readonly id: string;
readonly name: string;
readonly operationStatus: string;
readonly parentId: string;
readonly plan: string;
readonly regions: outputs.GetCockroachClusterRegion[];
readonly serverless: outputs.GetCockroachClusterServerless;
readonly state: string;
readonly upgradeStatus: string;
}
/**
* CockroachDB Cloud cluster. Can be Dedicated or Serverless.
*
* ## 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 cockroach = cockroach.getCockroachCluster({
* id: clusterId,
* });
* ```
*/
export declare function getCockroachClusterOutput(args: GetCockroachClusterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetCockroachClusterResult>;
/**
* A collection of arguments for invoking getCockroachCluster.
*/
export interface GetCockroachClusterOutputArgs {
id: pulumi.Input<string>;
}