Skip to content

NasBackupPlanProps

Properties for defining a NasBackupPlan.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-hbr-nasbackupplan

Initializer

import { NasBackupPlanProps } from '@alicloud/ros-cdk-hbr'
const nasBackupPlanProps: NasBackupPlanProps = { ... }

Properties

Name Type Description
backupType string | @alicloud/ros-cdk-core.IResolvable Property backupType: Backup type.
fileSystemId string | @alicloud/ros-cdk-core.IResolvable Property fileSystemId: The ID of the file system.
paths @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[] Property paths: The paths of the backup plan.
planName string | @alicloud/ros-cdk-core.IResolvable Property planName: The name of the backup plan.
retention number | @alicloud/ros-cdk-core.IResolvable Property retention: Backup retention days, the minimum is 1.
schedule string | @alicloud/ros-cdk-core.IResolvable Property schedule: The backup policy.
vaultId string | @alicloud/ros-cdk-core.IResolvable Property vaultId: The ID of backup vault.
crossAccountRoleName string | @alicloud/ros-cdk-core.IResolvable Property crossAccountRoleName: The role name created in the original account RAM backup by the cross account managed by the current account.
crossAccountType string | @alicloud/ros-cdk-core.IResolvable Property crossAccountType: The type of the cross account backup.
crossAccountUserId string | @alicloud/ros-cdk-core.IResolvable Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.
disabled boolean | @alicloud/ros-cdk-core.IResolvable Property disabled: Whether to disable the backup task.
options @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any} Property options: This parameter specifies whether to use Windows VSS to define a backup path.

backupTypeRequired

public readonly backupType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupType: Backup type.

Valid values: COMPLETE.


fileSystemIdRequired

public readonly fileSystemId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property fileSystemId: The ID of the file system.


pathsRequired

public readonly paths: IResolvable | string | IResolvable[];
  • Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property paths: The paths of the backup plan.


planNameRequired

public readonly planName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property planName: 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.


retentionRequired

public readonly retention: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property retention: Backup retention days, the minimum is 1.


scheduleRequired

public readonly schedule: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property schedule: The backup policy.

The format is I|{startTime}|{interval}. This specifies that a backup job runs at an interval of {interval}, starting from {startTime}. Overdue backup jobs are not retried. If the previous backup job is not complete, the next backup job is not triggered. For example, I|1631685600|P1D indicates that a backup job runs daily starting from 14:00:00 on September 15, 2021. - startTime: The start time for the backup, specified as a UNIX timestamp in seconds. - interval: The backup interval, specified in the ISO 8601 duration format. For example, PT1H represents one hour and P1D represents one day.


vaultIdRequired

public readonly vaultId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property vaultId: The ID of backup vault.


crossAccountRoleNameOptional

public readonly crossAccountRoleName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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


crossAccountTypeOptional

public readonly crossAccountType: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property crossAccountType: The type of the cross account backup.

Valid values: SELF_ACCOUNT, CROSS_ACCOUNT.


crossAccountUserIdOptional

public readonly crossAccountUserId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property crossAccountUserId: The original account ID of the cross account backup managed by the current account.


disabledOptional

public readonly disabled: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property disabled: Whether to disable the backup task.

Valid values: true, false.


optionsOptional

public readonly options: IResolvable | {[ key: string ]: any};
  • Type: @alicloud/ros-cdk-core.IResolvable | {[ key: string ]: any}

Property options: This parameter specifies whether to use Windows VSS to define a backup path.