1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. hbr
  5. getServerBackupPlans
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi

alicloud.hbr.getServerBackupPlans

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.53.0 published on Wednesday, Apr 17, 2024 by Pulumi

    This data source provides the Hbr Server Backup Plans of the current Alibaba Cloud user.

    NOTE: Available in v1.142.0+.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const default = alicloud.ecs.getInstances({
        nameRegex: "no-deleteing-hbr-ecs-server-backup-plan",
        status: "Running",
    });
    const ids = _default.then(_default => alicloud.hbr.getServerBackupPlans({
        filters: [{
            key: "instanceId",
            values: [_default.instances?.[0]?.id],
        }],
    }));
    export const hbrServerBackupPlanId1 = ids.then(ids => ids.plans?.[0]?.id);
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    default = alicloud.ecs.get_instances(name_regex="no-deleteing-hbr-ecs-server-backup-plan",
        status="Running")
    ids = alicloud.hbr.get_server_backup_plans(filters=[alicloud.hbr.GetServerBackupPlansFilterArgs(
        key="instanceId",
        values=[default.instances[0].id],
    )])
    pulumi.export("hbrServerBackupPlanId1", ids.plans[0].id)
    
    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"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _default, err := ecs.GetInstances(ctx, &ecs.GetInstancesArgs{
    NameRegex: pulumi.StringRef("no-deleteing-hbr-ecs-server-backup-plan"),
    Status: pulumi.StringRef("Running"),
    }, nil);
    if err != nil {
    return err
    }
    ids, err := hbr.GetServerBackupPlans(ctx, &hbr.GetServerBackupPlansArgs{
    Filters: []hbr.GetServerBackupPlansFilter{
    {
    Key: pulumi.StringRef("instanceId"),
    Values: interface{}{
    _default.Instances[0].Id,
    },
    },
    },
    }, nil);
    if err != nil {
    return err
    }
    ctx.Export("hbrServerBackupPlanId1", ids.Plans[0].Id)
    return nil
    })
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = AliCloud.Ecs.GetInstances.Invoke(new()
        {
            NameRegex = "no-deleteing-hbr-ecs-server-backup-plan",
            Status = "Running",
        });
    
        var ids = AliCloud.Hbr.GetServerBackupPlans.Invoke(new()
        {
            Filters = new[]
            {
                new AliCloud.Hbr.Inputs.GetServerBackupPlansFilterInputArgs
                {
                    Key = "instanceId",
                    Values = new[]
                    {
                        @default.Apply(getInstancesResult => getInstancesResult.Instances[0]?.Id),
                    },
                },
            },
        });
    
        return new Dictionary<string, object?>
        {
            ["hbrServerBackupPlanId1"] = ids.Apply(getServerBackupPlansResult => getServerBackupPlansResult.Plans[0]?.Id),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.ecs.EcsFunctions;
    import com.pulumi.alicloud.ecs.inputs.GetInstancesArgs;
    import com.pulumi.alicloud.hbr.HbrFunctions;
    import com.pulumi.alicloud.hbr.inputs.GetServerBackupPlansArgs;
    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 default = EcsFunctions.getInstances(GetInstancesArgs.builder()
                .nameRegex("no-deleteing-hbr-ecs-server-backup-plan")
                .status("Running")
                .build());
    
            final var ids = HbrFunctions.getServerBackupPlans(GetServerBackupPlansArgs.builder()
                .filters(GetServerBackupPlansFilterArgs.builder()
                    .key("instanceId")
                    .values(default_.instances()[0].id())
                    .build())
                .build());
    
            ctx.export("hbrServerBackupPlanId1", ids.applyValue(getServerBackupPlansResult -> getServerBackupPlansResult.plans()[0].id()));
        }
    }
    
    variables:
      default:
        fn::invoke:
          Function: alicloud:ecs:getInstances
          Arguments:
            nameRegex: no-deleteing-hbr-ecs-server-backup-plan
            status: Running
      ids:
        fn::invoke:
          Function: alicloud:hbr:getServerBackupPlans
          Arguments:
            filters:
              - key: instanceId
                values:
                  - ${default.instances[0].id}
    outputs:
      hbrServerBackupPlanId1: ${ids.plans[0].id}
    

    Using getServerBackupPlans

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServerBackupPlans(args: GetServerBackupPlansArgs, opts?: InvokeOptions): Promise<GetServerBackupPlansResult>
    function getServerBackupPlansOutput(args: GetServerBackupPlansOutputArgs, opts?: InvokeOptions): Output<GetServerBackupPlansResult>
    def get_server_backup_plans(filters: Optional[Sequence[GetServerBackupPlansFilter]] = None,
                                ids: Optional[Sequence[str]] = None,
                                output_file: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetServerBackupPlansResult
    def get_server_backup_plans_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetServerBackupPlansFilterArgs]]]] = None,
                                ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                output_file: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetServerBackupPlansResult]
    func GetServerBackupPlans(ctx *Context, args *GetServerBackupPlansArgs, opts ...InvokeOption) (*GetServerBackupPlansResult, error)
    func GetServerBackupPlansOutput(ctx *Context, args *GetServerBackupPlansOutputArgs, opts ...InvokeOption) GetServerBackupPlansResultOutput

    > Note: This function is named GetServerBackupPlans in the Go SDK.

    public static class GetServerBackupPlans 
    {
        public static Task<GetServerBackupPlansResult> InvokeAsync(GetServerBackupPlansArgs args, InvokeOptions? opts = null)
        public static Output<GetServerBackupPlansResult> Invoke(GetServerBackupPlansInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetServerBackupPlansResult> getServerBackupPlans(GetServerBackupPlansArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:hbr/getServerBackupPlans:getServerBackupPlans
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filters List<Pulumi.AliCloud.Hbr.Inputs.GetServerBackupPlansFilter>
    The filters.
    Ids List<string>
    A list of Server Backup Plan IDs.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    Filters []GetServerBackupPlansFilter
    The filters.
    Ids []string
    A list of Server Backup Plan IDs.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    filters List<GetServerBackupPlansFilter>
    The filters.
    ids List<String>
    A list of Server Backup Plan IDs.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    filters GetServerBackupPlansFilter[]
    The filters.
    ids string[]
    A list of Server Backup Plan IDs.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    filters Sequence[GetServerBackupPlansFilter]
    The filters.
    ids Sequence[str]
    A list of Server Backup Plan IDs.
    output_file str
    File name where to save data source results (after running pulumi preview).
    filters List<Property Map>
    The filters.
    ids List<String>
    A list of Server Backup Plan IDs.
    outputFile String
    File name where to save data source results (after running pulumi preview).

    getServerBackupPlans Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    Plans []GetServerBackupPlansPlan
    Filters []GetServerBackupPlansFilter
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    plans List<GetServerBackupPlansPlan>
    filters List<GetServerBackupPlansFilter>
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    plans GetServerBackupPlansPlan[]
    filters GetServerBackupPlansFilter[]
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    plans Sequence[GetServerBackupPlansPlan]
    filters Sequence[GetServerBackupPlansFilter]
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    plans List<Property Map>
    filters List<Property Map>
    outputFile String

    Supporting Types

    GetServerBackupPlansFilter

    Key string
    The key of the field to filter. Valid values: planId, instanceId, planName.
    Values List<string>
    Set of values that are accepted for the given field.
    Key string
    The key of the field to filter. Valid values: planId, instanceId, planName.
    Values []string
    Set of values that are accepted for the given field.
    key String
    The key of the field to filter. Valid values: planId, instanceId, planName.
    values List<String>
    Set of values that are accepted for the given field.
    key string
    The key of the field to filter. Valid values: planId, instanceId, planName.
    values string[]
    Set of values that are accepted for the given field.
    key str
    The key of the field to filter. Valid values: planId, instanceId, planName.
    values Sequence[str]
    Set of values that are accepted for the given field.
    key String
    The key of the field to filter. Valid values: planId, instanceId, planName.
    values List<String>
    Set of values that are accepted for the given field.

    GetServerBackupPlansPlan

    CreateTime string
    The creation time of backup plan.
    Details List<Pulumi.AliCloud.Hbr.Inputs.GetServerBackupPlansPlanDetail>
    ECS server backup plan details.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    EcsServerBackupPlanId string
    The ID of the server backup plan.
    EcsServerBackupPlanName 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.
    Id string
    The ID of the server backup plan.
    InstanceId string
    The ID of ECS Instance.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy.
    CreateTime string
    The creation time of backup plan.
    Details []GetServerBackupPlansPlanDetail
    ECS server backup plan details.
    Disabled bool
    Whether to disable the backup task. Valid values: true, false.
    EcsServerBackupPlanId string
    The ID of the server backup plan.
    EcsServerBackupPlanName 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.
    Id string
    The ID of the server backup plan.
    InstanceId string
    The ID of ECS Instance.
    Retention string
    Backup retention days, the minimum is 1.
    Schedule string
    Backup strategy.
    createTime String
    The creation time of backup plan.
    details List<GetServerBackupPlansPlanDetail>
    ECS server backup plan details.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    ecsServerBackupPlanId String
    The ID of the server backup plan.
    ecsServerBackupPlanName 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.
    id String
    The ID of the server backup plan.
    instanceId String
    The ID of ECS Instance.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy.
    createTime string
    The creation time of backup plan.
    details GetServerBackupPlansPlanDetail[]
    ECS server backup plan details.
    disabled boolean
    Whether to disable the backup task. Valid values: true, false.
    ecsServerBackupPlanId string
    The ID of the server backup plan.
    ecsServerBackupPlanName 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.
    id string
    The ID of the server backup plan.
    instanceId string
    The ID of ECS Instance.
    retention string
    Backup retention days, the minimum is 1.
    schedule string
    Backup strategy.
    create_time str
    The creation time of backup plan.
    details Sequence[GetServerBackupPlansPlanDetail]
    ECS server backup plan details.
    disabled bool
    Whether to disable the backup task. Valid values: true, false.
    ecs_server_backup_plan_id str
    The ID of the server backup plan.
    ecs_server_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.
    id str
    The ID of the server backup plan.
    instance_id str
    The ID of ECS Instance.
    retention str
    Backup retention days, the minimum is 1.
    schedule str
    Backup strategy.
    createTime String
    The creation time of backup plan.
    details List<Property Map>
    ECS server backup plan details.
    disabled Boolean
    Whether to disable the backup task. Valid values: true, false.
    ecsServerBackupPlanId String
    The ID of the server backup plan.
    ecsServerBackupPlanName 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.
    id String
    The ID of the server backup plan.
    instanceId String
    The ID of ECS Instance.
    retention String
    Backup retention days, the minimum is 1.
    schedule String
    Backup strategy.

    GetServerBackupPlansPlanDetail

    AppConsistent bool
    Whether to turn on application consistency. The application consistency snapshot backs up memory data and ongoing database transactions at the time of snapshot creation to ensure the consistency of application system data and database transactions. By applying consistent snapshots, there is no data damage or loss, so as to avoid log rollback during database startup and ensure that the application is in a consistent startup state. Valid values: true, false.
    DestinationRegionId string
    Only vaild when DoCopy is true. The destination region ID when replicating to another region. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    DestinationRetention int
    Only vaild when DoCopy is true. The retention days of the destination backup. When not specified, the destination backup will be saved permanently. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    DiskIdLists List<string>
    The list of cloud disks to be backed up in the ECS instance. When not specified, a snapshot is executed for all the disks on the ECS instance.
    DoCopy bool
    Whether replicate to another region. Valid values: true, false.
    EnableFsFreeze bool
    Only the Linux system is valid. Whether to use the Linux FsFreeze mechanism to ensure that the file system is read-only consistent before creating a storage snapshot. The default is True. Valid values: true, false.
    PostScriptPath string
    Only vaild for the linux system when AppConsistent is true. The application thaw script path (e.g. /tmp/postscript.sh). The postscript.sh script must meet the following conditions: in terms of permissions, only the root user as the owner has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    PreScriptPath string
    Only vaild for the linux system when AppConsistent is true. Apply the freeze script path (e.g. /tmp/prescript.sh). prescript.sh scripts must meet the following conditions: in terms of permissions, only root, as the owner, has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    SnapshotGroup bool
    Whether to turn on file system consistency. If SnapshotGroup is true, when AppConsistent is true but the relevant conditions are not met or AppConsistent is false, the resulting snapshot will be a file system consistency snapshot. The file system consistency ensures that the file system memory and disk information are synchronized at the time of snapshot creation, and the file system write operation is frozen to make the file system in a consistent state. The file system consistency snapshot can prevent the operating system from performing disk inspection and repair operations such as CHKDSK or fsck after restart. Valid values: true, false.
    TimeoutInSeconds int
    Only the Linux system is valid, and the IO freeze timeout period. The default is 30 seconds.
    AppConsistent bool
    Whether to turn on application consistency. The application consistency snapshot backs up memory data and ongoing database transactions at the time of snapshot creation to ensure the consistency of application system data and database transactions. By applying consistent snapshots, there is no data damage or loss, so as to avoid log rollback during database startup and ensure that the application is in a consistent startup state. Valid values: true, false.
    DestinationRegionId string
    Only vaild when DoCopy is true. The destination region ID when replicating to another region. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    DestinationRetention int
    Only vaild when DoCopy is true. The retention days of the destination backup. When not specified, the destination backup will be saved permanently. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    DiskIdLists []string
    The list of cloud disks to be backed up in the ECS instance. When not specified, a snapshot is executed for all the disks on the ECS instance.
    DoCopy bool
    Whether replicate to another region. Valid values: true, false.
    EnableFsFreeze bool
    Only the Linux system is valid. Whether to use the Linux FsFreeze mechanism to ensure that the file system is read-only consistent before creating a storage snapshot. The default is True. Valid values: true, false.
    PostScriptPath string
    Only vaild for the linux system when AppConsistent is true. The application thaw script path (e.g. /tmp/postscript.sh). The postscript.sh script must meet the following conditions: in terms of permissions, only the root user as the owner has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    PreScriptPath string
    Only vaild for the linux system when AppConsistent is true. Apply the freeze script path (e.g. /tmp/prescript.sh). prescript.sh scripts must meet the following conditions: in terms of permissions, only root, as the owner, has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    SnapshotGroup bool
    Whether to turn on file system consistency. If SnapshotGroup is true, when AppConsistent is true but the relevant conditions are not met or AppConsistent is false, the resulting snapshot will be a file system consistency snapshot. The file system consistency ensures that the file system memory and disk information are synchronized at the time of snapshot creation, and the file system write operation is frozen to make the file system in a consistent state. The file system consistency snapshot can prevent the operating system from performing disk inspection and repair operations such as CHKDSK or fsck after restart. Valid values: true, false.
    TimeoutInSeconds int
    Only the Linux system is valid, and the IO freeze timeout period. The default is 30 seconds.
    appConsistent Boolean
    Whether to turn on application consistency. The application consistency snapshot backs up memory data and ongoing database transactions at the time of snapshot creation to ensure the consistency of application system data and database transactions. By applying consistent snapshots, there is no data damage or loss, so as to avoid log rollback during database startup and ensure that the application is in a consistent startup state. Valid values: true, false.
    destinationRegionId String
    Only vaild when DoCopy is true. The destination region ID when replicating to another region. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    destinationRetention Integer
    Only vaild when DoCopy is true. The retention days of the destination backup. When not specified, the destination backup will be saved permanently. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    diskIdLists List<String>
    The list of cloud disks to be backed up in the ECS instance. When not specified, a snapshot is executed for all the disks on the ECS instance.
    doCopy Boolean
    Whether replicate to another region. Valid values: true, false.
    enableFsFreeze Boolean
    Only the Linux system is valid. Whether to use the Linux FsFreeze mechanism to ensure that the file system is read-only consistent before creating a storage snapshot. The default is True. Valid values: true, false.
    postScriptPath String
    Only vaild for the linux system when AppConsistent is true. The application thaw script path (e.g. /tmp/postscript.sh). The postscript.sh script must meet the following conditions: in terms of permissions, only the root user as the owner has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    preScriptPath String
    Only vaild for the linux system when AppConsistent is true. Apply the freeze script path (e.g. /tmp/prescript.sh). prescript.sh scripts must meet the following conditions: in terms of permissions, only root, as the owner, has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    snapshotGroup Boolean
    Whether to turn on file system consistency. If SnapshotGroup is true, when AppConsistent is true but the relevant conditions are not met or AppConsistent is false, the resulting snapshot will be a file system consistency snapshot. The file system consistency ensures that the file system memory and disk information are synchronized at the time of snapshot creation, and the file system write operation is frozen to make the file system in a consistent state. The file system consistency snapshot can prevent the operating system from performing disk inspection and repair operations such as CHKDSK or fsck after restart. Valid values: true, false.
    timeoutInSeconds Integer
    Only the Linux system is valid, and the IO freeze timeout period. The default is 30 seconds.
    appConsistent boolean
    Whether to turn on application consistency. The application consistency snapshot backs up memory data and ongoing database transactions at the time of snapshot creation to ensure the consistency of application system data and database transactions. By applying consistent snapshots, there is no data damage or loss, so as to avoid log rollback during database startup and ensure that the application is in a consistent startup state. Valid values: true, false.
    destinationRegionId string
    Only vaild when DoCopy is true. The destination region ID when replicating to another region. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    destinationRetention number
    Only vaild when DoCopy is true. The retention days of the destination backup. When not specified, the destination backup will be saved permanently. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    diskIdLists string[]
    The list of cloud disks to be backed up in the ECS instance. When not specified, a snapshot is executed for all the disks on the ECS instance.
    doCopy boolean
    Whether replicate to another region. Valid values: true, false.
    enableFsFreeze boolean
    Only the Linux system is valid. Whether to use the Linux FsFreeze mechanism to ensure that the file system is read-only consistent before creating a storage snapshot. The default is True. Valid values: true, false.
    postScriptPath string
    Only vaild for the linux system when AppConsistent is true. The application thaw script path (e.g. /tmp/postscript.sh). The postscript.sh script must meet the following conditions: in terms of permissions, only the root user as the owner has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    preScriptPath string
    Only vaild for the linux system when AppConsistent is true. Apply the freeze script path (e.g. /tmp/prescript.sh). prescript.sh scripts must meet the following conditions: in terms of permissions, only root, as the owner, has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    snapshotGroup boolean
    Whether to turn on file system consistency. If SnapshotGroup is true, when AppConsistent is true but the relevant conditions are not met or AppConsistent is false, the resulting snapshot will be a file system consistency snapshot. The file system consistency ensures that the file system memory and disk information are synchronized at the time of snapshot creation, and the file system write operation is frozen to make the file system in a consistent state. The file system consistency snapshot can prevent the operating system from performing disk inspection and repair operations such as CHKDSK or fsck after restart. Valid values: true, false.
    timeoutInSeconds number
    Only the Linux system is valid, and the IO freeze timeout period. The default is 30 seconds.
    app_consistent bool
    Whether to turn on application consistency. The application consistency snapshot backs up memory data and ongoing database transactions at the time of snapshot creation to ensure the consistency of application system data and database transactions. By applying consistent snapshots, there is no data damage or loss, so as to avoid log rollback during database startup and ensure that the application is in a consistent startup state. Valid values: true, false.
    destination_region_id str
    Only vaild when DoCopy is true. The destination region ID when replicating to another region. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    destination_retention int
    Only vaild when DoCopy is true. The retention days of the destination backup. When not specified, the destination backup will be saved permanently. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    disk_id_lists Sequence[str]
    The list of cloud disks to be backed up in the ECS instance. When not specified, a snapshot is executed for all the disks on the ECS instance.
    do_copy bool
    Whether replicate to another region. Valid values: true, false.
    enable_fs_freeze bool
    Only the Linux system is valid. Whether to use the Linux FsFreeze mechanism to ensure that the file system is read-only consistent before creating a storage snapshot. The default is True. Valid values: true, false.
    post_script_path str
    Only vaild for the linux system when AppConsistent is true. The application thaw script path (e.g. /tmp/postscript.sh). The postscript.sh script must meet the following conditions: in terms of permissions, only the root user as the owner has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    pre_script_path str
    Only vaild for the linux system when AppConsistent is true. Apply the freeze script path (e.g. /tmp/prescript.sh). prescript.sh scripts must meet the following conditions: in terms of permissions, only root, as the owner, has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    snapshot_group bool
    Whether to turn on file system consistency. If SnapshotGroup is true, when AppConsistent is true but the relevant conditions are not met or AppConsistent is false, the resulting snapshot will be a file system consistency snapshot. The file system consistency ensures that the file system memory and disk information are synchronized at the time of snapshot creation, and the file system write operation is frozen to make the file system in a consistent state. The file system consistency snapshot can prevent the operating system from performing disk inspection and repair operations such as CHKDSK or fsck after restart. Valid values: true, false.
    timeout_in_seconds int
    Only the Linux system is valid, and the IO freeze timeout period. The default is 30 seconds.
    appConsistent Boolean
    Whether to turn on application consistency. The application consistency snapshot backs up memory data and ongoing database transactions at the time of snapshot creation to ensure the consistency of application system data and database transactions. By applying consistent snapshots, there is no data damage or loss, so as to avoid log rollback during database startup and ensure that the application is in a consistent startup state. Valid values: true, false.
    destinationRegionId String
    Only vaild when DoCopy is true. The destination region ID when replicating to another region. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    destinationRetention Number
    Only vaild when DoCopy is true. The retention days of the destination backup. When not specified, the destination backup will be saved permanently. Note: Once you set a value of this property, you cannot set it to an empty string anymore.
    diskIdLists List<String>
    The list of cloud disks to be backed up in the ECS instance. When not specified, a snapshot is executed for all the disks on the ECS instance.
    doCopy Boolean
    Whether replicate to another region. Valid values: true, false.
    enableFsFreeze Boolean
    Only the Linux system is valid. Whether to use the Linux FsFreeze mechanism to ensure that the file system is read-only consistent before creating a storage snapshot. The default is True. Valid values: true, false.
    postScriptPath String
    Only vaild for the linux system when AppConsistent is true. The application thaw script path (e.g. /tmp/postscript.sh). The postscript.sh script must meet the following conditions: in terms of permissions, only the root user as the owner has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    preScriptPath String
    Only vaild for the linux system when AppConsistent is true. Apply the freeze script path (e.g. /tmp/prescript.sh). prescript.sh scripts must meet the following conditions: in terms of permissions, only root, as the owner, has read, write, and execute permissions, that is, 700 permissions. In terms of content, the script content needs to be customized according to the application itself. This indicates that this parameter must be set when creating an application consistency snapshot for a Linux instance. If the script is set incorrectly (for example, permissions, save path, or file name are set incorrectly), the resulting snapshot is a file system consistency snapshot.
    snapshotGroup Boolean
    Whether to turn on file system consistency. If SnapshotGroup is true, when AppConsistent is true but the relevant conditions are not met or AppConsistent is false, the resulting snapshot will be a file system consistency snapshot. The file system consistency ensures that the file system memory and disk information are synchronized at the time of snapshot creation, and the file system write operation is frozen to make the file system in a consistent state. The file system consistency snapshot can prevent the operating system from performing disk inspection and repair operations such as CHKDSK or fsck after restart. Valid values: true, false.
    timeoutInSeconds Number
    Only the Linux system is valid, and the IO freeze timeout period. The default is 30 seconds.

    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.53.0 published on Wednesday, Apr 17, 2024 by Pulumi