1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. hbr
  5. NasBackupPlan
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

alicloud.hbr.NasBackupPlan

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.57.0 published on Saturday, Jun 15, 2024 by Pulumi

    Provides a HBR Nas Backup Plan resource.

    For information about HBR Nas Backup Plan and how to use it, see What is Nas 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 _default = new random.index.Integer("default", {
        min: 10000,
        max: 99999,
    });
    const defaultVault = new alicloud.hbr.Vault("default", {vaultName: `terraform-example-${_default.result}`});
    const defaultFileSystem = new alicloud.nas.FileSystem("default", {
        protocolType: "NFS",
        storageType: "Performance",
        description: "terraform-example",
        encryptType: 1,
    });
    const defaultNasBackupPlan = new alicloud.hbr.NasBackupPlan("default", {
        nasBackupPlanName: "terraform-example",
        fileSystemId: defaultFileSystem.id,
        schedule: "I|1602673264|PT2H",
        backupType: "COMPLETE",
        vaultId: defaultVault.id,
        retention: "2",
        paths: ["/"],
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    import pulumi_random as random
    
    default = random.index.Integer("default",
        min=10000,
        max=99999)
    default_vault = alicloud.hbr.Vault("default", vault_name=f"terraform-example-{default['result']}")
    default_file_system = alicloud.nas.FileSystem("default",
        protocol_type="NFS",
        storage_type="Performance",
        description="terraform-example",
        encrypt_type=1)
    default_nas_backup_plan = alicloud.hbr.NasBackupPlan("default",
        nas_backup_plan_name="terraform-example",
        file_system_id=default_file_system.id,
        schedule="I|1602673264|PT2H",
        backup_type="COMPLETE",
        vault_id=default_vault.id,
        retention="2",
        paths=["/"])
    
    package main
    
    import (
    	"fmt"
    
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/nas"
    	"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 {
    		_, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
    			Min: 10000,
    			Max: 99999,
    		})
    		if err != nil {
    			return err
    		}
    		defaultVault, err := hbr.NewVault(ctx, "default", &hbr.VaultArgs{
    			VaultName: pulumi.String(fmt.Sprintf("terraform-example-%v", _default.Result)),
    		})
    		if err != nil {
    			return err
    		}
    		defaultFileSystem, err := nas.NewFileSystem(ctx, "default", &nas.FileSystemArgs{
    			ProtocolType: pulumi.String("NFS"),
    			StorageType:  pulumi.String("Performance"),
    			Description:  pulumi.String("terraform-example"),
    			EncryptType:  pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		_, err = hbr.NewNasBackupPlan(ctx, "default", &hbr.NasBackupPlanArgs{
    			NasBackupPlanName: pulumi.String("terraform-example"),
    			FileSystemId:      defaultFileSystem.ID(),
    			Schedule:          pulumi.String("I|1602673264|PT2H"),
    			BackupType:        pulumi.String("COMPLETE"),
    			VaultId:           defaultVault.ID(),
    			Retention:         pulumi.String("2"),
    			Paths: pulumi.StringArray{
    				pulumi.String("/"),
    			},
    		})
    		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 @default = new Random.Index.Integer("default", new()
        {
            Min = 10000,
            Max = 99999,
        });
    
        var defaultVault = new AliCloud.Hbr.Vault("default", new()
        {
            VaultName = $"terraform-example-{@default.Result}",
        });
    
        var defaultFileSystem = new AliCloud.Nas.FileSystem("default", new()
        {
            ProtocolType = "NFS",
            StorageType = "Performance",
            Description = "terraform-example",
            EncryptType = 1,
        });
    
        var defaultNasBackupPlan = new AliCloud.Hbr.NasBackupPlan("default", new()
        {
            NasBackupPlanName = "terraform-example",
            FileSystemId = defaultFileSystem.Id,
            Schedule = "I|1602673264|PT2H",
            BackupType = "COMPLETE",
            VaultId = defaultVault.Id,
            Retention = "2",
            Paths = new[]
            {
                "/",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    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.nas.FileSystem;
    import com.pulumi.alicloud.nas.FileSystemArgs;
    import com.pulumi.alicloud.hbr.NasBackupPlan;
    import com.pulumi.alicloud.hbr.NasBackupPlanArgs;
    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) {
            var default_ = new Integer("default", IntegerArgs.builder()
                .min(10000)
                .max(99999)
                .build());
    
            var defaultVault = new Vault("defaultVault", VaultArgs.builder()
                .vaultName(String.format("terraform-example-%s", default_.result()))
                .build());
    
            var defaultFileSystem = new FileSystem("defaultFileSystem", FileSystemArgs.builder()
                .protocolType("NFS")
                .storageType("Performance")
                .description("terraform-example")
                .encryptType("1")
                .build());
    
            var defaultNasBackupPlan = new NasBackupPlan("defaultNasBackupPlan", NasBackupPlanArgs.builder()
                .nasBackupPlanName("terraform-example")
                .fileSystemId(defaultFileSystem.id())
                .schedule("I|1602673264|PT2H")
                .backupType("COMPLETE")
                .vaultId(defaultVault.id())
                .retention("2")
                .paths("/")
                .build());
    
        }
    }
    
    resources:
      default:
        type: random:integer
        properties:
          min: 10000
          max: 99999
      defaultVault:
        type: alicloud:hbr:Vault
        name: default
        properties:
          vaultName: terraform-example-${default.result}
      defaultFileSystem:
        type: alicloud:nas:FileSystem
        name: default
        properties:
          protocolType: NFS
          storageType: Performance
          description: terraform-example
          encryptType: '1'
      defaultNasBackupPlan:
        type: alicloud:hbr:NasBackupPlan
        name: default
        properties:
          nasBackupPlanName: terraform-example
          fileSystemId: ${defaultFileSystem.id}
          schedule: I|1602673264|PT2H
          backupType: COMPLETE
          vaultId: ${defaultVault.id}
          retention: '2'
          paths:
            - /
    

    Create NasBackupPlan Resource

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

    Constructor syntax

    new NasBackupPlan(name: string, args: NasBackupPlanArgs, opts?: CustomResourceOptions);
    @overload
    def NasBackupPlan(resource_name: str,
                      args: NasBackupPlanArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def NasBackupPlan(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      paths: Optional[Sequence[str]] = None,
                      file_system_id: Optional[str] = None,
                      nas_backup_plan_name: Optional[str] = None,
                      backup_type: Optional[str] = None,
                      retention: Optional[str] = None,
                      schedule: Optional[str] = None,
                      vault_id: Optional[str] = None,
                      create_time: Optional[str] = None,
                      cross_account_role_name: Optional[str] = None,
                      cross_account_type: Optional[str] = None,
                      cross_account_user_id: Optional[int] = None,
                      disabled: Optional[bool] = None,
                      options: Optional[str] = None)
    func NewNasBackupPlan(ctx *Context, name string, args NasBackupPlanArgs, opts ...ResourceOption) (*NasBackupPlan, error)
    public NasBackupPlan(string name, NasBackupPlanArgs args, CustomResourceOptions? opts = null)
    public NasBackupPlan(String name, NasBackupPlanArgs args)
    public NasBackupPlan(String name, NasBackupPlanArgs args, CustomResourceOptions options)
    
    type: alicloud:hbr:NasBackupPlan
    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 NasBackupPlanArgs
    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 NasBackupPlanArgs
    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 NasBackupPlanArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NasBackupPlanArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NasBackupPlanArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var nasBackupPlanResource = new AliCloud.Hbr.NasBackupPlan("nasBackupPlanResource", new()
    {
        Paths = new[]
        {
            "string",
        },
        FileSystemId = "string",
        NasBackupPlanName = "string",
        BackupType = "string",
        Retention = "string",
        Schedule = "string",
        VaultId = "string",
        CrossAccountRoleName = "string",
        CrossAccountType = "string",
        CrossAccountUserId = 0,
        Disabled = false,
        Options = "string",
    });
    
    example, err := hbr.NewNasBackupPlan(ctx, "nasBackupPlanResource", &hbr.NasBackupPlanArgs{
    	Paths: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	FileSystemId:         pulumi.String("string"),
    	NasBackupPlanName:    pulumi.String("string"),
    	BackupType:           pulumi.String("string"),
    	Retention:            pulumi.String("string"),
    	Schedule:             pulumi.String("string"),
    	VaultId:              pulumi.String("string"),
    	CrossAccountRoleName: pulumi.String("string"),
    	CrossAccountType:     pulumi.String("string"),
    	CrossAccountUserId:   pulumi.Int(0),
    	Disabled:             pulumi.Bool(false),
    	Options:              pulumi.String("string"),
    })
    
    var nasBackupPlanResource = new NasBackupPlan("nasBackupPlanResource", NasBackupPlanArgs.builder()
        .paths("string")
        .fileSystemId("string")
        .nasBackupPlanName("string")
        .backupType("string")
        .retention("string")
        .schedule("string")
        .vaultId("string")
        .crossAccountRoleName("string")
        .crossAccountType("string")
        .crossAccountUserId(0)
        .disabled(false)
        .options("string")
        .build());
    
    nas_backup_plan_resource = alicloud.hbr.NasBackupPlan("nasBackupPlanResource",
        paths=["string"],
        file_system_id="string",
        nas_backup_plan_name="string",
        backup_type="string",
        retention="string",
        schedule="string",
        vault_id="string",
        cross_account_role_name="string",
        cross_account_type="string",
        cross_account_user_id=0,
        disabled=False,
        options="string")
    
    const nasBackupPlanResource = new alicloud.hbr.NasBackupPlan("nasBackupPlanResource", {
        paths: ["string"],
        fileSystemId: "string",
        nasBackupPlanName: "string",
        backupType: "string",
        retention: "string",
        schedule: "string",
        vaultId: "string",
        crossAccountRoleName: "string",
        crossAccountType: "string",
        crossAccountUserId: 0,
        disabled: false,
        options: "string",
    });
    
    type: alicloud:hbr:NasBackupPlan
    properties:
        backupType: string
        crossAccountRoleName: string
        crossAccountType: string
        crossAccountUserId: 0
        disabled: false
        fileSystemId: string
        nasBackupPlanName: string
        options: string
        paths:
            - string
        retention: string
        schedule: string
        vaultId: string
    

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

    BackupType string
    Backup type. Valid values: COMPLETE.
    FileSystemId string
    The File System ID of Nas.
    NasBackupPlanName 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.
    Paths List<string>
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    CreateTime string
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    CrossAccountRoleName string

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    Options string
    This parameter specifies whether to use Windows VSS to define a backup path.
    BackupType string
    Backup type. Valid values: COMPLETE.
    FileSystemId string
    The File System ID of Nas.
    NasBackupPlanName 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.
    Paths []string
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    CreateTime string
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    CrossAccountRoleName string

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    Options string
    This parameter specifies whether to use Windows VSS to define a backup path.
    backupType String
    Backup type. Valid values: COMPLETE.
    fileSystemId String
    The File System ID of Nas.
    nasBackupPlanName 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.
    paths List<String>
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    createTime String
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    crossAccountRoleName String

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    options String
    This parameter specifies whether to use Windows VSS to define a backup path.
    backupType string
    Backup type. Valid values: COMPLETE.
    fileSystemId string
    The File System ID of Nas.
    nasBackupPlanName 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.
    paths string[]
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    createTime string
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    crossAccountRoleName string

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    options string
    This parameter specifies whether to use Windows VSS to define a backup path.
    backup_type str
    Backup type. Valid values: COMPLETE.
    file_system_id str
    The File System ID of Nas.
    nas_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.
    paths Sequence[str]
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    create_time str
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    cross_account_role_name str

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    options str
    This parameter specifies whether to use Windows VSS to define a backup path.
    backupType String
    Backup type. Valid values: COMPLETE.
    fileSystemId String
    The File System ID of Nas.
    nasBackupPlanName 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.
    paths List<String>
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    createTime String
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    crossAccountRoleName String

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    options String
    This parameter specifies whether to use Windows VSS to define a backup path.

    Outputs

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

    Get an existing NasBackupPlan 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?: NasBackupPlanState, opts?: CustomResourceOptions): NasBackupPlan
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            backup_type: Optional[str] = None,
            create_time: Optional[str] = None,
            cross_account_role_name: Optional[str] = None,
            cross_account_type: Optional[str] = None,
            cross_account_user_id: Optional[int] = None,
            disabled: Optional[bool] = None,
            file_system_id: Optional[str] = None,
            nas_backup_plan_name: Optional[str] = None,
            options: Optional[str] = None,
            paths: Optional[Sequence[str]] = None,
            retention: Optional[str] = None,
            schedule: Optional[str] = None,
            vault_id: Optional[str] = None) -> NasBackupPlan
    func GetNasBackupPlan(ctx *Context, name string, id IDInput, state *NasBackupPlanState, opts ...ResourceOption) (*NasBackupPlan, error)
    public static NasBackupPlan Get(string name, Input<string> id, NasBackupPlanState? state, CustomResourceOptions? opts = null)
    public static NasBackupPlan get(String name, Output<String> id, NasBackupPlanState 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.
    CreateTime string
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    CrossAccountRoleName string

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    FileSystemId string
    The File System ID of Nas.
    NasBackupPlanName 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.
    Options string
    This parameter specifies whether to use Windows VSS to define a backup path.
    Paths List<string>
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    BackupType string
    Backup type. Valid values: COMPLETE.
    CreateTime string
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    CrossAccountRoleName string

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    FileSystemId string
    The File System ID of Nas.
    NasBackupPlanName 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.
    Options string
    This parameter specifies whether to use Windows VSS to define a backup path.
    Paths []string
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    backupType String
    Backup type. Valid values: COMPLETE.
    createTime String
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    crossAccountRoleName String

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    fileSystemId String
    The File System ID of Nas.
    nasBackupPlanName 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.
    options String
    This parameter specifies whether to use Windows VSS to define a backup path.
    paths List<String>
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    backupType string
    Backup type. Valid values: COMPLETE.
    createTime string
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    crossAccountRoleName string

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    fileSystemId string
    The File System ID of Nas.
    nasBackupPlanName 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.
    options string
    This parameter specifies whether to use Windows VSS to define a backup path.
    paths string[]
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    backup_type str
    Backup type. Valid values: COMPLETE.
    create_time str
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    cross_account_role_name str

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    file_system_id str
    The File System ID of Nas.
    nas_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.
    options str
    This parameter specifies whether to use Windows VSS to define a backup path.
    paths Sequence[str]
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.
    backupType String
    Backup type. Valid values: COMPLETE.
    createTime String
    This field has been deprecated from provider version 1.153.0+. The creation time of NAS file system. Note The time format of the API adopts the ISO 8601, such as 2021-07-09T15:45:30CST or 2021-07-09T07:45:30Z.

    Deprecated: Field 'create_time' has been deprecated from provider version 1.153.0.

    crossAccountRoleName String

    The role name created in the original account RAM backup by the cross account managed by the current account.

    Note alicloud.hbr.NasBackupPlan depends on the alicloud.nas.FileSystem and creates a mount point on the file system. If this dependency has not declared, the file system may not be deleted correctly.

    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.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    fileSystemId String
    The File System ID of Nas.
    nasBackupPlanName 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.
    options String
    This parameter specifies whether to use Windows VSS to define a backup path.
    paths List<String>
    List of backup path. Up to 65536 characters. e.g.["/home", "/var"]. Note You should at least specify a backup path, empty array not allowed here.
    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.

    Import

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

    $ pulumi import alicloud:hbr/nasBackupPlan:NasBackupPlan 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.0 published on Saturday, Jun 15, 2024 by Pulumi