Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. clickhouseenterprisedbcluster
  5. BackupPolicy
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

alicloud.clickhouseenterprisedbcluster.BackupPolicy

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-alicloud

    Provides a Click House Enterprise Db Cluster Backup Policy resource.

    Enterprise ClickHouse instance backup policy.

    For information about Click House Enterprise Db Cluster Backup Policy and how to use it, see What is Enterprise Db Cluster Backup Policy.

    NOTE: Available since v1.247.0.

    Example Usage

    Basic Usage

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

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const regionId = config.get("regionId") || "cn-beijing";
const vswIpRangeI = config.get("vswIpRangeI") || "172.16.1.0/24";
const vpcIpRange = config.get("vpcIpRange") || "172.16.0.0/12";
const zoneIdI = config.get("zoneIdI") || "cn-beijing-i";
const defaultktKLuM = new alicloud.vpc.Network("defaultktKLuM", {cidrBlock: vpcIpRange});
const defaultTQWN3k = new alicloud.vpc.Switch("defaultTQWN3k", {
    vpcId: defaultktKLuM.id,
    zoneId: zoneIdI,
    cidrBlock: vswIpRangeI,
});
const default1tTLwe = new alicloud.clickhouseenterprisedbcluster.ClickHouseEnterpriseDbCluster("default1tTLwe", {
    zoneId: zoneIdI,
    vpcId: defaultktKLuM.id,
    scaleMin: "8",
    scaleMax: "16",
    vswitchId: defaultTQWN3k.id,
});
const _default = new alicloud.clickhouseenterprisedbcluster.BackupPolicy("default", {
    preferredBackupPeriod: "Monday",
    preferredBackupTime: "04:00Z-05:00Z",
    backupRetentionPeriod: 7,
    dbInstanceId: default1tTLwe.id,
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
region_id = config.get("regionId")
if region_id is None:
    region_id = "cn-beijing"
vsw_ip_range_i = config.get("vswIpRangeI")
if vsw_ip_range_i is None:
    vsw_ip_range_i = "172.16.1.0/24"
vpc_ip_range = config.get("vpcIpRange")
if vpc_ip_range is None:
    vpc_ip_range = "172.16.0.0/12"
zone_id_i = config.get("zoneIdI")
if zone_id_i is None:
    zone_id_i = "cn-beijing-i"
defaultkt_k_lu_m = alicloud.vpc.Network("defaultktKLuM", cidr_block=vpc_ip_range)
default_tqwn3k = alicloud.vpc.Switch("defaultTQWN3k",
    vpc_id=defaultkt_k_lu_m.id,
    zone_id=zone_id_i,
    cidr_block=vsw_ip_range_i)
default1t_t_lwe = alicloud.clickhouseenterprisedbcluster.ClickHouseEnterpriseDbCluster("default1tTLwe",
    zone_id=zone_id_i,
    vpc_id=defaultkt_k_lu_m.id,
    scale_min="8",
    scale_max="16",
    vswitch_id=default_tqwn3k.id)
default = alicloud.clickhouseenterprisedbcluster.BackupPolicy("default",
    preferred_backup_period="Monday",
    preferred_backup_time="04:00Z-05:00Z",
    backup_retention_period=7,
    db_instance_id=default1t_t_lwe.id)

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/clickhouseenterprisedbcluster"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		regionId := "cn-beijing"
		if param := cfg.Get("regionId"); param != "" {
			regionId = param
		}
		vswIpRangeI := "172.16.1.0/24"
		if param := cfg.Get("vswIpRangeI"); param != "" {
			vswIpRangeI = param
		}
		vpcIpRange := "172.16.0.0/12"
		if param := cfg.Get("vpcIpRange"); param != "" {
			vpcIpRange = param
		}
		zoneIdI := "cn-beijing-i"
		if param := cfg.Get("zoneIdI"); param != "" {
			zoneIdI = param
		}
		defaultktKLuM, err := vpc.NewNetwork(ctx, "defaultktKLuM", &vpc.NetworkArgs{
			CidrBlock: pulumi.String(vpcIpRange),
		})
		if err != nil {
			return err
		}
		defaultTQWN3k, err := vpc.NewSwitch(ctx, "defaultTQWN3k", &vpc.SwitchArgs{
			VpcId:     defaultktKLuM.ID(),
			ZoneId:    pulumi.String(zoneIdI),
			CidrBlock: pulumi.String(vswIpRangeI),
		})
		if err != nil {
			return err
		}
		default1tTLwe, err := clickhouseenterprisedbcluster.NewClickHouseEnterpriseDbCluster(ctx, "default1tTLwe", &clickhouseenterprisedbcluster.ClickHouseEnterpriseDbClusterArgs{
			ZoneId:    pulumi.String(zoneIdI),
			VpcId:     defaultktKLuM.ID(),
			ScaleMin:  pulumi.String("8"),
			ScaleMax:  pulumi.String("16"),
			VswitchId: defaultTQWN3k.ID(),
		})
		if err != nil {
			return err
		}
		_, err = clickhouseenterprisedbcluster.NewBackupPolicy(ctx, "default", &clickhouseenterprisedbcluster.BackupPolicyArgs{
			PreferredBackupPeriod: pulumi.String("Monday"),
			PreferredBackupTime:   pulumi.String("04:00Z-05:00Z"),
			BackupRetentionPeriod: pulumi.Int(7),
			DbInstanceId:          default1tTLwe.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var regionId = config.Get("regionId") ?? "cn-beijing";
    var vswIpRangeI = config.Get("vswIpRangeI") ?? "172.16.1.0/24";
    var vpcIpRange = config.Get("vpcIpRange") ?? "172.16.0.0/12";
    var zoneIdI = config.Get("zoneIdI") ?? "cn-beijing-i";
    var defaultktKLuM = new AliCloud.Vpc.Network("defaultktKLuM", new()
    {
        CidrBlock = vpcIpRange,
    });

    var defaultTQWN3k = new AliCloud.Vpc.Switch("defaultTQWN3k", new()
    {
        VpcId = defaultktKLuM.Id,
        ZoneId = zoneIdI,
        CidrBlock = vswIpRangeI,
    });

    var default1tTLwe = new AliCloud.ClickHouseEnterpriseDbCluster.ClickHouseEnterpriseDbCluster("default1tTLwe", new()
    {
        ZoneId = zoneIdI,
        VpcId = defaultktKLuM.Id,
        ScaleMin = "8",
        ScaleMax = "16",
        VswitchId = defaultTQWN3k.Id,
    });

    var @default = new AliCloud.ClickHouseEnterpriseDbCluster.BackupPolicy("default", new()
    {
        PreferredBackupPeriod = "Monday",
        PreferredBackupTime = "04:00Z-05:00Z",
        BackupRetentionPeriod = 7,
        DbInstanceId = default1tTLwe.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.vpc.Network;
import com.pulumi.alicloud.vpc.NetworkArgs;
import com.pulumi.alicloud.vpc.Switch;
import com.pulumi.alicloud.vpc.SwitchArgs;
import com.pulumi.alicloud.clickhouseenterprisedbcluster.ClickHouseEnterpriseDbCluster;
import com.pulumi.alicloud.clickhouseenterprisedbcluster.ClickHouseEnterpriseDbClusterArgs;
import com.pulumi.alicloud.clickhouseenterprisedbcluster.BackupPolicy;
import com.pulumi.alicloud.clickhouseenterprisedbcluster.BackupPolicyArgs;
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 name = config.get("name").orElse("terraform-example");
        final var regionId = config.get("regionId").orElse("cn-beijing");
        final var vswIpRangeI = config.get("vswIpRangeI").orElse("172.16.1.0/24");
        final var vpcIpRange = config.get("vpcIpRange").orElse("172.16.0.0/12");
        final var zoneIdI = config.get("zoneIdI").orElse("cn-beijing-i");
        var defaultktKLuM = new Network("defaultktKLuM", NetworkArgs.builder()
            .cidrBlock(vpcIpRange)
            .build());

        var defaultTQWN3k = new Switch("defaultTQWN3k", SwitchArgs.builder()
            .vpcId(defaultktKLuM.id())
            .zoneId(zoneIdI)
            .cidrBlock(vswIpRangeI)
            .build());

        var default1tTLwe = new ClickHouseEnterpriseDbCluster("default1tTLwe", ClickHouseEnterpriseDbClusterArgs.builder()
            .zoneId(zoneIdI)
            .vpcId(defaultktKLuM.id())
            .scaleMin("8")
            .scaleMax("16")
            .vswitchId(defaultTQWN3k.id())
            .build());

        var default_ = new BackupPolicy("default", BackupPolicyArgs.builder()
            .preferredBackupPeriod("Monday")
            .preferredBackupTime("04:00Z-05:00Z")
            .backupRetentionPeriod("7")
            .dbInstanceId(default1tTLwe.id())
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
  regionId:
    type: string
    default: cn-beijing
  vswIpRangeI:
    type: string
    default: 172.16.1.0/24
  vpcIpRange:
    type: string
    default: 172.16.0.0/12
  zoneIdI:
    type: string
    default: cn-beijing-i
resources:
  defaultktKLuM:
    type: alicloud:vpc:Network
    properties:
      cidrBlock: ${vpcIpRange}
  defaultTQWN3k:
    type: alicloud:vpc:Switch
    properties:
      vpcId: ${defaultktKLuM.id}
      zoneId: ${zoneIdI}
      cidrBlock: ${vswIpRangeI}
  default1tTLwe:
    type: alicloud:clickhouseenterprisedbcluster:ClickHouseEnterpriseDbCluster
    properties:
      zoneId: ${zoneIdI}
      vpcId: ${defaultktKLuM.id}
      scaleMin: '8'
      scaleMax: '16'
      vswitchId: ${defaultTQWN3k.id}
  default:
    type: alicloud:clickhouseenterprisedbcluster:BackupPolicy
    properties:
      preferredBackupPeriod: Monday
      preferredBackupTime: 04:00Z-05:00Z
      backupRetentionPeriod: '7'
      dbInstanceId: ${default1tTLwe.id}

    Create BackupPolicy Resource

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

    Constructor syntax

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

@overload
def BackupPolicy(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 backup_retention_period: Optional[int] = None,
                 db_instance_id: Optional[str] = None,
                 preferred_backup_period: Optional[str] = None,
                 preferred_backup_time: Optional[str] = None)
    func NewBackupPolicy(ctx *Context, name string, args BackupPolicyArgs, opts ...ResourceOption) (*BackupPolicy, error)
    public BackupPolicy(string name, BackupPolicyArgs args, CustomResourceOptions? opts = null)
    public BackupPolicy(String name, BackupPolicyArgs args)
public BackupPolicy(String name, BackupPolicyArgs args, CustomResourceOptions options)

    type: alicloud:clickhouseenterprisedbcluster:BackupPolicy
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 BackupPolicyArgs
    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 BackupPolicyArgs
    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 BackupPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupPolicyArgs
    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 examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy = new AliCloud.ClickHouseEnterpriseDbCluster.BackupPolicy("examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy", new()
{
    BackupRetentionPeriod = 0,
    DbInstanceId = "string",
    PreferredBackupPeriod = "string",
    PreferredBackupTime = "string",
});

    example, err := clickhouseenterprisedbcluster.NewBackupPolicy(ctx, "examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy", &clickhouseenterprisedbcluster.BackupPolicyArgs{
	BackupRetentionPeriod: pulumi.Int(0),
	DbInstanceId:          pulumi.String("string"),
	PreferredBackupPeriod: pulumi.String("string"),
	PreferredBackupTime:   pulumi.String("string"),
})

    var examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy = new com.pulumi.alicloud.clickhouseenterprisedbcluster.BackupPolicy("examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy", com.pulumi.alicloud.clickhouseenterprisedbcluster.BackupPolicyArgs.builder()
    .backupRetentionPeriod(0)
    .dbInstanceId("string")
    .preferredBackupPeriod("string")
    .preferredBackupTime("string")
    .build());

    examplebackup_policy_resource_resource_from_clickhouseenterprisedbclusterbackup_policy = alicloud.clickhouseenterprisedbcluster.BackupPolicy("examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy",
    backup_retention_period=0,
    db_instance_id="string",
    preferred_backup_period="string",
    preferred_backup_time="string")

    const examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy = new alicloud.clickhouseenterprisedbcluster.BackupPolicy("examplebackupPolicyResourceResourceFromClickhouseenterprisedbclusterbackupPolicy", {
    backupRetentionPeriod: 0,
    dbInstanceId: "string",
    preferredBackupPeriod: "string",
    preferredBackupTime: "string",
});

    type: alicloud:clickhouseenterprisedbcluster:BackupPolicy
properties:
    backupRetentionPeriod: 0
    dbInstanceId: string
    preferredBackupPeriod: string
    preferredBackupTime: string

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

    BackupRetentionPeriod int
    Backup retention time.
    DbInstanceId string
    The instance ID.
    PreferredBackupPeriod string
    Backup period.
    PreferredBackupTime string
    Backup time.
    BackupRetentionPeriod int
    Backup retention time.
    DbInstanceId string
    The instance ID.
    PreferredBackupPeriod string
    Backup period.
    PreferredBackupTime string
    Backup time.
    backupRetentionPeriod Integer
    Backup retention time.
    dbInstanceId String
    The instance ID.
    preferredBackupPeriod String
    Backup period.
    preferredBackupTime String
    Backup time.
    backupRetentionPeriod number
    Backup retention time.
    dbInstanceId string
    The instance ID.
    preferredBackupPeriod string
    Backup period.
    preferredBackupTime string
    Backup time.
    backup_retention_period int
    Backup retention time.
    db_instance_id str
    The instance ID.
    preferred_backup_period str
    Backup period.
    preferred_backup_time str
    Backup time.
    backupRetentionPeriod Number
    Backup retention time.
    dbInstanceId String
    The instance ID.
    preferredBackupPeriod String
    Backup period.
    preferredBackupTime String
    Backup time.

    Outputs

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

    Get an existing BackupPolicy 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?: BackupPolicyState, opts?: CustomResourceOptions): BackupPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_retention_period: Optional[int] = None,
        db_instance_id: Optional[str] = None,
        preferred_backup_period: Optional[str] = None,
        preferred_backup_time: Optional[str] = None) -> BackupPolicy
    func GetBackupPolicy(ctx *Context, name string, id IDInput, state *BackupPolicyState, opts ...ResourceOption) (*BackupPolicy, error)
    public static BackupPolicy Get(string name, Input<string> id, BackupPolicyState? state, CustomResourceOptions? opts = null)
    public static BackupPolicy get(String name, Output<String> id, BackupPolicyState state, CustomResourceOptions options)
    resources:  _:    type: alicloud:clickhouseenterprisedbcluster:BackupPolicy    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:
    BackupRetentionPeriod int
    Backup retention time.
    DbInstanceId string
    The instance ID.
    PreferredBackupPeriod string
    Backup period.
    PreferredBackupTime string
    Backup time.
    BackupRetentionPeriod int
    Backup retention time.
    DbInstanceId string
    The instance ID.
    PreferredBackupPeriod string
    Backup period.
    PreferredBackupTime string
    Backup time.
    backupRetentionPeriod Integer
    Backup retention time.
    dbInstanceId String
    The instance ID.
    preferredBackupPeriod String
    Backup period.
    preferredBackupTime String
    Backup time.
    backupRetentionPeriod number
    Backup retention time.
    dbInstanceId string
    The instance ID.
    preferredBackupPeriod string
    Backup period.
    preferredBackupTime string
    Backup time.
    backup_retention_period int
    Backup retention time.
    db_instance_id str
    The instance ID.
    preferred_backup_period str
    Backup period.
    preferred_backup_time str
    Backup time.
    backupRetentionPeriod Number
    Backup retention time.
    dbInstanceId String
    The instance ID.
    preferredBackupPeriod String
    Backup period.
    preferredBackupTime String
    Backup time.

    Import

    Click House Enterprise Db Cluster Backup Policy can be imported using the id, e.g.

    $ pulumi import alicloud:clickhouseenterprisedbcluster/backupPolicy:BackupPolicy example <id>

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

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
    pulumi/pulumi-alicloud