UNPKG

@pulumiverse/cockroach

Version:

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

87 lines (86 loc) 3.24 kB
import * as pulumi from "@pulumi/pulumi"; /** * Configure minor version upgrade deferral for a cluster. * * ## 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 offsetDuration = config.get("offsetDuration") || "FIXED_DEFERRAL"; * const example = new cockroach.VersionDeferral("example", { * clusterId: clusterId, * deferralPolicy: offsetDuration, * }); * ``` * * ## Import * * format: <cluster id> * * ```sh * $ pulumi import cockroach:index/versionDeferral:VersionDeferral example 1f69fdd2-600a-4cfc-a9ba-16995df0d77d * ``` */ export declare class VersionDeferral extends pulumi.CustomResource { /** * Get an existing VersionDeferral 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?: VersionDeferralState, opts?: pulumi.CustomResourceOptions): VersionDeferral; /** * Returns true if the given object is an instance of VersionDeferral. 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 VersionDeferral; /** * Cluster ID. */ readonly clusterId: pulumi.Output<string>; /** * The policy for managing automated minor version upgrades. Set to FIXED*DEFERRAL to defer upgrades by 60 days or NOT*DEFERRED to apply upgrades immediately. */ readonly deferralPolicy: pulumi.Output<string>; /** * Create a VersionDeferral 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: VersionDeferralArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering VersionDeferral resources. */ export interface VersionDeferralState { /** * Cluster ID. */ clusterId?: pulumi.Input<string>; /** * The policy for managing automated minor version upgrades. Set to FIXED*DEFERRAL to defer upgrades by 60 days or NOT*DEFERRED to apply upgrades immediately. */ deferralPolicy?: pulumi.Input<string>; } /** * The set of arguments for constructing a VersionDeferral resource. */ export interface VersionDeferralArgs { /** * Cluster ID. */ clusterId: pulumi.Input<string>; /** * The policy for managing automated minor version upgrades. Set to FIXED*DEFERRAL to defer upgrades by 60 days or NOT*DEFERRED to apply upgrades immediately. */ deferralPolicy: pulumi.Input<string>; }