@pulumiverse/cockroach
Version:
A Pulumi package to create and managed Cockroach DB resources in Pulumi programs.
79 lines (78 loc) • 2.89 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Utility resource that represents the one-time action of finalizing a cluster's pending CockroachDB version upgrade.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as cockroach from "@pulumiverse/cockroach";
*
* const config = new pulumi.Config();
* const clusterId = config.require("clusterId");
* const cockroachVersion = config.require("cockroachVersion");
* const cockroach = new cockroach.FinalizeVersionUpgrade("cockroach", {
* clusterId: clusterId,
* cockroachVersion: cockroachVersion,
* });
* ```
*/
export declare class FinalizeVersionUpgrade extends pulumi.CustomResource {
/**
* Get an existing FinalizeVersionUpgrade 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?: FinalizeVersionUpgradeState, opts?: pulumi.CustomResourceOptions): FinalizeVersionUpgrade;
/**
* Returns true if the given object is an instance of FinalizeVersionUpgrade. 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 FinalizeVersionUpgrade;
/**
* Cluster ID.
*/
readonly clusterId: pulumi.Output<string>;
/**
* Major version of the cluster to be finalized.
*/
readonly cockroachVersion: pulumi.Output<string>;
/**
* Create a FinalizeVersionUpgrade 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: FinalizeVersionUpgradeArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering FinalizeVersionUpgrade resources.
*/
export interface FinalizeVersionUpgradeState {
/**
* Cluster ID.
*/
clusterId?: pulumi.Input<string>;
/**
* Major version of the cluster to be finalized.
*/
cockroachVersion?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a FinalizeVersionUpgrade resource.
*/
export interface FinalizeVersionUpgradeArgs {
/**
* Cluster ID.
*/
clusterId: pulumi.Input<string>;
/**
* Major version of the cluster to be finalized.
*/
cockroachVersion: pulumi.Input<string>;
}