Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ClickhouseBackup
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.ClickhouseBackup

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Provides a resource to open clickhouse backup

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const backup = new tencentcloud.ClickhouseBackup("backup", {
    cosBucketName: "xxxxxx",
    instanceId: "cdwch-xxxxxx",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

backup = tencentcloud.ClickhouseBackup("backup",
    cos_bucket_name="xxxxxx",
    instance_id="cdwch-xxxxxx")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.NewClickhouseBackup(ctx, "backup", &tencentcloud.ClickhouseBackupArgs{
			CosBucketName: pulumi.String("xxxxxx"),
			InstanceId:    pulumi.String("cdwch-xxxxxx"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var backup = new Tencentcloud.ClickhouseBackup("backup", new()
    {
        CosBucketName = "xxxxxx",
        InstanceId = "cdwch-xxxxxx",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.ClickhouseBackup;
import com.pulumi.tencentcloud.ClickhouseBackupArgs;
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) {
        var backup = new ClickhouseBackup("backup", ClickhouseBackupArgs.builder()
            .cosBucketName("xxxxxx")
            .instanceId("cdwch-xxxxxx")
            .build());

    }
}

    resources:
  backup:
    type: tencentcloud:ClickhouseBackup
    properties:
      cosBucketName: xxxxxx
      instanceId: cdwch-xxxxxx

    Create ClickhouseBackup Resource

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

    Constructor syntax

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

@overload
def ClickhouseBackup(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     cos_bucket_name: Optional[str] = None,
                     instance_id: Optional[str] = None,
                     clickhouse_backup_id: Optional[str] = None)
    func NewClickhouseBackup(ctx *Context, name string, args ClickhouseBackupArgs, opts ...ResourceOption) (*ClickhouseBackup, error)
    public ClickhouseBackup(string name, ClickhouseBackupArgs args, CustomResourceOptions? opts = null)
    public ClickhouseBackup(String name, ClickhouseBackupArgs args)
public ClickhouseBackup(String name, ClickhouseBackupArgs args, CustomResourceOptions options)

    type: tencentcloud:ClickhouseBackup
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 ClickhouseBackupArgs
    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 ClickhouseBackupArgs
    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 ClickhouseBackupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClickhouseBackupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClickhouseBackupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    ClickhouseBackup 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 ClickhouseBackup resource accepts the following input properties:

    CosBucketName string
    COS bucket name.
    InstanceId string
    Instance id.
    ClickhouseBackupId string
    ID of the resource.
    CosBucketName string
    COS bucket name.
    InstanceId string
    Instance id.
    ClickhouseBackupId string
    ID of the resource.
    cosBucketName String
    COS bucket name.
    instanceId String
    Instance id.
    clickhouseBackupId String
    ID of the resource.
    cosBucketName string
    COS bucket name.
    instanceId string
    Instance id.
    clickhouseBackupId string
    ID of the resource.
    cos_bucket_name str
    COS bucket name.
    instance_id str
    Instance id.
    clickhouse_backup_id str
    ID of the resource.
    cosBucketName String
    COS bucket name.
    instanceId String
    Instance id.
    clickhouseBackupId String
    ID of the resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ClickhouseBackup 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 ClickhouseBackup Resource

    Get an existing ClickhouseBackup 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?: ClickhouseBackupState, opts?: CustomResourceOptions): ClickhouseBackup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clickhouse_backup_id: Optional[str] = None,
        cos_bucket_name: Optional[str] = None,
        instance_id: Optional[str] = None) -> ClickhouseBackup
    func GetClickhouseBackup(ctx *Context, name string, id IDInput, state *ClickhouseBackupState, opts ...ResourceOption) (*ClickhouseBackup, error)
    public static ClickhouseBackup Get(string name, Input<string> id, ClickhouseBackupState? state, CustomResourceOptions? opts = null)
    public static ClickhouseBackup get(String name, Output<String> id, ClickhouseBackupState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:ClickhouseBackup    get:      id: ${id}
    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:
    ClickhouseBackupId string
    ID of the resource.
    CosBucketName string
    COS bucket name.
    InstanceId string
    Instance id.
    ClickhouseBackupId string
    ID of the resource.
    CosBucketName string
    COS bucket name.
    InstanceId string
    Instance id.
    clickhouseBackupId String
    ID of the resource.
    cosBucketName String
    COS bucket name.
    instanceId String
    Instance id.
    clickhouseBackupId string
    ID of the resource.
    cosBucketName string
    COS bucket name.
    instanceId string
    Instance id.
    clickhouse_backup_id str
    ID of the resource.
    cos_bucket_name str
    COS bucket name.
    instance_id str
    Instance id.
    clickhouseBackupId String
    ID of the resource.
    cosBucketName String
    COS bucket name.
    instanceId String
    Instance id.

    Import

    clickhouse backup can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/clickhouseBackup:ClickhouseBackup backup instance_id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud