Skip to content

DbPlanProps

Properties for defining a DbPlan.

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

Initializer 

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

Properties

Name Type Description
dbPlanName string | @alicloud/ros-cdk-core.IResolvable Property dbPlanName: Display name of the backup plan.
hostUuid string | @alicloud/ros-cdk-core.IResolvable Property hostUuid: Uuid of the host of the database instance.
sourceType string | @alicloud/ros-cdk-core.IResolvable Property sourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
vaultId string | @alicloud/ros-cdk-core.IResolvable Property vaultId: Vault ID to create backup plan, the backup data will be stored to the vault.
continuousPlan string | @alicloud/ros-cdk-core.IResolvable Property continuousPlan: Continuous backup plan schedule.
cumulativePlan string | @alicloud/ros-cdk-core.IResolvable Property cumulativePlan: Cumulative plan schedule, only for mssql.
fullPlan string | @alicloud/ros-cdk-core.IResolvable Property fullPlan: Full backup plan schedule.
incPlan string | @alicloud/ros-cdk-core.IResolvable Property incPlan: Incremental backup plan schedule.
instanceUuid string | @alicloud/ros-cdk-core.IResolvable Property instanceUuid: Uuid of database instance.
logPlan string | @alicloud/ros-cdk-core.IResolvable Property logPlan: Log backup plan schedule.More details see FullPlan.
maxRateLimit number | @alicloud/ros-cdk-core.IResolvable Property maxRateLimit: Max rate limit for backup job,.
maxRetrySeconds number | @alicloud/ros-cdk-core.IResolvable Property maxRetrySeconds: Max retry seconds on network failure.
options string | @alicloud/ros-cdk-core.IResolvable Property options: Backup options in json format, different for each type of database.
source @alicloud/ros-cdk-core.IResolvable | SourceProperty Property source: Which database instance or database will be backup.

dbPlanNameRequired 

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

Property dbPlanName: Display name of the backup plan.

hostUuidRequired 

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

Property hostUuid: Uuid of the host of the database instance.

sourceTypeRequired 

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

Property sourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.

vaultIdRequired 

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

Property vaultId: Vault ID to create backup plan, the backup data will be stored to the vault.

continuousPlanOptional 

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

Property continuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

cumulativePlanOptional 

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

Property cumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

fullPlanOptional 

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

Property fullPlan: Full backup plan schedule.

daily: {"type": "daily", "start": "00:00:00", "interval": 3}, weekly {"type":"weekly","start": "03:00:00","days": [1,2,3,4,5],"interval": 1}, days can be 0 - 6, 0 means Sunday, and interval can be 1 - 52.

incPlanOptional 

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

Property incPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

instanceUuidOptional 

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

Property instanceUuid: Uuid of database instance.

logPlanOptional 

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

Property logPlan: Log backup plan schedule.More details see FullPlan.

maxRateLimitOptional 

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

Property maxRateLimit: Max rate limit for backup job,.

maxRetrySecondsOptional 

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

Property maxRetrySeconds: Max retry seconds on network failure.

optionsOptional 

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

Property options: Backup options in json format, different for each type of database.

For Oracle, use {"channels":4,"compression":"lzop","offline_backup":false,"archivelog_reserve_hours":24,"custom_commands":""}, "channels" means numbers of concurrent theads, "archivelog_reserve_hours" means how long before the archive log will be deleted after backup job completed, other paramters should use the default vaule. For Mysql, use {"channels":4,"compression":"lzop","del_binlog":false}, "del_binlog" means whether the binlog will be deleted after backup completed, only take effect for log or continuous backup. For SQL Server, use {\"channels\":4,\"verify\":false,\"compression\":\"lzop\",\"backup_new_databases\":false}.

sourceOptional 

public readonly source: IResolvable | SourceProperty;

Property source: Which database instance or database will be backup.