DbPlan

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

Initializers

import com.aliyun.ros.cdk.hbr.DbPlan;
DbPlan.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .dbPlanName(java.lang.String)
    .dbPlanName(IResolvable)
    .hostUuid(java.lang.String)
    .hostUuid(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
    .vaultId(java.lang.String)
    .vaultId(IResolvable)
//  .continuousPlan(java.lang.String)
//  .continuousPlan(IResolvable)
//  .cumulativePlan(java.lang.String)
//  .cumulativePlan(IResolvable)
//  .fullPlan(java.lang.String)
//  .fullPlan(IResolvable)
//  .incPlan(java.lang.String)
//  .incPlan(IResolvable)
//  .instanceUuid(java.lang.String)
//  .instanceUuid(IResolvable)
//  .logPlan(java.lang.String)
//  .logPlan(IResolvable)
//  .maxRateLimit(java.lang.Number)
//  .maxRateLimit(IResolvable)
//  .maxRetrySeconds(java.lang.Number)
//  .maxRetrySeconds(IResolvable)
//  .options(java.lang.String)
//  .options(IResolvable)
//  .source(IResolvable)
//  .source(SourceProperty)
    .build();

Name	Type	Description
scope	com.aliyun.ros.cdk.core.Construct	No description.
id	java.lang.String	No description.
enableResourcePropertyConstraint	java.lang.Boolean	No description.
dbPlanName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property dbPlanName: Display name of the backup plan.
hostUuid	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property hostUuid: Uuid of the host of the database instance.
sourceType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property sourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
vaultId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property vaultId: Vault ID to create backup plan, the backup data will be stored to the vault.
continuousPlan	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property continuousPlan: Continuous backup plan schedule.
cumulativePlan	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property cumulativePlan: Cumulative plan schedule, only for mssql.
fullPlan	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property fullPlan: Full backup plan schedule.
incPlan	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property incPlan: Incremental backup plan schedule.
instanceUuid	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property instanceUuid: Uuid of database instance.
logPlan	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property logPlan: Log backup plan schedule.More details see FullPlan.
maxRateLimit	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property maxRateLimit: Max rate limit for backup job,.
maxRetrySeconds	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property maxRetrySeconds: Max retry seconds on network failure.
options	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property options: Backup options in json format, different for each type of database.
source	com.aliyun.ros.cdk.core.IResolvable OR SourceProperty	Property source: Which database instance or database will be backup.

---

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

---

id^Required

• Type: java.lang.String

---

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

---

dbPlanName^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property dbPlanName: Display name of the backup plan.

---

hostUuid^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

sourceType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

vaultId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vaultId: Vault ID to create backup plan, the backup data will be stored to the vault.

---

continuousPlan^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property continuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

---

cumulativePlan^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

---

fullPlan^Optional

• Type: java.lang.String OR com.aliyun.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.

---

incPlan^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property incPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

---

instanceUuid^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property instanceUuid: Uuid of database instance.

---

logPlan^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

---

maxRateLimit^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxRateLimit: Max rate limit for backup job,.

---

maxRetrySeconds^Optional

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property maxRetrySeconds: Max retry seconds on network failure.

---

options^Optional

• Type: java.lang.String OR com.aliyun.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: com.aliyun.ros.cdk.core.IResolvable OR SourceProperty

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

---

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

---

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

---

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

---

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

---

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

---

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

---

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

---

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

---

value^Required

• Type: java.lang.Object

---

Static Functions

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

---

isConstruct

import com.aliyun.ros.cdk.hbr.DbPlan;
DbPlan.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

---

Properties

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

---

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

---

ref^Required

public java.lang.String getRef();

• Type: java.lang.String

---

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

---

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

---

attrContinuousPlan^Required

public IResolvable getAttrContinuousPlan();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

---

attrContinuousUuid^Required

public IResolvable getAttrContinuousUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ContinuousUuid: Uuid of continuous backup plan.

---

attrCumulativePlan^Required

public IResolvable getAttrCumulativePlan();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

---

attrCumulativeUuid^Required

public IResolvable getAttrCumulativeUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CumulativeUuid: Uuid of cumulative plan.

---

attrDbPlanName^Required

public IResolvable getAttrDbPlanName();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DbPlanName: Display name of the backup plan.

---

attrFullPlan^Required

public IResolvable getAttrFullPlan();

• Type: com.aliyun.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 IResolvable getAttrFullUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute FullUuid: Uuid of full backup plan.

---

attrHostUuid^Required

public IResolvable getAttrHostUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---

attrIncPlan^Required

public IResolvable getAttrIncPlan();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

---

attrIncUuid^Required

public IResolvable getAttrIncUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IncUuid: Uuid of the incremental bakcup plan.

---

attrInstanceUuid^Required

public IResolvable getAttrInstanceUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceUuid: Uuid of database instance.

---

attrLogPlan^Required

public IResolvable getAttrLogPlan();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---

attrLogUuid^Required

public IResolvable getAttrLogUuid();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute LogUuid: Uuid of the log backup plan.

---

attrMaxRateLimit^Required

public IResolvable getAttrMaxRateLimit();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MaxRateLimit: Max rate limit for backup job,.

---

attrMaxRetrySeconds^Required

public IResolvable getAttrMaxRetrySeconds();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute MaxRetrySeconds: Max retry seconds on network failure.

---

attrOptions^Required

public IResolvable getAttrOptions();

• Type: com.aliyun.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 IResolvable getAttrPlanId();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PlanId: Id of the backup plan.

---

attrSourceType^Required

public IResolvable getAttrSourceType();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---

attrTarget^Required

public IResolvable getAttrTarget();

• Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Target: Target vault to backup.

---

attrVaultId^Required

public IResolvable getAttrVaultId();

• Type: com.aliyun.ros.cdk.core.IResolvable

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

---