Docs Packages
  1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. hbr
  5. EcsBackupPlan
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

alicloud.hbr.EcsBackupPlan

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-alicloud

    Provides a HBR Ecs Backup Plan resource.

    For information about HBR Ecs Backup Plan and how to use it, see What is Ecs Backup Plan.

    NOTE: Available in v1.132.0+.

    Example Usage

    Basic Usage

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

const example = alicloud.getZones({
    availableResourceCreation: "Instance",
});
const exampleGetInstanceTypes = example.then(example => alicloud.ecs.getInstanceTypes({
    availabilityZone: example.zones?.[0]?.id,
    cpuCoreCount: 1,
    memorySize: 2,
}));
const exampleGetImages = alicloud.ecs.getImages({
    nameRegex: "^ubuntu_[0-9]+_[0-9]+_x64*",
    owners: "system",
});
const exampleNetwork = new alicloud.vpc.Network("example", {
    vpcName: "terraform-example",
    cidrBlock: "172.17.3.0/24",
});
const exampleSwitch = new alicloud.vpc.Switch("example", {
    vswitchName: "terraform-example",
    cidrBlock: "172.17.3.0/24",
    vpcId: exampleNetwork.id,
    zoneId: example.then(example => example.zones?.[0]?.id),
});
const exampleSecurityGroup = new alicloud.ecs.SecurityGroup("example", {
    name: "terraform-example",
    vpcId: exampleNetwork.id,
});
const exampleInstance = new alicloud.ecs.Instance("example", {
    imageId: exampleGetImages.then(exampleGetImages => exampleGetImages.images?.[0]?.id),
    instanceType: exampleGetInstanceTypes.then(exampleGetInstanceTypes => exampleGetInstanceTypes.instanceTypes?.[0]?.id),
    availabilityZone: example.then(example => example.zones?.[0]?.id),
    securityGroups: [exampleSecurityGroup.id],
    instanceName: "terraform-example",
    internetChargeType: "PayByBandwidth",
    vswitchId: exampleSwitch.id,
});
const _default = new random.index.Integer("default", {
    min: 10000,
    max: 99999,
});
const exampleVault = new alicloud.hbr.Vault("example", {vaultName: `terraform-example-${_default.result}`});
const exampleEcsBackupPlan = new alicloud.hbr.EcsBackupPlan("example", {
    ecsBackupPlanName: "terraform-example",
    instanceId: exampleInstance.id,
    vaultId: exampleVault.id,
    retention: "1",
    schedule: "I|1602673264|PT2H",
    backupType: "COMPLETE",
    speedLimit: "0:24:5120",
    paths: [
        "/home",
        "/var",
    ],
    exclude: "  [\"/home/exclude\"]\n",
    include: "  [\"/home/include\"]\n",
});

    import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

example = alicloud.get_zones(available_resource_creation="Instance")
example_get_instance_types = alicloud.ecs.get_instance_types(availability_zone=example.zones[0].id,
    cpu_core_count=1,
    memory_size=2)
example_get_images = alicloud.ecs.get_images(name_regex="^ubuntu_[0-9]+_[0-9]+_x64*",
    owners="system")
example_network = alicloud.vpc.Network("example",
    vpc_name="terraform-example",
    cidr_block="172.17.3.0/24")
example_switch = alicloud.vpc.Switch("example",
    vswitch_name="terraform-example",
    cidr_block="172.17.3.0/24",
    vpc_id=example_network.id,
    zone_id=example.zones[0].id)
example_security_group = alicloud.ecs.SecurityGroup("example",
    name="terraform-example",
    vpc_id=example_network.id)
example_instance = alicloud.ecs.Instance("example",
    image_id=example_get_images.images[0].id,
    instance_type=example_get_instance_types.instance_types[0].id,
    availability_zone=example.zones[0].id,
    security_groups=[example_security_group.id],
    instance_name="terraform-example",
    internet_charge_type="PayByBandwidth",
    vswitch_id=example_switch.id)
default = random.index.Integer("default",
    min=10000,
    max=99999)
example_vault = alicloud.hbr.Vault("example", vault_name=f"terraform-example-{default['result']}")
example_ecs_backup_plan = alicloud.hbr.EcsBackupPlan("example",
    ecs_backup_plan_name="terraform-example",
    instance_id=example_instance.id,
    vault_id=example_vault.id,
    retention="1",
    schedule="I|1602673264|PT2H",
    backup_type="COMPLETE",
    speed_limit="0:24:5120",
    paths=[
        "/home",
        "/var",
    ],
    exclude="  [\"/home/exclude\"]\n",
    include="  [\"/home/include\"]\n")

    package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/vpc"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := alicloud.GetZones(ctx, &alicloud.GetZonesArgs{
			AvailableResourceCreation: pulumi.StringRef("Instance"),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetInstanceTypes, err := ecs.GetInstanceTypes(ctx, &ecs.GetInstanceTypesArgs{
			AvailabilityZone: pulumi.StringRef(example.Zones[0].Id),
			CpuCoreCount:     pulumi.IntRef(1),
			MemorySize:       pulumi.Float64Ref(2),
		}, nil)
		if err != nil {
			return err
		}
		exampleGetImages, err := ecs.GetImages(ctx, &ecs.GetImagesArgs{
			NameRegex: pulumi.StringRef("^ubuntu_[0-9]+_[0-9]+_x64*"),
			Owners:    pulumi.StringRef("system"),
		}, nil)
		if err != nil {
			return err
		}
		exampleNetwork, err := vpc.NewNetwork(ctx, "example", &vpc.NetworkArgs{
			VpcName:   pulumi.String("terraform-example"),
			CidrBlock: pulumi.String("172.17.3.0/24"),
		})
		if err != nil {
			return err
		}
		exampleSwitch, err := vpc.NewSwitch(ctx, "example", &vpc.SwitchArgs{
			VswitchName: pulumi.String("terraform-example"),
			CidrBlock:   pulumi.String("172.17.3.0/24"),
			VpcId:       exampleNetwork.ID(),
			ZoneId:      pulumi.String(example.Zones[0].Id),
		})
		if err != nil {
			return err
		}
		exampleSecurityGroup, err := ecs.NewSecurityGroup(ctx, "example", &ecs.SecurityGroupArgs{
			Name:  pulumi.String("terraform-example"),
			VpcId: exampleNetwork.ID(),
		})
		if err != nil {
			return err
		}
		exampleInstance, err := ecs.NewInstance(ctx, "example", &ecs.InstanceArgs{
			ImageId:          pulumi.String(exampleGetImages.Images[0].Id),
			InstanceType:     pulumi.String(exampleGetInstanceTypes.InstanceTypes[0].Id),
			AvailabilityZone: pulumi.String(example.Zones[0].Id),
			SecurityGroups: pulumi.StringArray{
				exampleSecurityGroup.ID(),
			},
			InstanceName:       pulumi.String("terraform-example"),
			InternetChargeType: pulumi.String("PayByBandwidth"),
			VswitchId:          exampleSwitch.ID(),
		})
		if err != nil {
			return err
		}
		_, err = random.NewInteger(ctx, "default", &random.IntegerArgs{
			Min: 10000,
			Max: 99999,
		})
		if err != nil {
			return err
		}
		exampleVault, err := hbr.NewVault(ctx, "example", &hbr.VaultArgs{
			VaultName: pulumi.String(fmt.Sprintf("terraform-example-%v", _default.Result)),
		})
		if err != nil {
			return err
		}
		_, err = hbr.NewEcsBackupPlan(ctx, "example", &hbr.EcsBackupPlanArgs{
			EcsBackupPlanName: pulumi.String("terraform-example"),
			InstanceId:        exampleInstance.ID(),
			VaultId:           exampleVault.ID(),
			Retention:         pulumi.String("1"),
			Schedule:          pulumi.String("I|1602673264|PT2H"),
			BackupType:        pulumi.String("COMPLETE"),
			SpeedLimit:        pulumi.String("0:24:5120"),
			Paths: pulumi.StringArray{
				pulumi.String("/home"),
				pulumi.String("/var"),
			},
			Exclude: pulumi.String("  [\"/home/exclude\"]\n"),
			Include: pulumi.String("  [\"/home/include\"]\n"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = AliCloud.GetZones.Invoke(new()
    {
        AvailableResourceCreation = "Instance",
    });

    var exampleGetInstanceTypes = AliCloud.Ecs.GetInstanceTypes.Invoke(new()
    {
        AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        CpuCoreCount = 1,
        MemorySize = 2,
    });

    var exampleGetImages = AliCloud.Ecs.GetImages.Invoke(new()
    {
        NameRegex = "^ubuntu_[0-9]+_[0-9]+_x64*",
        Owners = "system",
    });

    var exampleNetwork = new AliCloud.Vpc.Network("example", new()
    {
        VpcName = "terraform-example",
        CidrBlock = "172.17.3.0/24",
    });

    var exampleSwitch = new AliCloud.Vpc.Switch("example", new()
    {
        VswitchName = "terraform-example",
        CidrBlock = "172.17.3.0/24",
        VpcId = exampleNetwork.Id,
        ZoneId = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
    });

    var exampleSecurityGroup = new AliCloud.Ecs.SecurityGroup("example", new()
    {
        Name = "terraform-example",
        VpcId = exampleNetwork.Id,
    });

    var exampleInstance = new AliCloud.Ecs.Instance("example", new()
    {
        ImageId = exampleGetImages.Apply(getImagesResult => getImagesResult.Images[0]?.Id),
        InstanceType = exampleGetInstanceTypes.Apply(getInstanceTypesResult => getInstanceTypesResult.InstanceTypes[0]?.Id),
        AvailabilityZone = example.Apply(getZonesResult => getZonesResult.Zones[0]?.Id),
        SecurityGroups = new[]
        {
            exampleSecurityGroup.Id,
        },
        InstanceName = "terraform-example",
        InternetChargeType = "PayByBandwidth",
        VswitchId = exampleSwitch.Id,
    });

    var @default = new Random.Index.Integer("default", new()
    {
        Min = 10000,
        Max = 99999,
    });

    var exampleVault = new AliCloud.Hbr.Vault("example", new()
    {
        VaultName = $"terraform-example-{@default.Result}",
    });

    var exampleEcsBackupPlan = new AliCloud.Hbr.EcsBackupPlan("example", new()
    {
        EcsBackupPlanName = "terraform-example",
        InstanceId = exampleInstance.Id,
        VaultId = exampleVault.Id,
        Retention = "1",
        Schedule = "I|1602673264|PT2H",
        BackupType = "COMPLETE",
        SpeedLimit = "0:24:5120",
        Paths = new[]
        {
            "/home",
            "/var",
        },
        Exclude = @"  [""/home/exclude""]
",
        Include = @"  [""/home/include""]
",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.AlicloudFunctions;
import com.pulumi.alicloud.inputs.GetZonesArgs;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetInstanceTypesArgs;
import com.pulumi.alicloud.ecs.inputs.GetImagesArgs;
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.ecs.SecurityGroup;
import com.pulumi.alicloud.ecs.SecurityGroupArgs;
import com.pulumi.alicloud.ecs.Instance;
import com.pulumi.alicloud.ecs.InstanceArgs;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.hbr.Vault;
import com.pulumi.alicloud.hbr.VaultArgs;
import com.pulumi.alicloud.hbr.EcsBackupPlan;
import com.pulumi.alicloud.hbr.EcsBackupPlanArgs;
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 example = AlicloudFunctions.getZones(GetZonesArgs.builder()
            .availableResourceCreation("Instance")
            .build());

        final var exampleGetInstanceTypes = EcsFunctions.getInstanceTypes(GetInstanceTypesArgs.builder()
            .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .cpuCoreCount(1)
            .memorySize(2)
            .build());

        final var exampleGetImages = EcsFunctions.getImages(GetImagesArgs.builder()
            .nameRegex("^ubuntu_[0-9]+_[0-9]+_x64*")
            .owners("system")
            .build());

        var exampleNetwork = new Network("exampleNetwork", NetworkArgs.builder()
            .vpcName("terraform-example")
            .cidrBlock("172.17.3.0/24")
            .build());

        var exampleSwitch = new Switch("exampleSwitch", SwitchArgs.builder()
            .vswitchName("terraform-example")
            .cidrBlock("172.17.3.0/24")
            .vpcId(exampleNetwork.id())
            .zoneId(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .build());

        var exampleSecurityGroup = new SecurityGroup("exampleSecurityGroup", SecurityGroupArgs.builder()
            .name("terraform-example")
            .vpcId(exampleNetwork.id())
            .build());

        var exampleInstance = new Instance("exampleInstance", InstanceArgs.builder()
            .imageId(exampleGetImages.applyValue(getImagesResult -> getImagesResult.images()[0].id()))
            .instanceType(exampleGetInstanceTypes.applyValue(getInstanceTypesResult -> getInstanceTypesResult.instanceTypes()[0].id()))
            .availabilityZone(example.applyValue(getZonesResult -> getZonesResult.zones()[0].id()))
            .securityGroups(exampleSecurityGroup.id())
            .instanceName("terraform-example")
            .internetChargeType("PayByBandwidth")
            .vswitchId(exampleSwitch.id())
            .build());

        var default_ = new Integer("default", IntegerArgs.builder()
            .min(10000)
            .max(99999)
            .build());

        var exampleVault = new Vault("exampleVault", VaultArgs.builder()
            .vaultName(String.format("terraform-example-%s", default_.result()))
            .build());

        var exampleEcsBackupPlan = new EcsBackupPlan("exampleEcsBackupPlan", EcsBackupPlanArgs.builder()
            .ecsBackupPlanName("terraform-example")
            .instanceId(exampleInstance.id())
            .vaultId(exampleVault.id())
            .retention("1")
            .schedule("I|1602673264|PT2H")
            .backupType("COMPLETE")
            .speedLimit("0:24:5120")
            .paths(            
                "/home",
                "/var")
            .exclude("""
  ["/home/exclude"]
            """)
            .include("""
  ["/home/include"]
            """)
            .build());

    }
}

    resources:
  exampleNetwork:
    type: alicloud:vpc:Network
    name: example
    properties:
      vpcName: terraform-example
      cidrBlock: 172.17.3.0/24
  exampleSwitch:
    type: alicloud:vpc:Switch
    name: example
    properties:
      vswitchName: terraform-example
      cidrBlock: 172.17.3.0/24
      vpcId: ${exampleNetwork.id}
      zoneId: ${example.zones[0].id}
  exampleSecurityGroup:
    type: alicloud:ecs:SecurityGroup
    name: example
    properties:
      name: terraform-example
      vpcId: ${exampleNetwork.id}
  exampleInstance:
    type: alicloud:ecs:Instance
    name: example
    properties:
      imageId: ${exampleGetImages.images[0].id}
      instanceType: ${exampleGetInstanceTypes.instanceTypes[0].id}
      availabilityZone: ${example.zones[0].id}
      securityGroups:
        - ${exampleSecurityGroup.id}
      instanceName: terraform-example
      internetChargeType: PayByBandwidth
      vswitchId: ${exampleSwitch.id}
  default:
    type: random:integer
    properties:
      min: 10000
      max: 99999
  exampleVault:
    type: alicloud:hbr:Vault
    name: example
    properties:
      vaultName: terraform-example-${default.result}
  exampleEcsBackupPlan:
    type: alicloud:hbr:EcsBackupPlan
    name: example
    properties:
      ecsBackupPlanName: terraform-example
      instanceId: ${exampleInstance.id}
      vaultId: ${exampleVault.id}
      retention: '1'
      schedule: I|1602673264|PT2H
      backupType: COMPLETE
      speedLimit: 0:24:5120
      paths:
        - /home
        - /var
      exclude: |2
          ["/home/exclude"]
      include: |2
          ["/home/include"]
variables:
  example:
    fn::invoke:
      Function: alicloud:getZones
      Arguments:
        availableResourceCreation: Instance
  exampleGetInstanceTypes:
    fn::invoke:
      Function: alicloud:ecs:getInstanceTypes
      Arguments:
        availabilityZone: ${example.zones[0].id}
        cpuCoreCount: 1
        memorySize: 2
  exampleGetImages:
    fn::invoke:
      Function: alicloud:ecs:getImages
      Arguments:
        nameRegex: ^ubuntu_[0-9]+_[0-9]+_x64*
        owners: system

    Notice

    About Backup path rules:

    1. If there is no wildcard *, you can enter 8 items of path.
    2. When using wildcard *, only one item of path can be input, and wildcards like /*/* are supported.
    3. Each item of path only supports absolute paths, for example starting with /, \, C:\, D:\.

    About Restrictions:

    1. When using VSS: multiple paths, UNC paths, wildcards, and excluded files not supported.
    2. When using UNC: VSS not supported, wildcards not supported, and files to be excluded are not supported.

    About include/exclude path rules:

    1. Supports up to 8 paths, including paths using wildcards *.
    2. If the path does not contain /, then * matches multiple path names or file names, for example *abc* will match /abc/, /d/eabcd/, /a/abc; *.txt will match all files with an extension .txt.
    3. If the path contains /, each * only matches a single-level path or file name. For example, /a/*/*/ share will match /a/b/c/share, but not /a/d/share.
    4. If the path ends with /, it means the folder matches. For example, *tmp/ will match /a/b/aaatmp/, /tmp/ and so on.
    5. The path separator takes Linux system / as an example, if it is Windows system, please replace it with \.

    Create EcsBackupPlan Resource

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

    Constructor syntax

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

@overload
def EcsBackupPlan(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  ecs_backup_plan_name: Optional[str] = None,
                  vault_id: Optional[str] = None,
                  schedule: Optional[str] = None,
                  retention: Optional[str] = None,
                  backup_type: Optional[str] = None,
                  instance_id: Optional[str] = None,
                  detail: Optional[str] = None,
                  exclude: Optional[str] = None,
                  include: Optional[str] = None,
                  disabled: Optional[bool] = None,
                  options: Optional[str] = None,
                  paths: Optional[Sequence[str]] = None,
                  cross_account_user_id: Optional[int] = None,
                  cross_account_type: Optional[str] = None,
                  speed_limit: Optional[str] = None,
                  update_paths: Optional[bool] = None,
                  cross_account_role_name: Optional[str] = None)
    func NewEcsBackupPlan(ctx *Context, name string, args EcsBackupPlanArgs, opts ...ResourceOption) (*EcsBackupPlan, error)
    public EcsBackupPlan(string name, EcsBackupPlanArgs args, CustomResourceOptions? opts = null)
    public EcsBackupPlan(String name, EcsBackupPlanArgs args)
public EcsBackupPlan(String name, EcsBackupPlanArgs args, CustomResourceOptions options)

    type: alicloud:hbr:EcsBackupPlan
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 EcsBackupPlanArgs
    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 EcsBackupPlanArgs
    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 EcsBackupPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EcsBackupPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EcsBackupPlanArgs
    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 ecsBackupPlanResource = new AliCloud.Hbr.EcsBackupPlan("ecsBackupPlanResource", new()
{
    EcsBackupPlanName = "string",
    VaultId = "string",
    Schedule = "string",
    Retention = "string",
    BackupType = "string",
    InstanceId = "string",
    Detail = "string",
    Exclude = "string",
    Include = "string",
    Disabled = false,
    Options = "string",
    Paths = new[]
    {
        "string",
    },
    CrossAccountUserId = 0,
    CrossAccountType = "string",
    SpeedLimit = "string",
    CrossAccountRoleName = "string",
});

    example, err := hbr.NewEcsBackupPlan(ctx, "ecsBackupPlanResource", &hbr.EcsBackupPlanArgs{
	EcsBackupPlanName: pulumi.String("string"),
	VaultId:           pulumi.String("string"),
	Schedule:          pulumi.String("string"),
	Retention:         pulumi.String("string"),
	BackupType:        pulumi.String("string"),
	InstanceId:        pulumi.String("string"),
	Detail:            pulumi.String("string"),
	Exclude:           pulumi.String("string"),
	Include:           pulumi.String("string"),
	Disabled:          pulumi.Bool(false),
	Options:           pulumi.String("string"),
	Paths: pulumi.StringArray{
		pulumi.String("string"),
	},
	CrossAccountUserId:   pulumi.Int(0),
	CrossAccountType:     pulumi.String("string"),
	SpeedLimit:           pulumi.String("string"),
	CrossAccountRoleName: pulumi.String("string"),
})

    var ecsBackupPlanResource = new EcsBackupPlan("ecsBackupPlanResource", EcsBackupPlanArgs.builder()
    .ecsBackupPlanName("string")
    .vaultId("string")
    .schedule("string")
    .retention("string")
    .backupType("string")
    .instanceId("string")
    .detail("string")
    .exclude("string")
    .include("string")
    .disabled(false)
    .options("string")
    .paths("string")
    .crossAccountUserId(0)
    .crossAccountType("string")
    .speedLimit("string")
    .crossAccountRoleName("string")
    .build());

    ecs_backup_plan_resource = alicloud.hbr.EcsBackupPlan("ecsBackupPlanResource",
    ecs_backup_plan_name="string",
    vault_id="string",
    schedule="string",
    retention="string",
    backup_type="string",
    instance_id="string",
    detail="string",
    exclude="string",
    include="string",
    disabled=False,
    options="string",
    paths=["string"],
    cross_account_user_id=0,
    cross_account_type="string",
    speed_limit="string",
    cross_account_role_name="string")

    const ecsBackupPlanResource = new alicloud.hbr.EcsBackupPlan("ecsBackupPlanResource", {
    ecsBackupPlanName: "string",
    vaultId: "string",
    schedule: "string",
    retention: "string",
    backupType: "string",
    instanceId: "string",
    detail: "string",
    exclude: "string",
    include: "string",
    disabled: false,
    options: "string",
    paths: ["string"],
    crossAccountUserId: 0,
    crossAccountType: "string",
    speedLimit: "string",
    crossAccountRoleName: "string",
});

    type: alicloud:hbr:EcsBackupPlan
properties:
    backupType: string
    crossAccountRoleName: string
    crossAccountType: string
    crossAccountUserId: 0
    detail: string
    disabled: false
    ecsBackupPlanName: string
    exclude: string
    include: string
    instanceId: string
    options: string
    paths:
        - string
    retention: string
    schedule: string
    speedLimit: string
    vaultId: string

    EcsBackupPlan Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The EcsBackupPlan resource accepts the following input properties:

    BackupType string
    Backup type. Valid values: COMPLETE.
    EcsBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    InstanceId string
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    VaultId string
    The ID of Backup vault.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Detail string
    The detail of the backup plan.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    Exclude string
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    Include string
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    Options string
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    Paths List<string>
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    SpeedLimit string
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    UpdatePaths bool
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    BackupType string
    Backup type. Valid values: COMPLETE.
    EcsBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    InstanceId string
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    VaultId string
    The ID of Backup vault.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Detail string
    The detail of the backup plan.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    Exclude string
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    Include string
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    Options string
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    Paths []string
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    SpeedLimit string
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    UpdatePaths bool
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    backupType String
    Backup type. Valid values: COMPLETE.
    ecsBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    instanceId String
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId String
    The ID of Backup vault.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Integer
    The original account ID of the cross account backup managed by the current account.
    detail String
    The detail of the backup plan.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    exclude String
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include String
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    options String
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths List<String>
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    speedLimit String
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    updatePaths Boolean
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    backupType string
    Backup type. Valid values: COMPLETE.
    ecsBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    instanceId string
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    retention string
    Backup retention days, the minimum is 1.
    schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId string
    The ID of Backup vault.
    crossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId number
    The original account ID of the cross account backup managed by the current account.
    detail string
    The detail of the backup plan.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    exclude string
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include string
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    options string
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths string[]
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    speedLimit string
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    updatePaths boolean
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    backup_type str
    Backup type. Valid values: COMPLETE.
    ecs_backup_plan_name str
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    instance_id str
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    retention str
    Backup retention days, the minimum is 1.
    schedule str
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vault_id str
    The ID of Backup vault.
    cross_account_role_name str
    The role name created in the original account RAM backup by the cross account managed by the current account.
    cross_account_type str
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    cross_account_user_id int
    The original account ID of the cross account backup managed by the current account.
    detail str
    The detail of the backup plan.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    exclude str
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include str
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    options str
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths Sequence[str]
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    speed_limit str
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    update_paths bool
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    backupType String
    Backup type. Valid values: COMPLETE.
    ecsBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    instanceId String
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    vaultId String
    The ID of Backup vault.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Number
    The original account ID of the cross account backup managed by the current account.
    detail String
    The detail of the backup plan.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    exclude String
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include String
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    options String
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths List<String>
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    speedLimit String
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    updatePaths Boolean
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    Outputs

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

    Get an existing EcsBackupPlan 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?: EcsBackupPlanState, opts?: CustomResourceOptions): EcsBackupPlan
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_type: Optional[str] = None,
        cross_account_role_name: Optional[str] = None,
        cross_account_type: Optional[str] = None,
        cross_account_user_id: Optional[int] = None,
        detail: Optional[str] = None,
        disabled: Optional[bool] = None,
        ecs_backup_plan_name: Optional[str] = None,
        exclude: Optional[str] = None,
        include: Optional[str] = None,
        instance_id: Optional[str] = None,
        options: Optional[str] = None,
        paths: Optional[Sequence[str]] = None,
        retention: Optional[str] = None,
        schedule: Optional[str] = None,
        speed_limit: Optional[str] = None,
        update_paths: Optional[bool] = None,
        vault_id: Optional[str] = None) -> EcsBackupPlan
    func GetEcsBackupPlan(ctx *Context, name string, id IDInput, state *EcsBackupPlanState, opts ...ResourceOption) (*EcsBackupPlan, error)
    public static EcsBackupPlan Get(string name, Input<string> id, EcsBackupPlanState? state, CustomResourceOptions? opts = null)
    public static EcsBackupPlan get(String name, Output<String> id, EcsBackupPlanState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    BackupType string
    Backup type. Valid values: COMPLETE.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Detail string
    The detail of the backup plan.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    EcsBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Exclude string
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    Include string
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    InstanceId string
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    Options string
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    Paths List<string>
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    SpeedLimit string
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    UpdatePaths bool
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    VaultId string
    The ID of Backup vault.
    BackupType string
    Backup type. Valid values: COMPLETE.
    CrossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    CrossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    CrossAccountUserId int
    The original account ID of the cross account backup managed by the current account.
    Detail string
    The detail of the backup plan.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    EcsBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    Exclude string
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    Include string
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    InstanceId string
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    Options string
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    Paths []string
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    SpeedLimit string
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    UpdatePaths bool
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    VaultId string
    The ID of Backup vault.
    backupType String
    Backup type. Valid values: COMPLETE.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Integer
    The original account ID of the cross account backup managed by the current account.
    detail String
    The detail of the backup plan.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    ecsBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    exclude String
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include String
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    instanceId String
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    options String
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths List<String>
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    speedLimit String
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    updatePaths Boolean
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    vaultId String
    The ID of Backup vault.
    backupType string
    Backup type. Valid values: COMPLETE.
    crossAccountRoleName string
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType string
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId number
    The original account ID of the cross account backup managed by the current account.
    detail string
    The detail of the backup plan.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    ecsBackupPlanName string
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    exclude string
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include string
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    instanceId string
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    options string
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths string[]
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    retention string
    Backup retention days, the minimum is 1.
    schedule string
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    speedLimit string
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    updatePaths boolean
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    vaultId string
    The ID of Backup vault.
    backup_type str
    Backup type. Valid values: COMPLETE.
    cross_account_role_name str
    The role name created in the original account RAM backup by the cross account managed by the current account.
    cross_account_type str
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    cross_account_user_id int
    The original account ID of the cross account backup managed by the current account.
    detail str
    The detail of the backup plan.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    ecs_backup_plan_name str
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    exclude str
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include str
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    instance_id str
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    options str
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths Sequence[str]
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    retention str
    Backup retention days, the minimum is 1.
    schedule str
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    speed_limit str
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    update_paths bool
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    vault_id str
    The ID of Backup vault.
    backupType String
    Backup type. Valid values: COMPLETE.
    crossAccountRoleName String
    The role name created in the original account RAM backup by the cross account managed by the current account.
    crossAccountType String
    The type of the cross account backup. Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.
    crossAccountUserId Number
    The original account ID of the cross account backup managed by the current account.
    detail String
    The detail of the backup plan.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    ecsBackupPlanName String
    The name of the backup plan. 1~64 characters, the backup plan name of each data source type in a single warehouse required to be unique.
    exclude String
    Exclude path. String of Json list, up to 255 characters. e.g. "[\"/home/work\"]"
    include String
    Include path. String of Json list, up to 255 characters. e.g. "[\"/var\"]"
    instanceId String
    The ID of ECS instance. The ecs backup client must have been installed on the host.
    options String
    Windows operating system with application consistency using VSS, e.g: {\"UseVSS\":false}.
    paths List<String>
    List of backup path. e.g. ["/home", "/var"]. Note If path is empty, it means that all directories will be backed up.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy. Optional format: I|{startTime}|{interval}. It means to execute a backup task every {interval} starting from {startTime}. The backup task for the elapsed time will not be compensated. If the last backup task has not completed yet, the next backup task will not be triggered.

    • startTime Backup start time, UNIX time seconds.
    speedLimit String
    Flow control. The format is: {start}|{end}|{bandwidth}. Use | to separate multiple flow control configurations, multiple flow control configurations not allowed to have overlapping times.
    updatePaths Boolean
    Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.

    Deprecated: Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.

    vaultId String
    The ID of Backup vault.

    Import

    HBR Ecs Backup Plan can be imported using the id, e.g.

    $ pulumi import alicloud:hbr/ecsBackupPlan:EcsBackupPlan 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.57.1 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-alicloud