1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. gpdb
  5. BackupPolicy
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi
alicloud logo
Viewing docs for Alibaba Cloud v3.97.0
published on Saturday, Mar 14, 2026 by Pulumi

    Provides a GPDB Backup Policy resource. Describe the instance backup strategy.

    For information about GPDB Backup Policy and how to use it, see What is Backup Policy.

    NOTE: Available since v1.211.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    import * as std from "@pulumi/std";
    
    const config = new pulumi.Config();
    const name = config.get("name") || "terraform-example";
    const _default = alicloud.gpdb.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 vswitch: alicloud.vpc.Switch[] = [];
    defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids).length.apply(length => {
        for (const range = {value: 0}; range.value < (length > 0 ? 0 : 1); range.value++) {
            vswitch.push(new alicloud.vpc.Switch(`vswitch-${range.value}`, {
                vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0]),
                cidrBlock: defaultGetNetworks.then(defaultGetNetworks => std.cidrsubnet({
                    input: defaultGetNetworks.vpcs?.[0]?.cidrBlock,
                    newbits: 8,
                    netnum: 8,
                })).then(invoke => invoke.result),
                zoneId: _default.then(_default => _default.ids?.[0]),
                vswitchName: name,
            }));
        }
    });
    const vswitchId = pulumi.all([defaultGetSwitches.then(defaultGetSwitches => defaultGetSwitches.ids).length, defaultGetSwitches, std.concat({
        input: [
            vswitch.map(__item => __item.id),
            [""],
        ],
    })]).apply(([length, defaultGetSwitches, invoke]) => length > 0 ? defaultGetSwitches.ids?.[0] : invoke.result?.[0]);
    const defaultInstance = new alicloud.gpdb.Instance("default", {
        dbInstanceCategory: "HighAvailability",
        dbInstanceClass: "gpdb.group.segsdx1",
        dbInstanceMode: "StorageElastic",
        description: name,
        engine: "gpdb",
        engineVersion: "6.0",
        zoneId: _default.then(_default => _default.ids?.[0]),
        instanceNetworkType: "VPC",
        instanceSpec: "2C16G",
        paymentType: "PayAsYouGo",
        segStorageType: "cloud_essd",
        segNodeNum: 4,
        storageSize: 50,
        vpcId: defaultGetNetworks.then(defaultGetNetworks => defaultGetNetworks.ids?.[0]),
        vswitchId: vswitchId,
        ipWhitelists: [{
            securityIpList: "127.0.0.1",
        }],
        tags: {
            Created: "TF",
            For: "acceptance test",
        },
    });
    const defaultBackupPolicy = new alicloud.gpdb.BackupPolicy("default", {
        dbInstanceId: defaultInstance.id,
        recoveryPointPeriod: "1",
        enableRecoveryPoint: true,
        preferredBackupPeriod: "Wednesday",
        preferredBackupTime: "15:00Z-16:00Z",
        backupRetentionPeriod: 7,
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_std as std
    
    config = pulumi.Config()
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default = alicloud.gpdb.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 = []
    def create_vswitch(range_body):
        for range in [{"value": i} for i in range(0, range_body)]:
            vswitch.append(alicloud.vpc.Switch(f"vswitch-{range['value']}",
                vpc_id=default_get_networks.ids[0],
                cidr_block=std.cidrsubnet(input=default_get_networks.vpcs[0].cidr_block,
                    newbits=8,
                    netnum=8).result,
                zone_id=default.ids[0],
                vswitch_name=name))
    
    len(default_get_switches.ids).apply(lambda resolved_outputs: create_vswitch(0 if resolved_outputs['length'] > 0 else 1))
    vswitch_id = len(default_get_switches.ids).apply(lambda length: default_get_switches.ids[0] if length > 0 else std.concat(input=[
        [__item.id for __item in vswitch],
        [""],
    ]).result[0])
    default_instance = alicloud.gpdb.Instance("default",
        db_instance_category="HighAvailability",
        db_instance_class="gpdb.group.segsdx1",
        db_instance_mode="StorageElastic",
        description=name,
        engine="gpdb",
        engine_version="6.0",
        zone_id=default.ids[0],
        instance_network_type="VPC",
        instance_spec="2C16G",
        payment_type="PayAsYouGo",
        seg_storage_type="cloud_essd",
        seg_node_num=4,
        storage_size=50,
        vpc_id=default_get_networks.ids[0],
        vswitch_id=vswitch_id,
        ip_whitelists=[{
            "security_ip_list": "127.0.0.1",
        }],
        tags={
            "Created": "TF",
            "For": "acceptance test",
        })
    default_backup_policy = alicloud.gpdb.BackupPolicy("default",
        db_instance_id=default_instance.id,
        recovery_point_period="1",
        enable_recovery_point=True,
        preferred_backup_period="Wednesday",
        preferred_backup_time="15:00Z-16:00Z",
        backup_retention_period=7)
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/gpdb"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"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 := gpdb.GetZones(ctx, &gpdb.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
    }
    invokeCidrsubnet, err := std.Cidrsubnet(ctx, &std.CidrsubnetArgs{
    Input: defaultGetNetworks.Vpcs[0].CidrBlock,
    Newbits: 8,
    Netnum: 8,
    }, nil)
    if err != nil {
    return err
    }
    var tmp0 float64
    if length > 0 {
    tmp0 = 0
    } else {
    tmp0 = 1
    }
    var vswitch []*vpc.Switch
    for index := 0; index < float64(len(defaultGetSwitches.Ids).ApplyT(func(length int) (float64, error) {
    return tmp0, nil
    }).(pulumi.Float64Output)); index++ {
        key0 := index
        _ := index
    __res, err := vpc.NewSwitch(ctx, fmt.Sprintf("vswitch-%v", key0), &vpc.SwitchArgs{
    VpcId: pulumi.String(defaultGetNetworks.Ids[0]),
    CidrBlock: pulumi.String(invokeCidrsubnet.Result),
    ZoneId: pulumi.String(_default.Ids[0]),
    VswitchName: pulumi.String(name),
    })
    if err != nil {
    return err
    }
    vswitch = append(vswitch, __res)
    }
    var tmp1 *interface{}
    if length > 0 {
    tmp1 = defaultGetSwitches.Ids[0]
    } else {
    tmp1 = std.Concat(ctx, &std.ConcatArgs{
    Input: pulumi.StringArrayArray{
    %!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:26,12-25),
    []string{
    "",
    },
    },
    }, nil).Result[0]
    }
    vswitchId := len(defaultGetSwitches.Ids).ApplyT(func(length int) (*interface{}, error) {
    return &tmp1, nil
    }).(pulumi.Interface{}PtrOutput)
    defaultInstance, err := gpdb.NewInstance(ctx, "default", &gpdb.InstanceArgs{
    DbInstanceCategory: pulumi.String("HighAvailability"),
    DbInstanceClass: pulumi.String("gpdb.group.segsdx1"),
    DbInstanceMode: pulumi.String("StorageElastic"),
    Description: pulumi.String(name),
    Engine: pulumi.String("gpdb"),
    EngineVersion: pulumi.String("6.0"),
    ZoneId: pulumi.String(_default.Ids[0]),
    InstanceNetworkType: pulumi.String("VPC"),
    InstanceSpec: pulumi.String("2C16G"),
    PaymentType: pulumi.String("PayAsYouGo"),
    SegStorageType: pulumi.String("cloud_essd"),
    SegNodeNum: pulumi.Int(4),
    StorageSize: pulumi.Int(50),
    VpcId: pulumi.String(defaultGetNetworks.Ids[0]),
    VswitchId: pulumi.Any(vswitchId),
    IpWhitelists: gpdb.InstanceIpWhitelistArray{
    &gpdb.InstanceIpWhitelistArgs{
    SecurityIpList: pulumi.String("127.0.0.1"),
    },
    },
    Tags: pulumi.StringMap{
    "Created": pulumi.String("TF"),
    "For": pulumi.String("acceptance test"),
    },
    })
    if err != nil {
    return err
    }
    _, err = gpdb.NewBackupPolicy(ctx, "default", &gpdb.BackupPolicyArgs{
    DbInstanceId: defaultInstance.ID(),
    RecoveryPointPeriod: pulumi.String("1"),
    EnableRecoveryPoint: pulumi.Bool(true),
    PreferredBackupPeriod: pulumi.String("Wednesday"),
    PreferredBackupTime: pulumi.String("15:00Z-16:00Z"),
    BackupRetentionPeriod: pulumi.Int(7),
    })
    if err != nil {
    return err
    }
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var name = config.Get("name") ?? "terraform-example";
        var @default = AliCloud.Gpdb.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 vswitch = new List<AliCloud.Vpc.Switch>();
        for (var rangeIndex = 0; rangeIndex < defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids).Length.Apply(length => length > 0 ? 0 : 1); rangeIndex++)
        {
            var range = new { Value = rangeIndex };
            vswitch.Add(new AliCloud.Vpc.Switch($"vswitch-{range.Value}", new()
            {
                VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
                CidrBlock = Std.Cidrsubnet.Invoke(new()
                {
                    Input = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Vpcs[0]?.CidrBlock),
                    Newbits = 8,
                    Netnum = 8,
                }).Apply(invoke => invoke.Result),
                ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids[0])),
                VswitchName = name,
            }));
        }
        var vswitchId = Output.Tuple(defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids).Length, defaultGetSwitches, Std.Concat.Invoke(new()
        {
            Input = new[]
            {
                vswitch.Select(__item => __item.Id).ToList(),
                new[]
                {
                    "",
                },
            },
        })).Apply(values =>
        {
            var length = values.Item1;
            var defaultGetSwitches = values.Item2;
            var invoke = values.Item3;
            return length > 0 ? defaultGetSwitches.Apply(getSwitchesResult => getSwitchesResult.Ids[0]) : invoke.Result[0];
        });
    
        var defaultInstance = new AliCloud.Gpdb.Instance("default", new()
        {
            DbInstanceCategory = "HighAvailability",
            DbInstanceClass = "gpdb.group.segsdx1",
            DbInstanceMode = "StorageElastic",
            Description = name,
            Engine = "gpdb",
            EngineVersion = "6.0",
            ZoneId = @default.Apply(@default => @default.Apply(getZonesResult => getZonesResult.Ids[0])),
            InstanceNetworkType = "VPC",
            InstanceSpec = "2C16G",
            PaymentType = "PayAsYouGo",
            SegStorageType = "cloud_essd",
            SegNodeNum = 4,
            StorageSize = 50,
            VpcId = defaultGetNetworks.Apply(getNetworksResult => getNetworksResult.Ids[0]),
            VswitchId = vswitchId,
            IpWhitelists = new[]
            {
                new AliCloud.Gpdb.Inputs.InstanceIpWhitelistArgs
                {
                    SecurityIpList = "127.0.0.1",
                },
            },
            Tags = 
            {
                { "Created", "TF" },
                { "For", "acceptance test" },
            },
        });
    
        var defaultBackupPolicy = new AliCloud.Gpdb.BackupPolicy("default", new()
        {
            DbInstanceId = defaultInstance.Id,
            RecoveryPointPeriod = "1",
            EnableRecoveryPoint = true,
            PreferredBackupPeriod = "Wednesday",
            PreferredBackupTime = "15:00Z-16:00Z",
            BackupRetentionPeriod = 7,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.gpdb.GpdbFunctions;
    import com.pulumi.alicloud.gpdb.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.vpc.Switch;
    import com.pulumi.alicloud.vpc.SwitchArgs;
    import com.pulumi.std.StdFunctions;
    import com.pulumi.std.inputs.CidrsubnetArgs;
    import com.pulumi.std.inputs.ConcatArgs;
    import com.pulumi.alicloud.gpdb.Instance;
    import com.pulumi.alicloud.gpdb.InstanceArgs;
    import com.pulumi.alicloud.gpdb.inputs.InstanceIpWhitelistArgs;
    import com.pulumi.alicloud.gpdb.BackupPolicy;
    import com.pulumi.alicloud.gpdb.BackupPolicyArgs;
    import com.pulumi.codegen.internal.KeyedValue;
    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 = GpdbFunctions.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());
    
            for (var i = 0; i < defaultGetSwitches.ids().length().applyValue(_length -> _length > 0 ? 0 : 1); i++) {
                new Switch("vswitch-" + i, SwitchArgs.builder()
                    .vpcId(defaultGetNetworks.ids()[0])
                    .cidrBlock(StdFunctions.cidrsubnet(CidrsubnetArgs.builder()
                        .input(defaultGetNetworks.vpcs()[0].cidrBlock())
                        .newbits(8)
                        .netnum(8)
                        .build()).result())
                    .zoneId(default_.ids()[0])
                    .vswitchName(name)
                    .build());
    
            
    }
            final var vswitchId = defaultGetSwitches.ids().length().applyValue(_length -> _length > 0 ? defaultGetSwitches.ids()[0] : StdFunctions.concat(ConcatArgs.builder()
                .input(            
                    vswitch.stream().map(element -> element.id()).collect(toList()),
                    "")
                .build()).result()[0]);
    
            var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
                .dbInstanceCategory("HighAvailability")
                .dbInstanceClass("gpdb.group.segsdx1")
                .dbInstanceMode("StorageElastic")
                .description(name)
                .engine("gpdb")
                .engineVersion("6.0")
                .zoneId(default_.ids()[0])
                .instanceNetworkType("VPC")
                .instanceSpec("2C16G")
                .paymentType("PayAsYouGo")
                .segStorageType("cloud_essd")
                .segNodeNum(4)
                .storageSize(50)
                .vpcId(defaultGetNetworks.ids()[0])
                .vswitchId(vswitchId)
                .ipWhitelists(InstanceIpWhitelistArgs.builder()
                    .securityIpList("127.0.0.1")
                    .build())
                .tags(Map.ofEntries(
                    Map.entry("Created", "TF"),
                    Map.entry("For", "acceptance test")
                ))
                .build());
    
            var defaultBackupPolicy = new BackupPolicy("defaultBackupPolicy", BackupPolicyArgs.builder()
                .dbInstanceId(defaultInstance.id())
                .recoveryPointPeriod("1")
                .enableRecoveryPoint(true)
                .preferredBackupPeriod("Wednesday")
                .preferredBackupTime("15:00Z-16:00Z")
                .backupRetentionPeriod(7)
                .build());
    
        }
    }
    
    Example coming soon!
    

    Deleting alicloud.gpdb.BackupPolicy or removing it from your configuration

    Terraform cannot destroy resource alicloud.gpdb.BackupPolicy. Terraform will remove this resource from the state file, however resources may remain.

    📚 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_instance_id: Optional[str] = None,
                     preferred_backup_period: Optional[str] = None,
                     preferred_backup_time: Optional[str] = None,
                     backup_retention_period: Optional[int] = None,
                     enable_recovery_point: Optional[bool] = None,
                     recovery_point_period: 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:gpdb: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 examplebackupPolicyResourceResourceFromGpdbbackupPolicy = new AliCloud.Gpdb.BackupPolicy("examplebackupPolicyResourceResourceFromGpdbbackupPolicy", new()
    {
        DbInstanceId = "string",
        PreferredBackupPeriod = "string",
        PreferredBackupTime = "string",
        BackupRetentionPeriod = 0,
        EnableRecoveryPoint = false,
        RecoveryPointPeriod = "string",
    });
    
    example, err := gpdb.NewBackupPolicy(ctx, "examplebackupPolicyResourceResourceFromGpdbbackupPolicy", &gpdb.BackupPolicyArgs{
    	DbInstanceId:          pulumi.String("string"),
    	PreferredBackupPeriod: pulumi.String("string"),
    	PreferredBackupTime:   pulumi.String("string"),
    	BackupRetentionPeriod: pulumi.Int(0),
    	EnableRecoveryPoint:   pulumi.Bool(false),
    	RecoveryPointPeriod:   pulumi.String("string"),
    })
    
    var examplebackupPolicyResourceResourceFromGpdbbackupPolicy = new com.pulumi.alicloud.gpdb.BackupPolicy("examplebackupPolicyResourceResourceFromGpdbbackupPolicy", com.pulumi.alicloud.gpdb.BackupPolicyArgs.builder()
        .dbInstanceId("string")
        .preferredBackupPeriod("string")
        .preferredBackupTime("string")
        .backupRetentionPeriod(0)
        .enableRecoveryPoint(false)
        .recoveryPointPeriod("string")
        .build());
    
    examplebackup_policy_resource_resource_from_gpdbbackup_policy = alicloud.gpdb.BackupPolicy("examplebackupPolicyResourceResourceFromGpdbbackupPolicy",
        db_instance_id="string",
        preferred_backup_period="string",
        preferred_backup_time="string",
        backup_retention_period=0,
        enable_recovery_point=False,
        recovery_point_period="string")
    
    const examplebackupPolicyResourceResourceFromGpdbbackupPolicy = new alicloud.gpdb.BackupPolicy("examplebackupPolicyResourceResourceFromGpdbbackupPolicy", {
        dbInstanceId: "string",
        preferredBackupPeriod: "string",
        preferredBackupTime: "string",
        backupRetentionPeriod: 0,
        enableRecoveryPoint: false,
        recoveryPointPeriod: "string",
    });
    
    type: alicloud:gpdb:BackupPolicy
    properties:
        backupRetentionPeriod: 0
        dbInstanceId: string
        enableRecoveryPoint: false
        preferredBackupPeriod: string
        preferredBackupTime: string
        recoveryPointPeriod: 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:

    DbInstanceId string

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    PreferredBackupPeriod string
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    PreferredBackupTime string
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    BackupRetentionPeriod int
    Data backup retention days.
    EnableRecoveryPoint bool
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    RecoveryPointPeriod string
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    DbInstanceId string

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    PreferredBackupPeriod string
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    PreferredBackupTime string
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    BackupRetentionPeriod int
    Data backup retention days.
    EnableRecoveryPoint bool
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    RecoveryPointPeriod string
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    dbInstanceId String

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    preferredBackupPeriod String
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferredBackupTime String
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    backupRetentionPeriod Integer
    Data backup retention days.
    enableRecoveryPoint Boolean
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    recoveryPointPeriod String
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    dbInstanceId string

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    preferredBackupPeriod string
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferredBackupTime string
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    backupRetentionPeriod number
    Data backup retention days.
    enableRecoveryPoint boolean
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    recoveryPointPeriod string
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    db_instance_id str

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    preferred_backup_period str
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferred_backup_time str
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    backup_retention_period int
    Data backup retention days.
    enable_recovery_point bool
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    recovery_point_period str
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    dbInstanceId String

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    preferredBackupPeriod String
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferredBackupTime String
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    backupRetentionPeriod Number
    Data backup retention days.
    enableRecoveryPoint Boolean
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    recoveryPointPeriod String
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.

    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,
            enable_recovery_point: Optional[bool] = None,
            preferred_backup_period: Optional[str] = None,
            preferred_backup_time: Optional[str] = None,
            recovery_point_period: 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:gpdb: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
    Data backup retention days.
    DbInstanceId string

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    EnableRecoveryPoint bool
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    PreferredBackupPeriod string
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    PreferredBackupTime string
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    RecoveryPointPeriod string
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    BackupRetentionPeriod int
    Data backup retention days.
    DbInstanceId string

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    EnableRecoveryPoint bool
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    PreferredBackupPeriod string
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    PreferredBackupTime string
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    RecoveryPointPeriod string
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    backupRetentionPeriod Integer
    Data backup retention days.
    dbInstanceId String

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    enableRecoveryPoint Boolean
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    preferredBackupPeriod String
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferredBackupTime String
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    recoveryPointPeriod String
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    backupRetentionPeriod number
    Data backup retention days.
    dbInstanceId string

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    enableRecoveryPoint boolean
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    preferredBackupPeriod string
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferredBackupTime string
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    recoveryPointPeriod string
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    backup_retention_period int
    Data backup retention days.
    db_instance_id str

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    enable_recovery_point bool
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    preferred_backup_period str
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferred_backup_time str
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    recovery_point_period str
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.
    backupRetentionPeriod Number
    Data backup retention days.
    dbInstanceId String

    The instance ID.

    NOTE: You can call the DescribeDBInstances operation to view the details of all AnalyticDB PostgreSQL instances in the target region, including the instance ID.

    enableRecoveryPoint Boolean
    Whether to enable automatic recovery points. Value Description:

    • true: enabled.
    • false: Closed.
    preferredBackupPeriod String
    Data backup cycle. Separate multiple values with commas (,). Value Description:

    • Monday: Monday.
    • Tuesday: Tuesday.
    • Wednesday: Wednesday.
    • Thursday: Thursday.
    • Friday: Friday.
    • Saturday: Saturday.
    • Sunday: Sunday.
    preferredBackupTime String
    Data backup time. Format: HH:mmZ-HH:mmZ(UTC time).
    recoveryPointPeriod String
    Recovery point frequency. Value Description:

    • 1: Hourly.
    • 2: Every two hours.
    • 4: Every four hours.
    • 8: Every eight hours.

    Import

    GPDB Backup Policy can be imported using the id, e.g.

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