Skip to content

IDbPlan

  • Extends: ros_cdk_core.IResource

  • Implemented By: DbPlan, IDbPlan

Represents a DbPlan.

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node for this construct.
env ros_cdk_core.IResourceEnvironment The environment this resource belongs to.
stack ros_cdk_core.Stack The stack in which this resource is defined.
attr_continuous_plan typing.Union[str, ros_cdk_core.IResolvable] Attribute ContinuousPlan: Continuous backup plan schedule.
attr_continuous_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute ContinuousUuid: Uuid of continuous backup plan.
attr_cumulative_plan typing.Union[str, ros_cdk_core.IResolvable] Attribute CumulativePlan: Cumulative plan schedule, only for mssql.
attr_cumulative_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute CumulativeUuid: Uuid of cumulative plan.
attr_db_plan_name typing.Union[str, ros_cdk_core.IResolvable] Attribute DbPlanName: Display name of the backup plan.
attr_full_plan typing.Union[str, ros_cdk_core.IResolvable] Attribute FullPlan: Full backup plan schedule.
attr_full_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute FullUuid: Uuid of full backup plan.
attr_host_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute HostUuid: Uuid of the host of the database instance.
attr_inc_plan typing.Union[str, ros_cdk_core.IResolvable] Attribute IncPlan: Incremental backup plan schedule.
attr_inc_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute IncUuid: Uuid of the incremental bakcup plan.
attr_instance_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute InstanceUuid: Uuid of database instance.
attr_log_plan typing.Union[str, ros_cdk_core.IResolvable] Attribute LogPlan: Log backup plan schedule.More details see FullPlan.
attr_log_uuid typing.Union[str, ros_cdk_core.IResolvable] Attribute LogUuid: Uuid of the log backup plan.
attr_max_rate_limit typing.Union[str, ros_cdk_core.IResolvable] Attribute MaxRateLimit: Max rate limit for backup job,.
attr_max_retry_seconds typing.Union[str, ros_cdk_core.IResolvable] Attribute MaxRetrySeconds: Max retry seconds on network failure.
attr_options typing.Union[str, ros_cdk_core.IResolvable] Attribute Options: Backup options in json format, different for each type of database.
attr_plan_id typing.Union[str, ros_cdk_core.IResolvable] Attribute PlanId: Id of the backup plan.
attr_source_type typing.Union[str, ros_cdk_core.IResolvable] Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
attr_target typing.Union[str, ros_cdk_core.IResolvable] Attribute Target: Target vault to backup.
attr_vault_id 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 DbPlanProps No description.

nodeRequired

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node for this construct.


envRequired

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.


stackRequired

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.


attr_continuous_planRequired

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_uuidRequired

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

Attribute ContinuousUuid: Uuid of continuous backup plan.


attr_cumulative_planRequired

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_uuidRequired

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

Attribute CumulativeUuid: Uuid of cumulative plan.


attr_db_plan_nameRequired

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_planRequired

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_uuidRequired

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

Attribute FullUuid: Uuid of full backup plan.


attr_host_uuidRequired

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_planRequired

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_uuidRequired

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_uuidRequired

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

Attribute InstanceUuid: Uuid of database instance.


attr_log_planRequired

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_uuidRequired

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_limitRequired

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_secondsRequired

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_optionsRequired

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_idRequired

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

Attribute PlanId: Id of the backup plan.


attr_source_typeRequired

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_targetRequired

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

Attribute Target: Target vault to backup.


attr_vault_idRequired

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.


propsRequired

props: DbPlanProps