Alibaba Cloud v3.37.0, May 15 23
Alibaba Cloud v3.37.0, May 15 23
alicloud.hbr.EcsBackupPlan
Explore with Pulumi AI
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+.
Notice
About Backup path rules:
- If there is no wildcard
*
, you can enter 8 items of path. - When using wildcard
*
, only one item of path can be input, and wildcards like/*/*
are supported. - Each item of path only supports absolute paths, for example starting with
/
,\
,C:\
,D:\
.
About Restrictions:
- When using
VSS
: multiple paths, UNC paths, wildcards, and excluded files not supported. - When using
UNC
: VSS not supported, wildcards not supported, and files to be excluded are not supported.
About include/exclude path rules:
- Supports up to 8 paths, including paths using wildcards
*
. - 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
. - 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
. - If the path ends with
/
, it means the folder matches. For example,*tmp/
will match/a/b/aaatmp/
,/tmp/
and so on. - The path separator takes Linux system
/
as an example, if it is Windows system, please replace it with\
.
Example Usage
Basic Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var config = new Config();
var name = config.Get("name") ?? "valut-name";
var defaultVault = new AliCloud.Hbr.Vault("defaultVault", new()
{
VaultName = name,
});
var defaultInstances = AliCloud.Ecs.GetInstances.Invoke(new()
{
NameRegex = "no-deleteing-hbr-ecs-backup-plan",
Status = "Running",
});
var example = new AliCloud.Hbr.EcsBackupPlan("example", new()
{
EcsBackupPlanName = "example_value",
InstanceId = defaultInstances.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Id),
VaultId = defaultVault.Id,
Retention = "1",
Schedule = "I|1602673264|PT2H",
BackupType = "COMPLETE",
SpeedLimit = "0:24:5120",
Paths = new[]
{
"/home",
"/var",
},
Exclude = @" [""/home/exclude""]
",
Include = @" [""/home/include""]
",
});
});
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ecs"
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
"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 := "valut-name"
if param := cfg.Get("name"); param != "" {
name = param
}
defaultVault, err := hbr.NewVault(ctx, "defaultVault", &hbr.VaultArgs{
VaultName: pulumi.String(name),
})
if err != nil {
return err
}
defaultInstances, err := ecs.GetInstances(ctx, &ecs.GetInstancesArgs{
NameRegex: pulumi.StringRef("no-deleteing-hbr-ecs-backup-plan"),
Status: pulumi.StringRef("Running"),
}, nil)
if err != nil {
return err
}
_, err = hbr.NewEcsBackupPlan(ctx, "example", &hbr.EcsBackupPlanArgs{
EcsBackupPlanName: pulumi.String("example_value"),
InstanceId: *pulumi.String(defaultInstances.Instances[0].Id),
VaultId: defaultVault.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
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.hbr.Vault;
import com.pulumi.alicloud.hbr.VaultArgs;
import com.pulumi.alicloud.ecs.EcsFunctions;
import com.pulumi.alicloud.ecs.inputs.GetInstancesArgs;
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 config = ctx.config();
final var name = config.get("name").orElse("valut-name");
var defaultVault = new Vault("defaultVault", VaultArgs.builder()
.vaultName(name)
.build());
final var defaultInstances = EcsFunctions.getInstances(GetInstancesArgs.builder()
.nameRegex("no-deleteing-hbr-ecs-backup-plan")
.status("Running")
.build());
var example = new EcsBackupPlan("example", EcsBackupPlanArgs.builder()
.ecsBackupPlanName("example_value")
.instanceId(defaultInstances.applyValue(getInstancesResult -> getInstancesResult.instances()[0].id()))
.vaultId(defaultVault.id())
.retention("1")
.schedule("I|1602673264|PT2H")
.backupType("COMPLETE")
.speedLimit("0:24:5120")
.paths(
"/home",
"/var")
.exclude("""
["/home/exclude"]
""")
.include("""
["/home/include"]
""")
.build());
}
}
import pulumi
import pulumi_alicloud as alicloud
config = pulumi.Config()
name = config.get("name")
if name is None:
name = "valut-name"
default_vault = alicloud.hbr.Vault("defaultVault", vault_name=name)
default_instances = alicloud.ecs.get_instances(name_regex="no-deleteing-hbr-ecs-backup-plan",
status="Running")
example = alicloud.hbr.EcsBackupPlan("example",
ecs_backup_plan_name="example_value",
instance_id=default_instances.instances[0].id,
vault_id=default_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")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const config = new pulumi.Config();
const name = config.get("name") || "valut-name";
const defaultVault = new alicloud.hbr.Vault("defaultVault", {vaultName: name});
const defaultInstances = alicloud.ecs.getInstances({
nameRegex: "no-deleteing-hbr-ecs-backup-plan",
status: "Running",
});
const example = new alicloud.hbr.EcsBackupPlan("example", {
ecsBackupPlanName: "example_value",
instanceId: defaultInstances.then(defaultInstances => defaultInstances.instances?.[0]?.id),
vaultId: defaultVault.id,
retention: "1",
schedule: "I|1602673264|PT2H",
backupType: "COMPLETE",
speedLimit: "0:24:5120",
paths: [
"/home",
"/var",
],
exclude: " [\"/home/exclude\"]\n",
include: " [\"/home/include\"]\n",
});
configuration:
name:
type: string
default: valut-name
resources:
defaultVault:
type: alicloud:hbr:Vault
properties:
vaultName: ${name}
example:
type: alicloud:hbr:EcsBackupPlan
properties:
ecsBackupPlanName: example_value
instanceId: ${defaultInstances.instances[0].id}
vaultId: ${defaultVault.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:
defaultInstances:
fn::invoke:
Function: alicloud:ecs:getInstances
Arguments:
nameRegex: no-deleteing-hbr-ecs-backup-plan
status: Running
Create EcsBackupPlan Resource
new EcsBackupPlan(name: string, args: EcsBackupPlanArgs, opts?: CustomResourceOptions);
@overload
def EcsBackupPlan(resource_name: 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)
@overload
def EcsBackupPlan(resource_name: str,
args: EcsBackupPlanArgs,
opts: Optional[ResourceOptions] = 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.
- 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.
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:
- Backup
Type string Backup type. Valid values:
COMPLETE
.- Ecs
Backup stringPlan Name 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 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.- Vault
Id string The ID of Backup vault.
- Cross
Account stringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- Cross
Account intUser Id 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 Ifpath
is empty, it means that all directories will be backed up.- Speed
Limit 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.- Update
Paths bool Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- Backup
Type string Backup type. Valid values:
COMPLETE
.- Ecs
Backup stringPlan Name 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 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.- Vault
Id string The ID of Backup vault.
- Cross
Account stringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- Cross
Account intUser Id 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 Ifpath
is empty, it means that all directories will be backed up.- Speed
Limit 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.- Update
Paths bool Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- backup
Type String Backup type. Valid values:
COMPLETE
.- ecs
Backup StringPlan Name 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 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.- vault
Id String The ID of Backup vault.
- cross
Account StringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross
Account IntegerUser Id 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 Ifpath
is empty, it means that all directories will be backed up.- speed
Limit 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.- update
Paths Boolean Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- backup
Type string Backup type. Valid values:
COMPLETE
.- ecs
Backup stringPlan Name 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 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.- vault
Id string The ID of Backup vault.
- cross
Account stringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account stringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross
Account numberUser Id 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 Ifpath
is empty, it means that all directories will be backed up.- speed
Limit 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.- update
Paths boolean Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
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_ strplan_ name 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.- vault_
id str The ID of Backup vault.
- cross_
account_ strrole_ name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross_
account_ strtype The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross_
account_ intuser_ id 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 Ifpath
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.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- backup
Type String Backup type. Valid values:
COMPLETE
.- ecs
Backup StringPlan Name 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 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.- vault
Id String The ID of Backup vault.
- cross
Account StringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross
Account NumberUser Id 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 Ifpath
is empty, it means that all directories will be backed up.- speed
Limit 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.- update
Paths Boolean Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
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.
- Backup
Type string Backup type. Valid values:
COMPLETE
.- Cross
Account stringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- Cross
Account intUser Id 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
.- Ecs
Backup stringPlan Name 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\"]"
- Instance
Id 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 Ifpath
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.- Speed
Limit 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.- Update
Paths bool Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- Vault
Id string The ID of Backup vault.
- Backup
Type string Backup type. Valid values:
COMPLETE
.- Cross
Account stringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- Cross
Account intUser Id 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
.- Ecs
Backup stringPlan Name 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\"]"
- Instance
Id 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 Ifpath
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.- Speed
Limit 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.- Update
Paths bool Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- Vault
Id string The ID of Backup vault.
- backup
Type String Backup type. Valid values:
COMPLETE
.- cross
Account StringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross
Account IntegerUser Id 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
.- ecs
Backup StringPlan Name 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\"]"
- instance
Id 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 Ifpath
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.- speed
Limit 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.- update
Paths Boolean Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- vault
Id String The ID of Backup vault.
- backup
Type string Backup type. Valid values:
COMPLETE
.- cross
Account stringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account stringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross
Account numberUser Id 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
.- ecs
Backup stringPlan Name 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\"]"
- instance
Id 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 Ifpath
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.- speed
Limit 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.- update
Paths boolean Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- vault
Id string The ID of Backup vault.
- backup_
type str Backup type. Valid values:
COMPLETE
.- cross_
account_ strrole_ name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross_
account_ strtype The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross_
account_ intuser_ id 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_ strplan_ name 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 Ifpath
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.- 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.
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.
- backup
Type String Backup type. Valid values:
COMPLETE
.- cross
Account StringRole Name The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
.- cross
Account NumberUser Id 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
.- ecs
Backup StringPlan Name 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\"]"
- instance
Id 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 Ifpath
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.- speed
Limit 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.- update
Paths Boolean Attribute update_paths has been deprecated in v1.139.0+, and you do not need to set it anymore.
Attribute update_paths has been deprecated in v1.139.0+ and you do not need to set it anymore.
- vault
Id 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>
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
alicloud
Terraform Provider.