Docs Packages
  1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. FinalizeVersionUpgrade
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

cockroach.FinalizeVersionUpgrade

Explore with Pulumi AI

cockroach logo
CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
pulumiverse/pulumi-cockroach

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

    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 string
    The unique name of the resource.
    args FinalizeVersionUpgradeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args 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 string
    The unique name of the resource.
    args FinalizeVersionUpgradeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FinalizeVersionUpgradeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args 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",
});

    example, err := cockroach.NewFinalizeVersionUpgrade(ctx, "finalizeVersionUpgradeResource", &cockroach.FinalizeVersionUpgradeArgs{
	ClusterId:        pulumi.String("string"),
	CockroachVersion: pulumi.String("string"),
})

    var finalizeVersionUpgradeResource = new FinalizeVersionUpgrade("finalizeVersionUpgradeResource", FinalizeVersionUpgradeArgs.builder()
    .clusterId("string")
    .cockroachVersion("string")
    .build());

    finalize_version_upgrade_resource = cockroach.FinalizeVersionUpgrade("finalizeVersionUpgradeResource",
    cluster_id="string",
    cockroach_version="string")

    const finalizeVersionUpgradeResource = new cockroach.FinalizeVersionUpgrade("finalizeVersionUpgradeResource", {
    clusterId: "string",
    cockroachVersion: "string",
});

    type: cockroach:FinalizeVersionUpgrade
properties:
    clusterId: string
    cockroachVersion: string

    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

    The FinalizeVersionUpgrade resource accepts the following input properties:

    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.

    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)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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.
    cockroach logo
    CockroachDB v0.2.3 published on Monday, May 27, 2024 by pulumiverse
    pulumiverse/pulumi-cockroach