DbPlan

This class encapsulates and extends the ROS resource type ALIYUN::HBR::DbPlan, which is used to create a backup plan.

Initializers

import ros_cdk_hbr
ros_cdk_hbr.DbPlan(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No 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.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`db_plan_name`^Required

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

Property dbPlanName: Display name of the backup plan.

`host_uuid`^Required

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

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

`source_type`^Required

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

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

`vault_id`^Required

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_plan`^Optional

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

Property continuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

`cumulative_plan`^Optional

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

Property cumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

`full_plan`^Optional

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_plan`^Optional

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

Property incPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

`instance_uuid`^Optional

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

Property instanceUuid: Uuid of database instance.

`log_plan`^Optional

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

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

`max_rate_limit`^Optional

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

Property maxRateLimit: Max rate limit for backup job,.

`max_retry_seconds`^Optional

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

Property maxRetrySeconds: Max retry seconds on network failure.

`options`^Optional

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}.

`source`^Optional

Type: typing.Union[ros_cdk_core.IResolvable, SourceProperty]

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

`enable_resource_property_constraint`^Optional

Type: bool

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`add_condition`	No description.
`add_count`	No description.
`add_dependency`	No description.
`add_resource_desc`	No description.
`apply_removal_policy`	No description.
`get_att`	No description.
`set_metadata`	No description.

`to_string`

def to_string() -> str

Returns a string representation of this construct.

`synthesize`

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

Type: ros_cdk_core.ISynthesisSession

The synthesis session.

`add_condition`

def add_condition(
  condition: RosCondition
) -> None

condition^Required

Type: ros_cdk_core.RosCondition

`add_count`

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

`add_dependency`

def add_dependency(
  resource: Resource
) -> None

resource^Required

Type: ros_cdk_core.Resource

`add_resource_desc`

def add_resource_desc(
  desc: str
) -> None

desc^Required

Type: str

`apply_removal_policy`

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

Type: ros_cdk_core.RemovalPolicy

`get_att`

def get_att(
  name: str
) -> IResolvable

name^Required

Type: str

`set_metadata`

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

Type: str

value^Required

Type: typing.Any

Static Functions

Name	Description
`is_construct`	Return whether the given object is a Construct.

`is_construct`

import ros_cdk_hbr
ros_cdk_hbr.DbPlan.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

Type: typing.Any

Properties

Name	Type	Description
`node`	`ros_cdk_core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`str`	No description.
`stack`	`ros_cdk_core.Stack`	The stack in which this resource is defined.
`resource`	`ros_cdk_core.RosResource`	No description.
`attr_continuous_plan`	`ros_cdk_core.IResolvable`	Attribute ContinuousPlan: Continuous backup plan schedule.
`attr_continuous_uuid`	`ros_cdk_core.IResolvable`	Attribute ContinuousUuid: Uuid of continuous backup plan.
`attr_cumulative_plan`	`ros_cdk_core.IResolvable`	Attribute CumulativePlan: Cumulative plan schedule, only for mssql.
`attr_cumulative_uuid`	`ros_cdk_core.IResolvable`	Attribute CumulativeUuid: Uuid of cumulative plan.
`attr_db_plan_name`	`ros_cdk_core.IResolvable`	Attribute DbPlanName: Display name of the backup plan.
`attr_full_plan`	`ros_cdk_core.IResolvable`	Attribute FullPlan: Full backup plan schedule.
`attr_full_uuid`	`ros_cdk_core.IResolvable`	Attribute FullUuid: Uuid of full backup plan.
`attr_host_uuid`	`ros_cdk_core.IResolvable`	Attribute HostUuid: Uuid of the host of the database instance.
`attr_inc_plan`	`ros_cdk_core.IResolvable`	Attribute IncPlan: Incremental backup plan schedule.
`attr_inc_uuid`	`ros_cdk_core.IResolvable`	Attribute IncUuid: Uuid of the incremental bakcup plan.
`attr_instance_uuid`	`ros_cdk_core.IResolvable`	Attribute InstanceUuid: Uuid of database instance.
`attr_log_plan`	`ros_cdk_core.IResolvable`	Attribute LogPlan: Log backup plan schedule.More details see FullPlan.
`attr_log_uuid`	`ros_cdk_core.IResolvable`	Attribute LogUuid: Uuid of the log backup plan.
`attr_max_rate_limit`	`ros_cdk_core.IResolvable`	Attribute MaxRateLimit: Max rate limit for backup job,.
`attr_max_retry_seconds`	`ros_cdk_core.IResolvable`	Attribute MaxRetrySeconds: Max retry seconds on network failure.
`attr_options`	`ros_cdk_core.IResolvable`	Attribute Options: Backup options in json format, different for each type of database.
`attr_plan_id`	`ros_cdk_core.IResolvable`	Attribute PlanId: Id of the backup plan.
`attr_source_type`	`ros_cdk_core.IResolvable`	Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
`attr_target`	`ros_cdk_core.IResolvable`	Attribute Target: Target vault to backup.
`attr_vault_id`	`ros_cdk_core.IResolvable`	Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault.

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

ref: str

Type: str

`stack`^Required

stack: Stack

Type: ros_cdk_core.Stack

The stack in which this resource is defined.

`resource`^Optional

resource: RosResource

Type: ros_cdk_core.RosResource

`attr_continuous_plan`^Required

attr_continuous_plan: IResolvable

Type: ros_cdk_core.IResolvable

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

`attr_continuous_uuid`^Required

attr_continuous_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute ContinuousUuid: Uuid of continuous backup plan.

`attr_cumulative_plan`^Required

attr_cumulative_plan: IResolvable

Type: ros_cdk_core.IResolvable

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

`attr_cumulative_uuid`^Required

attr_cumulative_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute CumulativeUuid: Uuid of cumulative plan.

`attr_db_plan_name`^Required

attr_db_plan_name: IResolvable

Type: ros_cdk_core.IResolvable

Attribute DbPlanName: Display name of the backup plan.

`attr_full_plan`^Required

attr_full_plan: IResolvable

Type: ros_cdk_core.IResolvable

Attribute 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.

`attr_full_uuid`^Required

attr_full_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute FullUuid: Uuid of full backup plan.

`attr_host_uuid`^Required

attr_host_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute HostUuid: Uuid of the host of the database instance.

`attr_inc_plan`^Required

attr_inc_plan: IResolvable

Type: ros_cdk_core.IResolvable

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

`attr_inc_uuid`^Required

attr_inc_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute IncUuid: Uuid of the incremental bakcup plan.

`attr_instance_uuid`^Required

attr_instance_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute InstanceUuid: Uuid of database instance.

`attr_log_plan`^Required

attr_log_plan: IResolvable

Type: ros_cdk_core.IResolvable

Attribute LogPlan: Log backup plan schedule.More details see FullPlan.

`attr_log_uuid`^Required

attr_log_uuid: IResolvable

Type: ros_cdk_core.IResolvable

Attribute LogUuid: Uuid of the log backup plan.

`attr_max_rate_limit`^Required

attr_max_rate_limit: IResolvable

Type: ros_cdk_core.IResolvable

Attribute MaxRateLimit: Max rate limit for backup job,.

`attr_max_retry_seconds`^Required

attr_max_retry_seconds: IResolvable

Type: ros_cdk_core.IResolvable

Attribute MaxRetrySeconds: Max retry seconds on network failure.

`attr_options`^Required

attr_options: IResolvable

Type: ros_cdk_core.IResolvable

Attribute 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}.

`attr_plan_id`^Required

attr_plan_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute PlanId: Id of the backup plan.

`attr_source_type`^Required

attr_source_type: IResolvable

Type: ros_cdk_core.IResolvable

Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.

`attr_target`^Required

attr_target: IResolvable

Type: ros_cdk_core.IResolvable

Attribute Target: Target vault to backup.

`attr_vault_id`^Required

attr_vault_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault.

DbPlan

Initializers

scopeRequired

idRequired

db_plan_nameRequired

host_uuidRequired

source_typeRequired

vault_idRequired

continuous_planOptional

cumulative_planOptional

full_planOptional

inc_planOptional

instance_uuidOptional

log_planOptional

max_rate_limitOptional

max_retry_secondsOptional

optionsOptional

sourceOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata

Static Functions

is_construct

Properties

nodeRequired

refRequired

stackRequired

resourceOptional

attr_continuous_planRequired

attr_continuous_uuidRequired

attr_cumulative_planRequired

attr_cumulative_uuidRequired

attr_db_plan_nameRequired

attr_full_planRequired

attr_full_uuidRequired

attr_host_uuidRequired

attr_inc_planRequired

attr_inc_uuidRequired

attr_instance_uuidRequired

attr_log_planRequired

attr_log_uuidRequired

attr_max_rate_limitRequired

attr_max_retry_secondsRequired

attr_optionsRequired

attr_plan_idRequired

attr_source_typeRequired

attr_targetRequired

attr_vault_idRequired