1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. adb
  5. BackupPolicy
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

alicloud.adb.BackupPolicy

alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-alicloud

    Provides a ADB cluster backup policy resource and used to configure cluster backup policy.

    NOTE: Available since v1.71.0.

    Each DB cluster has a backup policy and it will be set default values when destroying the resource.

    Example 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 _default = alicloud.adb.getZones({});
const defaultGetNetworks = alicloud.vpc.getNetworks({
    nameRegex: "^default-NODELETING$",
});
const defaultGetSwitches = Promise.all([defaultGetNetworks, _default]).then(([defaultGetNetworks, _default]) => alicloud.vpc.getSwitches({
    vpcId: defaultGetNetworks.ids?.[0],
    zoneId: _default.ids?.[0],
}));
const vswitchId = defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids?.[0]);
const cluster = new alicloud.adb.DBCluster("cluster", {
    dbClusterCategory: "MixedStorage",
    mode: "flexible",
    computeResource: "8Core32GB",
    vswitchId: vswitchId,
    description: name,
});
const defaultBackupPolicy = new alicloud.adb.BackupPolicy("default", {
    dbClusterId: cluster.id,
    preferredBackupPeriods: [
        "Tuesday",
        "Wednesday",
    ],
    preferredBackupTime: "10:00Z-11:00Z",
});

    import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
default = alicloud.adb.get_zones()
default_get_networks = alicloud.vpc.get_networks(name_regex="^default-NODELETING$")
default_get_switches = alicloud.vpc.get_switches(vpc_id=default_get_networks.ids[0],
    zone_id=default.ids[0])
vswitch_id = default_get_switches.ids[0]
cluster = alicloud.adb.DBCluster("cluster",
    db_cluster_category="MixedStorage",
    mode="flexible",
    compute_resource="8Core32GB",
    vswitch_id=vswitch_id,
    description=name)
default_backup_policy = alicloud.adb.BackupPolicy("default",
    db_cluster_id=cluster.id,
    preferred_backup_periods=[
        "Tuesday",
        "Wednesday",
    ],
    preferred_backup_time="10:00Z-11:00Z")

    package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/adb"
	"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
		}
		_default, err := adb.GetZones(ctx, &adb.GetZonesArgs{}, nil)
		if err != nil {
			return err
		}
		defaultGetNetworks, err := vpc.GetNetworks(ctx, &vpc.GetNetworksArgs{
			NameRegex: pulumi.StringRef("^default-NODELETING$"),
		}, nil)
		if err != nil {
			return err
		}
		defaultGetSwitches, err := vpc.GetSwitches(ctx, &vpc.GetSwitchesArgs{
			VpcId:  pulumi.StringRef(defaultGetNetworks.Ids[0]),
			ZoneId: pulumi.StringRef(_default.Ids[0]),
		}, nil)
		if err != nil {
			return err
		}
		vswitchId := defaultGetSwitches.Ids[0]
		cluster, err := adb.NewDBCluster(ctx, "cluster", &adb.DBClusterArgs{
			DbClusterCategory: pulumi.String("MixedStorage"),
			Mode:              pulumi.String("flexible"),
			ComputeResource:   pulumi.String("8Core32GB"),
			VswitchId:         pulumi.String(vswitchId),
			Description:       pulumi.String(name),
		})
		if err != nil {
			return err
		}
		_, err = adb.NewBackupPolicy(ctx, "default", &adb.BackupPolicyArgs{
			DbClusterId: cluster.ID(),
			PreferredBackupPeriods: pulumi.StringArray{
				pulumi.String("Tuesday"),
				pulumi.String("Wednesday"),
			},
			PreferredBackupTime: pulumi.String("10:00Z-11:00Z"),
		})
		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 @default = AliCloud.Adb.GetZones.Invoke();

    var defaultGetNetworks = AliCloud.Vpc.GetNetworks.Invoke(new()
    {
        NameRegex = "^default-NODELETING$",
    });

    var defaultGetSwitches = AliCloud.Vpc.GetSwitches.Invoke(new()
    {
        VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
        ZoneId = @default.Apply(getZonesResult => getZonesResult.Ids[0]),
    });

    var vswitchId = defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]);

    var cluster = new AliCloud.Adb.DBCluster("cluster", new()
    {
        DbClusterCategory = "MixedStorage",
        Mode = "flexible",
        ComputeResource = "8Core32GB",
        VswitchId = vswitchId,
        Description = name,
    });

    var defaultBackupPolicy = new AliCloud.Adb.BackupPolicy("default", new()
    {
        DbClusterId = cluster.Id,
        PreferredBackupPeriods = new[]
        {
            "Tuesday",
            "Wednesday",
        },
        PreferredBackupTime = "10:00Z-11:00Z",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.adb.AdbFunctions;
import com.pulumi.alicloud.adb.inputs.GetZonesArgs;
import com.pulumi.alicloud.vpc.VpcFunctions;
import com.pulumi.alicloud.vpc.inputs.GetNetworksArgs;
import com.pulumi.alicloud.vpc.inputs.GetSwitchesArgs;
import com.pulumi.alicloud.adb.DBCluster;
import com.pulumi.alicloud.adb.DBClusterArgs;
import com.pulumi.alicloud.adb.BackupPolicy;
import com.pulumi.alicloud.adb.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 default = AdbFunctions.getZones(GetZonesArgs.builder()
            .build());

        final var defaultGetNetworks = VpcFunctions.getNetworks(GetNetworksArgs.builder()
            .nameRegex("^default-NODELETING$")
            .build());

        final var defaultGetSwitches = VpcFunctions.getSwitches(GetSwitchesArgs.builder()
            .vpcId(defaultGetNetworks.ids()[0])
            .zoneId(default_.ids()[0])
            .build());

        final var vswitchId = defaultGetSwitches.ids()[0];

        var cluster = new DBCluster("cluster", DBClusterArgs.builder()
            .dbClusterCategory("MixedStorage")
            .mode("flexible")
            .computeResource("8Core32GB")
            .vswitchId(vswitchId)
            .description(name)
            .build());

        var defaultBackupPolicy = new BackupPolicy("defaultBackupPolicy", BackupPolicyArgs.builder()
            .dbClusterId(cluster.id())
            .preferredBackupPeriods(            
                "Tuesday",
                "Wednesday")
            .preferredBackupTime("10:00Z-11:00Z")
            .build());

    }
}

    configuration:
  name:
    type: string
    default: terraform-example
resources:
  cluster:
    type: alicloud:adb:DBCluster
    properties:
      dbClusterCategory: MixedStorage
      mode: flexible
      computeResource: 8Core32GB
      vswitchId: ${vswitchId}
      description: ${name}
  defaultBackupPolicy:
    type: alicloud:adb:BackupPolicy
    name: default
    properties:
      dbClusterId: ${cluster.id}
      preferredBackupPeriods:
        - Tuesday
        - Wednesday
      preferredBackupTime: 10:00Z-11:00Z
variables:
  default:
    fn::invoke:
      function: alicloud:adb:getZones
      arguments: {}
  defaultGetNetworks:
    fn::invoke:
      function: alicloud:vpc:getNetworks
      arguments:
        nameRegex: ^default-NODELETING$
  defaultGetSwitches:
    fn::invoke:
      function: alicloud:vpc:getSwitches
      arguments:
        vpcId: ${defaultGetNetworks.ids[0]}
        zoneId: ${default.ids[0]}
  vswitchId: ${defaultGetSwitches.ids[0]}

    Removing alicloud.adb.Cluster from your configuration

    The alicloud.adb.BackupPolicy resource allows you to manage your adb cluster policy, but Terraform cannot destroy it. Removing this resource from your configuration will remove it from your statefile and management, but will not destroy the cluster policy. You can resume managing the cluster via the adb Console.

    📚 Need more examples? VIEW MORE EXAMPLES

    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,
                 db_cluster_id: Optional[str] = None,
                 preferred_backup_periods: Optional[Sequence[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:adb: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 backupPolicyResource = new AliCloud.Adb.BackupPolicy("backupPolicyResource", new()
{
    DbClusterId = "string",
    PreferredBackupPeriods = new[]
    {
        "string",
    },
    PreferredBackupTime = "string",
});

    example, err := adb.NewBackupPolicy(ctx, "backupPolicyResource", &adb.BackupPolicyArgs{
	DbClusterId: pulumi.String("string"),
	PreferredBackupPeriods: pulumi.StringArray{
		pulumi.String("string"),
	},
	PreferredBackupTime: pulumi.String("string"),
})

    var backupPolicyResource = new com.pulumi.alicloud.adb.BackupPolicy("backupPolicyResource", com.pulumi.alicloud.adb.BackupPolicyArgs.builder()
    .dbClusterId("string")
    .preferredBackupPeriods("string")
    .preferredBackupTime("string")
    .build());

    backup_policy_resource = alicloud.adb.BackupPolicy("backupPolicyResource",
    db_cluster_id="string",
    preferred_backup_periods=["string"],
    preferred_backup_time="string")

    const backupPolicyResource = new alicloud.adb.BackupPolicy("backupPolicyResource", {
    dbClusterId: "string",
    preferredBackupPeriods: ["string"],
    preferredBackupTime: "string",
});

    type: alicloud:adb:BackupPolicy
properties:
    dbClusterId: string
    preferredBackupPeriods:
        - 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:

    DbClusterId string
    The Id of cluster that can run database.
    PreferredBackupPeriods List<string>
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    PreferredBackupTime string
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    DbClusterId string
    The Id of cluster that can run database.
    PreferredBackupPeriods []string
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    PreferredBackupTime string
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    dbClusterId String
    The Id of cluster that can run database.
    preferredBackupPeriods List<String>
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferredBackupTime String
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    dbClusterId string
    The Id of cluster that can run database.
    preferredBackupPeriods string[]
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferredBackupTime string
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    db_cluster_id str
    The Id of cluster that can run database.
    preferred_backup_periods Sequence[str]
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferred_backup_time str
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    dbClusterId String
    The Id of cluster that can run database.
    preferredBackupPeriods List<String>
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferredBackupTime String
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.

    Outputs

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

    BackupRetentionPeriod string
    Cluster backup retention days, Fixed for 7 days, not modified.
    Id string
    The provider-assigned unique ID for this managed resource.
    BackupRetentionPeriod string
    Cluster backup retention days, Fixed for 7 days, not modified.
    Id string
    The provider-assigned unique ID for this managed resource.
    backupRetentionPeriod String
    Cluster backup retention days, Fixed for 7 days, not modified.
    id String
    The provider-assigned unique ID for this managed resource.
    backupRetentionPeriod string
    Cluster backup retention days, Fixed for 7 days, not modified.
    id string
    The provider-assigned unique ID for this managed resource.
    backup_retention_period str
    Cluster backup retention days, Fixed for 7 days, not modified.
    id str
    The provider-assigned unique ID for this managed resource.
    backupRetentionPeriod String
    Cluster backup retention days, Fixed for 7 days, not modified.
    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[str] = None,
        db_cluster_id: Optional[str] = None,
        preferred_backup_periods: Optional[Sequence[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:adb: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 string
    Cluster backup retention days, Fixed for 7 days, not modified.
    DbClusterId string
    The Id of cluster that can run database.
    PreferredBackupPeriods List<string>
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    PreferredBackupTime string
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    BackupRetentionPeriod string
    Cluster backup retention days, Fixed for 7 days, not modified.
    DbClusterId string
    The Id of cluster that can run database.
    PreferredBackupPeriods []string
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    PreferredBackupTime string
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    backupRetentionPeriod String
    Cluster backup retention days, Fixed for 7 days, not modified.
    dbClusterId String
    The Id of cluster that can run database.
    preferredBackupPeriods List<String>
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferredBackupTime String
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    backupRetentionPeriod string
    Cluster backup retention days, Fixed for 7 days, not modified.
    dbClusterId string
    The Id of cluster that can run database.
    preferredBackupPeriods string[]
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferredBackupTime string
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    backup_retention_period str
    Cluster backup retention days, Fixed for 7 days, not modified.
    db_cluster_id str
    The Id of cluster that can run database.
    preferred_backup_periods Sequence[str]
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferred_backup_time str
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.
    backupRetentionPeriod String
    Cluster backup retention days, Fixed for 7 days, not modified.
    dbClusterId String
    The Id of cluster that can run database.
    preferredBackupPeriods List<String>
    ADB Cluster backup period. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday].
    preferredBackupTime String
    ADB Cluster backup time, in the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. China time is 8 hours behind it.

    Import

    ADB backup policy can be imported using the id or cluster id, e.g.

    $ pulumi import alicloud:adb/backupPolicy:BackupPolicy example "am-12345678"

    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
    Viewing docs for Alibaba Cloud v3.97.0
    published on Saturday, Mar 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-alicloud
      Try Pulumi Cloud free. Your team will thank you.