DbPlan

• Implements: IDbPlan

This class encapsulates and extends the ROS resource type ALIYUN::HBR::DbPlan.

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
)

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

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

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

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

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

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

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

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

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

attr_continuous_uuid^Required

attr_continuous_uuid: typing.Union[str, IResolvable]

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

Attribute ContinuousUuid: Uuid of continuous backup plan.

attr_cumulative_plan^Required

attr_cumulative_plan: typing.Union[str, IResolvable]

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

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

attr_cumulative_uuid^Required

attr_cumulative_uuid: typing.Union[str, IResolvable]

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

Attribute CumulativeUuid: Uuid of cumulative plan.

attr_db_plan_name^Required

attr_db_plan_name: typing.Union[str, IResolvable]

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

Attribute DbPlanName: Display name of the backup plan.

attr_full_plan^Required

attr_full_plan: typing.Union[str, IResolvable]

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

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

Attribute FullUuid: Uuid of full backup plan.

attr_host_uuid^Required

attr_host_uuid: typing.Union[str, IResolvable]

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

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

attr_inc_plan^Required

attr_inc_plan: typing.Union[str, IResolvable]

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

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

Attribute IncUuid: Uuid of the incremental bakcup plan.

attr_instance_uuid^Required

attr_instance_uuid: typing.Union[str, IResolvable]

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

Attribute InstanceUuid: Uuid of database instance.

attr_log_plan^Required

attr_log_plan: typing.Union[str, IResolvable]

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

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

attr_log_uuid^Required

attr_log_uuid: typing.Union[str, IResolvable]

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

Attribute LogUuid: Uuid of the log backup plan.

attr_max_rate_limit^Required

attr_max_rate_limit: typing.Union[str, IResolvable]

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

Attribute MaxRateLimit: Max rate limit for backup job,.

attr_max_retry_seconds^Required

attr_max_retry_seconds: typing.Union[str, IResolvable]

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

Attribute MaxRetrySeconds: Max retry seconds on network failure.

attr_options^Required

attr_options: typing.Union[str, IResolvable]

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

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

Attribute PlanId: Id of the backup plan.

attr_source_type^Required

attr_source_type: typing.Union[str, IResolvable]

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

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

attr_target^Required

attr_target: typing.Union[str, IResolvable]

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

Attribute Target: Target vault to backup.

attr_vault_id^Required

attr_vault_id: typing.Union[str, IResolvable]

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

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

props^Required

props: DbPlanProps

• Type: DbPlanProps