@lbrlabs/pulumi-cockroach/cluster.d.ts

A Pulumi package to create and managed cockroach db resources in Pulumi programs.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * CockroachDB Cloud cluster. Can be Dedicated or Serverless.
 */
export declare class Cluster extends pulumi.CustomResource {
    /**
     * Get an existing Cluster 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?: ClusterState, opts?: pulumi.CustomResourceOptions): Cluster;
    /**
     * Returns true if the given object is an instance of Cluster.  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 Cluster;
    /**
     * The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
     */
    readonly accountId: pulumi.Output<string>;
    /**
     * Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
     */
    readonly cloudProvider: pulumi.Output<string>;
    readonly clusterId: pulumi.Output<string>;
    /**
     * Major version of CockroachDB running on the cluster.
     */
    readonly cockroachVersion: pulumi.Output<string>;
    /**
     * ID of the user who created the cluster.
     */
    readonly creatorId: pulumi.Output<string>;
    readonly dedicated: pulumi.Output<outputs.ClusterDedicated | undefined>;
    /**
     * Name of the cluster.
     */
    readonly name: pulumi.Output<string>;
    /**
     * Describes the current long-running operation, if any.
     */
    readonly operationStatus: pulumi.Output<string>;
    /**
     * The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
     */
    readonly parentId: pulumi.Output<string>;
    /**
     * Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
     */
    readonly plan: pulumi.Output<string>;
    readonly regions: pulumi.Output<outputs.ClusterRegion[]>;
    readonly serverless: pulumi.Output<outputs.ClusterServerless | undefined>;
    /**
     * Describes whether the cluster is being created, updated, deleted, etc.
     */
    readonly state: pulumi.Output<string>;
    /**
     * Describes the status of any in-progress CockroachDB upgrade or rollback.
     */
    readonly upgradeStatus: pulumi.Output<string>;
    /**
     * Create a Cluster 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: ClusterArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Cluster resources.
 */
export interface ClusterState {
    /**
     * The cloud provider account ID that hosts the cluster. Needed for CMEK and other advanced features.
     */
    accountId?: pulumi.Input<string>;
    /**
     * Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
     */
    cloudProvider?: pulumi.Input<string>;
    clusterId?: pulumi.Input<string>;
    /**
     * Major version of CockroachDB running on the cluster.
     */
    cockroachVersion?: pulumi.Input<string>;
    /**
     * ID of the user who created the cluster.
     */
    creatorId?: pulumi.Input<string>;
    dedicated?: pulumi.Input<inputs.ClusterDedicated>;
    /**
     * Name of the cluster.
     */
    name?: pulumi.Input<string>;
    /**
     * Describes the current long-running operation, if any.
     */
    operationStatus?: pulumi.Input<string>;
    /**
     * The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
     */
    parentId?: pulumi.Input<string>;
    /**
     * Denotes cluster deployment type: 'DEDICATED' or 'SERVERLESS'.
     */
    plan?: pulumi.Input<string>;
    regions?: pulumi.Input<pulumi.Input<inputs.ClusterRegion>[]>;
    serverless?: pulumi.Input<inputs.ClusterServerless>;
    /**
     * Describes whether the cluster is being created, updated, deleted, etc.
     */
    state?: pulumi.Input<string>;
    /**
     * Describes the status of any in-progress CockroachDB upgrade or rollback.
     */
    upgradeStatus?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Cluster resource.
 */
export interface ClusterArgs {
    /**
     * Cloud provider used to host the cluster. Allowed values are: * GCP * AWS * AZURE
     */
    cloudProvider: pulumi.Input<string>;
    /**
     * Major version of CockroachDB running on the cluster.
     */
    cockroachVersion?: pulumi.Input<string>;
    dedicated?: pulumi.Input<inputs.ClusterDedicated>;
    /**
     * Name of the cluster.
     */
    name: pulumi.Input<string>;
    /**
     * The ID of the cluster's parent folder. 'root' is used for a cluster at the root level.
     */
    parentId?: pulumi.Input<string>;
    regions: pulumi.Input<pulumi.Input<inputs.ClusterRegion>[]>;
    serverless?: pulumi.Input<inputs.ClusterServerless>;
}