Skip to content

DbPlanProps

Properties for defining a DbPlan.

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

Initializer 

import com.aliyun.ros.cdk.hbr.DbPlanProps;
DbPlanProps.builder()
    .dbPlanName(java.lang.String)
    .dbPlanName(IResolvable)
    .hostUuid(java.lang.String)
    .hostUuid(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
    .vaultId(java.lang.String)
    .vaultId(IResolvable)
//  .continuousPlan(java.lang.String)
//  .continuousPlan(IResolvable)
//  .cumulativePlan(java.lang.String)
//  .cumulativePlan(IResolvable)
//  .fullPlan(java.lang.String)
//  .fullPlan(IResolvable)
//  .incPlan(java.lang.String)
//  .incPlan(IResolvable)
//  .instanceUuid(java.lang.String)
//  .instanceUuid(IResolvable)
//  .logPlan(java.lang.String)
//  .logPlan(IResolvable)
//  .maxRateLimit(java.lang.Number)
//  .maxRateLimit(IResolvable)
//  .maxRetrySeconds(java.lang.Number)
//  .maxRetrySeconds(IResolvable)
//  .options(java.lang.String)
//  .options(IResolvable)
//  .source(IResolvable)
//  .source(SourceProperty)
    .build();

Properties

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

dbPlanNameRequired 

public java.lang.Object getDbPlanName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbPlanName: Display name of the backup plan.

hostUuidRequired 

public java.lang.Object getHostUuid();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

sourceTypeRequired 

public java.lang.Object getSourceType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

vaultIdRequired 

public java.lang.Object getVaultId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

continuousPlanOptional 

public java.lang.Object getContinuousPlan();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property continuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

cumulativePlanOptional 

public java.lang.Object getCumulativePlan();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

fullPlanOptional 

public java.lang.Object getFullPlan();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getIncPlan();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property incPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

instanceUuidOptional 

public java.lang.Object getInstanceUuid();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceUuid: Uuid of database instance.

logPlanOptional 

public java.lang.Object getLogPlan();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

maxRateLimitOptional 

public java.lang.Object getMaxRateLimit();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxRateLimit: Max rate limit for backup job,.

maxRetrySecondsOptional 

public java.lang.Object getMaxRetrySeconds();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxRetrySeconds: Max retry seconds on network failure.

optionsOptional 

public java.lang.Object getOptions();
  • Type: java.lang.String OR com.aliyun.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 java.lang.Object getSource();

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