Skip to content

DbPlan

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

Initializers 

import { DbPlan } from '@alicloud/ros-cdk-hbr'
new DbPlan(scope: Construct, id: string, props: DbPlanProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props DbPlanProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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.

sessionRequired

  • Type: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct 

import { DbPlan } from '@alicloud/ros-cdk-hbr'
DbPlan.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrContinuousPlan @alicloud/ros-cdk-core.IResolvable Attribute ContinuousPlan: Continuous backup plan schedule.
attrContinuousUuid @alicloud/ros-cdk-core.IResolvable Attribute ContinuousUuid: Uuid of continuous backup plan.
attrCumulativePlan @alicloud/ros-cdk-core.IResolvable Attribute CumulativePlan: Cumulative plan schedule, only for mssql.
attrCumulativeUuid @alicloud/ros-cdk-core.IResolvable Attribute CumulativeUuid: Uuid of cumulative plan.
attrDbPlanName @alicloud/ros-cdk-core.IResolvable Attribute DbPlanName: Display name of the backup plan.
attrFullPlan @alicloud/ros-cdk-core.IResolvable Attribute FullPlan: Full backup plan schedule.
attrFullUuid @alicloud/ros-cdk-core.IResolvable Attribute FullUuid: Uuid of full backup plan.
attrHostUuid @alicloud/ros-cdk-core.IResolvable Attribute HostUuid: Uuid of the host of the database instance.
attrIncPlan @alicloud/ros-cdk-core.IResolvable Attribute IncPlan: Incremental backup plan schedule.
attrIncUuid @alicloud/ros-cdk-core.IResolvable Attribute IncUuid: Uuid of the incremental bakcup plan.
attrInstanceUuid @alicloud/ros-cdk-core.IResolvable Attribute InstanceUuid: Uuid of database instance.
attrLogPlan @alicloud/ros-cdk-core.IResolvable Attribute LogPlan: Log backup plan schedule.More details see FullPlan.
attrLogUuid @alicloud/ros-cdk-core.IResolvable Attribute LogUuid: Uuid of the log backup plan.
attrMaxRateLimit @alicloud/ros-cdk-core.IResolvable Attribute MaxRateLimit: Max rate limit for backup job,.
attrMaxRetrySeconds @alicloud/ros-cdk-core.IResolvable Attribute MaxRetrySeconds: Max retry seconds on network failure.
attrOptions @alicloud/ros-cdk-core.IResolvable Attribute Options: Backup options in json format, different for each type of database.
attrPlanId @alicloud/ros-cdk-core.IResolvable Attribute PlanId: Id of the backup plan.
attrSourceType @alicloud/ros-cdk-core.IResolvable Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
attrTarget @alicloud/ros-cdk-core.IResolvable Attribute Target: Target vault to backup.
attrVaultId @alicloud/ros-cdk-core.IResolvable Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrContinuousPlanRequired 

public readonly attrContinuousPlan: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

attrContinuousUuidRequired 

public readonly attrContinuousUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ContinuousUuid: Uuid of continuous backup plan.

attrCumulativePlanRequired 

public readonly attrCumulativePlan: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

attrCumulativeUuidRequired 

public readonly attrCumulativeUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CumulativeUuid: Uuid of cumulative plan.

attrDbPlanNameRequired 

public readonly attrDbPlanName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DbPlanName: Display name of the backup plan.

attrFullPlanRequired 

public readonly attrFullPlan: IResolvable;
  • Type: @alicloud/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.

attrFullUuidRequired 

public readonly attrFullUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute FullUuid: Uuid of full backup plan.

attrHostUuidRequired 

public readonly attrHostUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrIncPlanRequired 

public readonly attrIncPlan: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

attrIncUuidRequired 

public readonly attrIncUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IncUuid: Uuid of the incremental bakcup plan.

attrInstanceUuidRequired 

public readonly attrInstanceUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceUuid: Uuid of database instance.

attrLogPlanRequired 

public readonly attrLogPlan: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrLogUuidRequired 

public readonly attrLogUuid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute LogUuid: Uuid of the log backup plan.

attrMaxRateLimitRequired 

public readonly attrMaxRateLimit: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MaxRateLimit: Max rate limit for backup job,.

attrMaxRetrySecondsRequired 

public readonly attrMaxRetrySeconds: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute MaxRetrySeconds: Max retry seconds on network failure.

attrOptionsRequired 

public readonly attrOptions: IResolvable;
  • Type: @alicloud/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}.

attrPlanIdRequired 

public readonly attrPlanId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PlanId: Id of the backup plan.

attrSourceTypeRequired 

public readonly attrSourceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrTargetRequired 

public readonly attrTarget: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Target: Target vault to backup.

attrVaultIdRequired 

public readonly attrVaultId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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