DbPlan

• Implements: IDbPlan

This class encapsulates and extends the ROS resource type ALIYUN::HBR::DbPlanCreates a database 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();

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

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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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

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

node^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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 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 java.lang.Object getAttrContinuousPlan();

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

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

attrContinuousUuid^Required

public java.lang.Object getAttrContinuousUuid();

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

Attribute ContinuousUuid: Uuid of continuous backup plan.

attrCumulativePlan^Required

public java.lang.Object getAttrCumulativePlan();

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

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

attrCumulativeUuid^Required

public java.lang.Object getAttrCumulativeUuid();

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

Attribute CumulativeUuid: Uuid of cumulative plan.

attrDbPlanName^Required

public java.lang.Object getAttrDbPlanName();

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

Attribute DbPlanName: Display name of the backup plan.

attrFullPlan^Required

public java.lang.Object getAttrFullPlan();

• Type: java.lang.String OR 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 java.lang.Object getAttrFullUuid();

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

Attribute FullUuid: Uuid of full backup plan.

attrHostUuid^Required

public java.lang.Object getAttrHostUuid();

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

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

attrIncPlan^Required

public java.lang.Object getAttrIncPlan();

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

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

attrIncUuid^Required

public java.lang.Object getAttrIncUuid();

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

Attribute IncUuid: Uuid of the incremental bakcup plan.

attrInstanceUuid^Required

public java.lang.Object getAttrInstanceUuid();

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

Attribute InstanceUuid: Uuid of database instance.

attrLogPlan^Required

public java.lang.Object getAttrLogPlan();

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

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

attrLogUuid^Required

public java.lang.Object getAttrLogUuid();

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

Attribute LogUuid: Uuid of the log backup plan.

attrMaxRateLimit^Required

public java.lang.Object getAttrMaxRateLimit();

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

Attribute MaxRateLimit: Max rate limit for backup job,.

attrMaxRetrySeconds^Required

public java.lang.Object getAttrMaxRetrySeconds();

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

Attribute MaxRetrySeconds: Max retry seconds on network failure.

attrOptions^Required

public java.lang.Object getAttrOptions();

• Type: java.lang.String OR 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 java.lang.Object getAttrPlanId();

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

Attribute PlanId: Id of the backup plan.

attrSourceType^Required

public java.lang.Object getAttrSourceType();

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

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

attrTarget^Required

public java.lang.Object getAttrTarget();

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

Attribute Target: Target vault to backup.

attrVaultId^Required

public java.lang.Object getAttrVaultId();

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

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

props^Required

public DbPlanProps getProps();

• Type: DbPlanProps