DbPlan

• Implements: IDbPlan

This class encapsulates and extends the ROS resource type ALIYUN::HBR::DbPlanCreates a database backup plan.

Initializers

import { DbPlan } from '@alicloud/ros-cdk-hbr'
new DbPlan(scope: Construct, id: string, props: DbPlanProps, enableResourcePropertyConstraint?: boolean)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: DbPlanProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrContinuousPlan^Required

public readonly attrContinuousPlan: string | IResolvable;

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

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

attrContinuousUuid^Required

public readonly attrContinuousUuid: string | IResolvable;

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

Attribute ContinuousUuid: Uuid of continuous backup plan.

attrCumulativePlan^Required

public readonly attrCumulativePlan: string | IResolvable;

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

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

attrCumulativeUuid^Required

public readonly attrCumulativeUuid: string | IResolvable;

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

Attribute CumulativeUuid: Uuid of cumulative plan.

attrDbPlanName^Required

public readonly attrDbPlanName: string | IResolvable;

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

Attribute DbPlanName: Display name of the backup plan.

attrFullPlan^Required

public readonly attrFullPlan: string | IResolvable;

• Type: string | @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.

attrFullUuid^Required

public readonly attrFullUuid: string | IResolvable;

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

Attribute FullUuid: Uuid of full backup plan.

attrHostUuid^Required

public readonly attrHostUuid: string | IResolvable;

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

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

attrIncPlan^Required

public readonly attrIncPlan: string | IResolvable;

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

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

attrIncUuid^Required

public readonly attrIncUuid: string | IResolvable;

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

Attribute IncUuid: Uuid of the incremental bakcup plan.

attrInstanceUuid^Required

public readonly attrInstanceUuid: string | IResolvable;

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

Attribute InstanceUuid: Uuid of database instance.

attrLogPlan^Required

public readonly attrLogPlan: string | IResolvable;

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

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

attrLogUuid^Required

public readonly attrLogUuid: string | IResolvable;

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

Attribute LogUuid: Uuid of the log backup plan.

attrMaxRateLimit^Required

public readonly attrMaxRateLimit: string | IResolvable;

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

Attribute MaxRateLimit: Max rate limit for backup job,.

attrMaxRetrySeconds^Required

public readonly attrMaxRetrySeconds: string | IResolvable;

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

Attribute MaxRetrySeconds: Max retry seconds on network failure.

attrOptions^Required

public readonly attrOptions: string | IResolvable;

• Type: string | @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}.

attrPlanId^Required

public readonly attrPlanId: string | IResolvable;

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

Attribute PlanId: Id of the backup plan.

attrSourceType^Required

public readonly attrSourceType: string | IResolvable;

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

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

attrTarget^Required

public readonly attrTarget: string | IResolvable;

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

Attribute Target: Target vault to backup.

attrVaultId^Required

public readonly attrVaultId: string | IResolvable;

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

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

props^Required

public readonly props: DbPlanProps;

• Type: DbPlanProps