Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. FinalizeVersionUpgrade
CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.FinalizeVersionUpgrade

Explore with Pulumi AI

CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach

Utility resource that represents the one-time action of finalizing a cluster’s pending CockroachDB version upgrade.

Example Usage

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,
});
Copy
import pulumi
import pulumiverse_cockroach as cockroach

config = pulumi.Config()
cluster_id = config.require("clusterId")
cockroach_version = config.require("cockroachVersion")
cockroach = cockroach.FinalizeVersionUpgrade("cockroach",
    cluster_id=cluster_id,
    cockroach_version=cockroach_version)
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
	"github.com/pulumiverse/pulumi-cockroach/sdk/go/cockroach"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		clusterId := cfg.Require("clusterId")
		cockroachVersion := cfg.Require("cockroachVersion")
		_, err := cockroach.NewFinalizeVersionUpgrade(ctx, "cockroach", &cockroach.FinalizeVersionUpgradeArgs{
			ClusterId:        pulumi.String(clusterId),
			CockroachVersion: pulumi.String(cockroachVersion),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cockroach = Pulumiverse.Cockroach;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var clusterId = config.Require("clusterId");
    var cockroachVersion = config.Require("cockroachVersion");
    var cockroach = new Cockroach.FinalizeVersionUpgrade("cockroach", new()
    {
        ClusterId = clusterId,
        CockroachVersion = cockroachVersion,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cockroach.FinalizeVersionUpgrade;
import com.pulumi.cockroach.FinalizeVersionUpgradeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var config = ctx.config();
        final var clusterId = config.get("clusterId");
        final var cockroachVersion = config.get("cockroachVersion");
        var cockroach = new FinalizeVersionUpgrade("cockroach", FinalizeVersionUpgradeArgs.builder()
            .clusterId(clusterId)
            .cockroachVersion(cockroachVersion)
            .build());

    }
}
Copy
configuration:
  clusterId:
    type: string
  cockroachVersion:
    type: string
resources:
  cockroach:
    type: cockroach:FinalizeVersionUpgrade
    properties:
      clusterId: ${clusterId}
      cockroachVersion: ${cockroachVersion}
Copy

Create FinalizeVersionUpgrade Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new FinalizeVersionUpgrade(name: string, args: FinalizeVersionUpgradeArgs, opts?: CustomResourceOptions);
@overload
def FinalizeVersionUpgrade(resource_name: str,
                           args: FinalizeVersionUpgradeArgs,
                           opts: Optional[ResourceOptions] = None)

@overload
def FinalizeVersionUpgrade(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           cluster_id: Optional[str] = None,
                           cockroach_version: Optional[str] = None)
func NewFinalizeVersionUpgrade(ctx *Context, name string, args FinalizeVersionUpgradeArgs, opts ...ResourceOption) (*FinalizeVersionUpgrade, error)
public FinalizeVersionUpgrade(string name, FinalizeVersionUpgradeArgs args, CustomResourceOptions? opts = null)
public FinalizeVersionUpgrade(String name, FinalizeVersionUpgradeArgs args)
public FinalizeVersionUpgrade(String name, FinalizeVersionUpgradeArgs args, CustomResourceOptions options)

type: cockroach:FinalizeVersionUpgrade
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. FinalizeVersionUpgradeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. FinalizeVersionUpgradeArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. FinalizeVersionUpgradeArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. FinalizeVersionUpgradeArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. FinalizeVersionUpgradeArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var finalizeVersionUpgradeResource = new Cockroach.FinalizeVersionUpgrade("finalizeVersionUpgradeResource", new()
{
    ClusterId = "string",
    CockroachVersion = "string",
});
Copy
example, err := cockroach.NewFinalizeVersionUpgrade(ctx, "finalizeVersionUpgradeResource", &cockroach.FinalizeVersionUpgradeArgs{
	ClusterId:        pulumi.String("string"),
	CockroachVersion: pulumi.String("string"),
})
Copy
var finalizeVersionUpgradeResource = new FinalizeVersionUpgrade("finalizeVersionUpgradeResource", FinalizeVersionUpgradeArgs.builder()
    .clusterId("string")
    .cockroachVersion("string")
    .build());
Copy
finalize_version_upgrade_resource = cockroach.FinalizeVersionUpgrade("finalizeVersionUpgradeResource",
    cluster_id="string",
    cockroach_version="string")
Copy
const finalizeVersionUpgradeResource = new cockroach.FinalizeVersionUpgrade("finalizeVersionUpgradeResource", {
    clusterId: "string",
    cockroachVersion: "string",
});
Copy
type: cockroach:FinalizeVersionUpgrade
properties:
    clusterId: string
    cockroachVersion: string
Copy

FinalizeVersionUpgrade Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The FinalizeVersionUpgrade resource accepts the following input properties:

ClusterId This property is required. string
Cluster ID.
CockroachVersion This property is required. string
Major version of the cluster to be finalized.
ClusterId This property is required. string
Cluster ID.
CockroachVersion This property is required. string
Major version of the cluster to be finalized.
clusterId This property is required. String
Cluster ID.
cockroachVersion This property is required. String
Major version of the cluster to be finalized.
clusterId This property is required. string
Cluster ID.
cockroachVersion This property is required. string
Major version of the cluster to be finalized.
cluster_id This property is required. str
Cluster ID.
cockroach_version This property is required. str
Major version of the cluster to be finalized.
clusterId This property is required. String
Cluster ID.
cockroachVersion This property is required. String
Major version of the cluster to be finalized.

Outputs

All input properties are implicitly available as output properties. Additionally, the FinalizeVersionUpgrade resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing FinalizeVersionUpgrade Resource

Get an existing FinalizeVersionUpgrade resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: FinalizeVersionUpgradeState, opts?: CustomResourceOptions): FinalizeVersionUpgrade
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        cockroach_version: Optional[str] = None) -> FinalizeVersionUpgrade
func GetFinalizeVersionUpgrade(ctx *Context, name string, id IDInput, state *FinalizeVersionUpgradeState, opts ...ResourceOption) (*FinalizeVersionUpgrade, error)
public static FinalizeVersionUpgrade Get(string name, Input<string> id, FinalizeVersionUpgradeState? state, CustomResourceOptions? opts = null)
public static FinalizeVersionUpgrade get(String name, Output<String> id, FinalizeVersionUpgradeState state, CustomResourceOptions options)
resources:  _:    type: cockroach:FinalizeVersionUpgrade    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ClusterId string
Cluster ID.
CockroachVersion string
Major version of the cluster to be finalized.
ClusterId string
Cluster ID.
CockroachVersion string
Major version of the cluster to be finalized.
clusterId String
Cluster ID.
cockroachVersion String
Major version of the cluster to be finalized.
clusterId string
Cluster ID.
cockroachVersion string
Major version of the cluster to be finalized.
cluster_id str
Cluster ID.
cockroach_version str
Major version of the cluster to be finalized.
clusterId String
Cluster ID.
cockroachVersion String
Major version of the cluster to be finalized.

Package Details

Repository
cockroach pulumiverse/pulumi-cockroach
License
Apache-2.0
Notes
This Pulumi package is based on the cockroach Terraform Provider.
CockroachDB v0.9.4 published on Friday, Mar 21, 2025 by pulumiverse
pulumiverse/pulumi-cockroach