Skip to content

DbPlanProps

Properties for defining a DbPlan.

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

Initializer 

import ros_cdk_hbr
ros_cdk_hbr.DbPlanProps(
  db_plan_name: typing.Union[str, IResolvable],
  host_uuid: typing.Union[str, IResolvable],
  source_type: typing.Union[str, IResolvable],
  vault_id: typing.Union[str, IResolvable],
  continuous_plan: typing.Union[str, IResolvable] = None,
  cumulative_plan: typing.Union[str, IResolvable] = None,
  full_plan: typing.Union[str, IResolvable] = None,
  inc_plan: typing.Union[str, IResolvable] = None,
  instance_uuid: typing.Union[str, IResolvable] = None,
  log_plan: typing.Union[str, IResolvable] = None,
  max_rate_limit: typing.Union[typing.Union[int, float], IResolvable] = None,
  max_retry_seconds: typing.Union[typing.Union[int, float], IResolvable] = None,
  options: typing.Union[str, IResolvable] = None,
  source: typing.Union[IResolvable, SourceProperty] = None
)

Properties

Name Type Description
db_plan_name typing.Union[str, ros_cdk_core.IResolvable] Property dbPlanName: Display name of the backup plan.
host_uuid typing.Union[str, ros_cdk_core.IResolvable] Property hostUuid: Uuid of the host of the database instance.
source_type typing.Union[str, ros_cdk_core.IResolvable] Property sourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
vault_id typing.Union[str, ros_cdk_core.IResolvable] Property vaultId: Vault ID to create backup plan, the backup data will be stored to the vault.
continuous_plan typing.Union[str, ros_cdk_core.IResolvable] Property continuousPlan: Continuous backup plan schedule.
cumulative_plan typing.Union[str, ros_cdk_core.IResolvable] Property cumulativePlan: Cumulative plan schedule, only for mssql.
full_plan typing.Union[str, ros_cdk_core.IResolvable] Property fullPlan: Full backup plan schedule.
inc_plan typing.Union[str, ros_cdk_core.IResolvable] Property incPlan: Incremental backup plan schedule.
instance_uuid typing.Union[str, ros_cdk_core.IResolvable] Property instanceUuid: Uuid of database instance.
log_plan typing.Union[str, ros_cdk_core.IResolvable] Property logPlan: Log backup plan schedule.More details see FullPlan.
max_rate_limit typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxRateLimit: Max rate limit for backup job,.
max_retry_seconds typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property maxRetrySeconds: Max retry seconds on network failure.
options typing.Union[str, ros_cdk_core.IResolvable] Property options: Backup options in json format, different for each type of database.
source typing.Union[ros_cdk_core.IResolvable, SourceProperty] Property source: Which database instance or database will be backup.

db_plan_nameRequired 

db_plan_name: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property dbPlanName: Display name of the backup plan.

host_uuidRequired 

host_uuid: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

source_typeRequired 

source_type: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

vault_idRequired 

vault_id: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

continuous_planOptional 

continuous_plan: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property continuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

cumulative_planOptional 

cumulative_plan: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property cumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

full_planOptional 

full_plan: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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.

inc_planOptional 

inc_plan: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property incPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

instance_uuidOptional 

instance_uuid: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property instanceUuid: Uuid of database instance.

log_planOptional 

log_plan: typing.Union[str, IResolvable]
  • Type: typing.Union[str, ros_cdk_core.IResolvable]

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

max_rate_limitOptional 

max_rate_limit: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property maxRateLimit: Max rate limit for backup job,.

max_retry_secondsOptional 

max_retry_seconds: typing.Union[typing.Union[int, float], IResolvable]
  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property maxRetrySeconds: Max retry seconds on network failure.

optionsOptional 

options: typing.Union[str, IResolvable]
  • Type: typing.Union[str, 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 

source: typing.Union[IResolvable, SourceProperty]

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