1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. ClickhouseBackupStrategy
tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack

tencentcloud.ClickhouseBackupStrategy

Explore with Pulumi AI

Provides a resource to create a clickhouse backup strategy

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",
});
const backupStrategy = new tencentcloud.ClickhouseBackupStrategy("backupStrategy", {
    dataBackupStrategies: [{
        backUpTables: [{
            database: "iac",
            ips: "10.0.0.35",
            table: "my_table",
            totalBytes: 0,
            vCluster: "default_cluster",
        }],
        executeHour: 1,
        retainDays: 2,
        weekDays: "3",
    }],
    instanceId: "cdwch-xxxxxx",
    metaBackupStrategies: [{
        executeHour: 3,
        retainDays: 2,
        weekDays: "1",
    }],
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

backup = tencentcloud.ClickhouseBackup("backup",
    cos_bucket_name="xxxxxx",
    instance_id="cdwch-xxxxxx")
backup_strategy = tencentcloud.ClickhouseBackupStrategy("backupStrategy",
    data_backup_strategies=[{
        "back_up_tables": [{
            "database": "iac",
            "ips": "10.0.0.35",
            "table": "my_table",
            "total_bytes": 0,
            "v_cluster": "default_cluster",
        }],
        "execute_hour": 1,
        "retain_days": 2,
        "week_days": "3",
    }],
    instance_id="cdwch-xxxxxx",
    meta_backup_strategies=[{
        "execute_hour": 3,
        "retain_days": 2,
        "week_days": "1",
    }])
Copy
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
		}
		_, err = tencentcloud.NewClickhouseBackupStrategy(ctx, "backupStrategy", &tencentcloud.ClickhouseBackupStrategyArgs{
			DataBackupStrategies: tencentcloud.ClickhouseBackupStrategyDataBackupStrategyArray{
				&tencentcloud.ClickhouseBackupStrategyDataBackupStrategyArgs{
					BackUpTables: tencentcloud.ClickhouseBackupStrategyDataBackupStrategyBackUpTableArray{
						&tencentcloud.ClickhouseBackupStrategyDataBackupStrategyBackUpTableArgs{
							Database:   pulumi.String("iac"),
							Ips:        pulumi.String("10.0.0.35"),
							Table:      pulumi.String("my_table"),
							TotalBytes: pulumi.Float64(0),
							VCluster:   pulumi.String("default_cluster"),
						},
					},
					ExecuteHour: pulumi.Float64(1),
					RetainDays:  pulumi.Float64(2),
					WeekDays:    pulumi.String("3"),
				},
			},
			InstanceId: pulumi.String("cdwch-xxxxxx"),
			MetaBackupStrategies: tencentcloud.ClickhouseBackupStrategyMetaBackupStrategyArray{
				&tencentcloud.ClickhouseBackupStrategyMetaBackupStrategyArgs{
					ExecuteHour: pulumi.Float64(3),
					RetainDays:  pulumi.Float64(2),
					WeekDays:    pulumi.String("1"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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",
    });

    var backupStrategy = new Tencentcloud.ClickhouseBackupStrategy("backupStrategy", new()
    {
        DataBackupStrategies = new[]
        {
            new Tencentcloud.Inputs.ClickhouseBackupStrategyDataBackupStrategyArgs
            {
                BackUpTables = new[]
                {
                    new Tencentcloud.Inputs.ClickhouseBackupStrategyDataBackupStrategyBackUpTableArgs
                    {
                        Database = "iac",
                        Ips = "10.0.0.35",
                        Table = "my_table",
                        TotalBytes = 0,
                        VCluster = "default_cluster",
                    },
                },
                ExecuteHour = 1,
                RetainDays = 2,
                WeekDays = "3",
            },
        },
        InstanceId = "cdwch-xxxxxx",
        MetaBackupStrategies = new[]
        {
            new Tencentcloud.Inputs.ClickhouseBackupStrategyMetaBackupStrategyArgs
            {
                ExecuteHour = 3,
                RetainDays = 2,
                WeekDays = "1",
            },
        },
    });

});
Copy
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 com.pulumi.tencentcloud.ClickhouseBackupStrategy;
import com.pulumi.tencentcloud.ClickhouseBackupStrategyArgs;
import com.pulumi.tencentcloud.inputs.ClickhouseBackupStrategyDataBackupStrategyArgs;
import com.pulumi.tencentcloud.inputs.ClickhouseBackupStrategyMetaBackupStrategyArgs;
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());

        var backupStrategy = new ClickhouseBackupStrategy("backupStrategy", ClickhouseBackupStrategyArgs.builder()
            .dataBackupStrategies(ClickhouseBackupStrategyDataBackupStrategyArgs.builder()
                .backUpTables(ClickhouseBackupStrategyDataBackupStrategyBackUpTableArgs.builder()
                    .database("iac")
                    .ips("10.0.0.35")
                    .table("my_table")
                    .totalBytes(0)
                    .vCluster("default_cluster")
                    .build())
                .executeHour(1)
                .retainDays(2)
                .weekDays("3")
                .build())
            .instanceId("cdwch-xxxxxx")
            .metaBackupStrategies(ClickhouseBackupStrategyMetaBackupStrategyArgs.builder()
                .executeHour(3)
                .retainDays(2)
                .weekDays("1")
                .build())
            .build());

    }
}
Copy
resources:
  backup:
    type: tencentcloud:ClickhouseBackup
    properties:
      cosBucketName: xxxxxx
      instanceId: cdwch-xxxxxx
  backupStrategy:
    type: tencentcloud:ClickhouseBackupStrategy
    properties:
      dataBackupStrategies:
        - backUpTables:
            - database: iac
              ips: 10.0.0.35
              table: my_table
              totalBytes: 0
              vCluster: default_cluster
          executeHour: 1
          retainDays: 2
          weekDays: '3'
      instanceId: cdwch-xxxxxx
      metaBackupStrategies:
        - executeHour: 3
          retainDays: 2
          weekDays: '1'
Copy

Create ClickhouseBackupStrategy Resource

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

Constructor syntax

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

@overload
def ClickhouseBackupStrategy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             data_backup_strategies: Optional[Sequence[ClickhouseBackupStrategyDataBackupStrategyArgs]] = None,
                             instance_id: Optional[str] = None,
                             clickhouse_backup_strategy_id: Optional[str] = None,
                             meta_backup_strategies: Optional[Sequence[ClickhouseBackupStrategyMetaBackupStrategyArgs]] = None)
func NewClickhouseBackupStrategy(ctx *Context, name string, args ClickhouseBackupStrategyArgs, opts ...ResourceOption) (*ClickhouseBackupStrategy, error)
public ClickhouseBackupStrategy(string name, ClickhouseBackupStrategyArgs args, CustomResourceOptions? opts = null)
public ClickhouseBackupStrategy(String name, ClickhouseBackupStrategyArgs args)
public ClickhouseBackupStrategy(String name, ClickhouseBackupStrategyArgs args, CustomResourceOptions options)
type: tencentcloud:ClickhouseBackupStrategy
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. ClickhouseBackupStrategyArgs
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. ClickhouseBackupStrategyArgs
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. ClickhouseBackupStrategyArgs
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. ClickhouseBackupStrategyArgs
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. ClickhouseBackupStrategyArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

DataBackupStrategies This property is required. List<ClickhouseBackupStrategyDataBackupStrategy>
Data backup strategy.
InstanceId This property is required. string
Instance id.
ClickhouseBackupStrategyId string
ID of the resource.
MetaBackupStrategies List<ClickhouseBackupStrategyMetaBackupStrategy>
Metadata backup strategy.
DataBackupStrategies This property is required. []ClickhouseBackupStrategyDataBackupStrategyArgs
Data backup strategy.
InstanceId This property is required. string
Instance id.
ClickhouseBackupStrategyId string
ID of the resource.
MetaBackupStrategies []ClickhouseBackupStrategyMetaBackupStrategyArgs
Metadata backup strategy.
dataBackupStrategies This property is required. List<ClickhouseBackupStrategyDataBackupStrategy>
Data backup strategy.
instanceId This property is required. String
Instance id.
clickhouseBackupStrategyId String
ID of the resource.
metaBackupStrategies List<ClickhouseBackupStrategyMetaBackupStrategy>
Metadata backup strategy.
dataBackupStrategies This property is required. ClickhouseBackupStrategyDataBackupStrategy[]
Data backup strategy.
instanceId This property is required. string
Instance id.
clickhouseBackupStrategyId string
ID of the resource.
metaBackupStrategies ClickhouseBackupStrategyMetaBackupStrategy[]
Metadata backup strategy.
data_backup_strategies This property is required. Sequence[ClickhouseBackupStrategyDataBackupStrategyArgs]
Data backup strategy.
instance_id This property is required. str
Instance id.
clickhouse_backup_strategy_id str
ID of the resource.
meta_backup_strategies Sequence[ClickhouseBackupStrategyMetaBackupStrategyArgs]
Metadata backup strategy.
dataBackupStrategies This property is required. List<Property Map>
Data backup strategy.
instanceId This property is required. String
Instance id.
clickhouseBackupStrategyId String
ID of the resource.
metaBackupStrategies List<Property Map>
Metadata backup strategy.

Outputs

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

Get an existing ClickhouseBackupStrategy 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?: ClickhouseBackupStrategyState, opts?: CustomResourceOptions): ClickhouseBackupStrategy
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clickhouse_backup_strategy_id: Optional[str] = None,
        data_backup_strategies: Optional[Sequence[ClickhouseBackupStrategyDataBackupStrategyArgs]] = None,
        instance_id: Optional[str] = None,
        meta_backup_strategies: Optional[Sequence[ClickhouseBackupStrategyMetaBackupStrategyArgs]] = None) -> ClickhouseBackupStrategy
func GetClickhouseBackupStrategy(ctx *Context, name string, id IDInput, state *ClickhouseBackupStrategyState, opts ...ResourceOption) (*ClickhouseBackupStrategy, error)
public static ClickhouseBackupStrategy Get(string name, Input<string> id, ClickhouseBackupStrategyState? state, CustomResourceOptions? opts = null)
public static ClickhouseBackupStrategy get(String name, Output<String> id, ClickhouseBackupStrategyState state, CustomResourceOptions options)
resources:  _:    type: tencentcloud:ClickhouseBackupStrategy    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:
clickhouseBackupStrategyId String
ID of the resource.
dataBackupStrategies List<Property Map>
Data backup strategy.
instanceId String
Instance id.
metaBackupStrategies List<Property Map>
Metadata backup strategy.

Supporting Types

ClickhouseBackupStrategyDataBackupStrategy
, ClickhouseBackupStrategyDataBackupStrategyArgs

BackUpTables This property is required. List<ClickhouseBackupStrategyDataBackupStrategyBackUpTable>
Back up the list of tables.
ExecuteHour This property is required. double
Execution hour.
RetainDays This property is required. double
Retention days.
WeekDays This property is required. string
The day of the week is separated by commas. For example: 2 represents Tuesday.
BackUpTables This property is required. []ClickhouseBackupStrategyDataBackupStrategyBackUpTable
Back up the list of tables.
ExecuteHour This property is required. float64
Execution hour.
RetainDays This property is required. float64
Retention days.
WeekDays This property is required. string
The day of the week is separated by commas. For example: 2 represents Tuesday.
backUpTables This property is required. List<ClickhouseBackupStrategyDataBackupStrategyBackUpTable>
Back up the list of tables.
executeHour This property is required. Double
Execution hour.
retainDays This property is required. Double
Retention days.
weekDays This property is required. String
The day of the week is separated by commas. For example: 2 represents Tuesday.
backUpTables This property is required. ClickhouseBackupStrategyDataBackupStrategyBackUpTable[]
Back up the list of tables.
executeHour This property is required. number
Execution hour.
retainDays This property is required. number
Retention days.
weekDays This property is required. string
The day of the week is separated by commas. For example: 2 represents Tuesday.
back_up_tables This property is required. Sequence[ClickhouseBackupStrategyDataBackupStrategyBackUpTable]
Back up the list of tables.
execute_hour This property is required. float
Execution hour.
retain_days This property is required. float
Retention days.
week_days This property is required. str
The day of the week is separated by commas. For example: 2 represents Tuesday.
backUpTables This property is required. List<Property Map>
Back up the list of tables.
executeHour This property is required. Number
Execution hour.
retainDays This property is required. Number
Retention days.
weekDays This property is required. String
The day of the week is separated by commas. For example: 2 represents Tuesday.

ClickhouseBackupStrategyDataBackupStrategyBackUpTable
, ClickhouseBackupStrategyDataBackupStrategyBackUpTableArgs

Database This property is required. string
Database.
Table This property is required. string
Table.
TotalBytes This property is required. double
Back up the list of tables.
Ips string
Table ip.
Rip string
Ip address of cvm.
VCluster string
Virtual clusters.
ZooPath string
ZK path.
Database This property is required. string
Database.
Table This property is required. string
Table.
TotalBytes This property is required. float64
Back up the list of tables.
Ips string
Table ip.
Rip string
Ip address of cvm.
VCluster string
Virtual clusters.
ZooPath string
ZK path.
database This property is required. String
Database.
table This property is required. String
Table.
totalBytes This property is required. Double
Back up the list of tables.
ips String
Table ip.
rip String
Ip address of cvm.
vCluster String
Virtual clusters.
zooPath String
ZK path.
database This property is required. string
Database.
table This property is required. string
Table.
totalBytes This property is required. number
Back up the list of tables.
ips string
Table ip.
rip string
Ip address of cvm.
vCluster string
Virtual clusters.
zooPath string
ZK path.
database This property is required. str
Database.
table This property is required. str
Table.
total_bytes This property is required. float
Back up the list of tables.
ips str
Table ip.
rip str
Ip address of cvm.
v_cluster str
Virtual clusters.
zoo_path str
ZK path.
database This property is required. String
Database.
table This property is required. String
Table.
totalBytes This property is required. Number
Back up the list of tables.
ips String
Table ip.
rip String
Ip address of cvm.
vCluster String
Virtual clusters.
zooPath String
ZK path.

ClickhouseBackupStrategyMetaBackupStrategy
, ClickhouseBackupStrategyMetaBackupStrategyArgs

ExecuteHour double
Execution hour.
RetainDays double
Retention days.
WeekDays string
The day of the week is separated by commas. For example: 2 represents Tuesday.
ExecuteHour float64
Execution hour.
RetainDays float64
Retention days.
WeekDays string
The day of the week is separated by commas. For example: 2 represents Tuesday.
executeHour Double
Execution hour.
retainDays Double
Retention days.
weekDays String
The day of the week is separated by commas. For example: 2 represents Tuesday.
executeHour number
Execution hour.
retainDays number
Retention days.
weekDays string
The day of the week is separated by commas. For example: 2 represents Tuesday.
execute_hour float
Execution hour.
retain_days float
Retention days.
week_days str
The day of the week is separated by commas. For example: 2 represents Tuesday.
executeHour Number
Execution hour.
retainDays Number
Retention days.
weekDays String
The day of the week is separated by commas. For example: 2 represents Tuesday.

Import

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

$ pulumi import tencentcloud:index/clickhouseBackupStrategy:ClickhouseBackupStrategy backup_strategy instance_id
Copy

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.