DbPlan

• Implements: IDbPlan

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

Initializers

using AlibabaCloud.SDK.ROS.CDK.Hbr;
new DbPlan(Construct Scope, string Id, DbPlanProps Props, bool EnableResourcePropertyConstraint = null);

Scope^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Construct

Id^Required

• Type: string

Props^Required

• Type: DbPlanProps

EnableResourcePropertyConstraint^Optional

• Type: bool

Methods

ToString

private string ToString()

Returns a string representation of this construct.

Synthesize

private 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: AlibabaCloud.SDK.ROS.CDK.Core.ISynthesisSession

The synthesis session.

AddCondition

private void AddCondition(RosCondition Condition)

Condition^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosCondition

AddCount

private void AddCount(object Count)

Count^Required

• Type: object

AddDependency

private void AddDependency(Resource Resource)

Resource^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Resource

AddResourceDesc

private void AddResourceDesc(string Desc)

Desc^Required

• Type: string

ApplyRemovalPolicy

private void ApplyRemovalPolicy(RemovalPolicy Policy)

Policy^Required

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RemovalPolicy

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

GetAtt

private IResolvable GetAtt(string Name)

Name^Required

• Type: string

SetMetadata

private void SetMetadata(string Key, object Value)

Key^Required

• Type: string

Value^Required

• Type: object

Static Functions

IsConstruct

using AlibabaCloud.SDK.ROS.CDK.Hbr;
DbPlan.IsConstruct(object X);

Return whether the given object is a Construct.

X^Required

• Type: object

Properties

Node^Required

public ConstructNode Node { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

Env^Required

public IResourceEnvironment Env { get; }

• Type: AlibabaCloud.SDK.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 string Ref { get; }

• Type: string

Stack^Required

public Stack Stack { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

Resource^Optional

public RosResource Resource { get; }

• Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrContinuousPlan^Required

public object AttrContinuousPlan { get; }

• Type: object

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

AttrContinuousUuid^Required

public object AttrContinuousUuid { get; }

• Type: object

Attribute ContinuousUuid: Uuid of continuous backup plan.

AttrCumulativePlan^Required

public object AttrCumulativePlan { get; }

• Type: object

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

AttrCumulativeUuid^Required

public object AttrCumulativeUuid { get; }

• Type: object

Attribute CumulativeUuid: Uuid of cumulative plan.

AttrDbPlanName^Required

public object AttrDbPlanName { get; }

• Type: object

Attribute DbPlanName: Display name of the backup plan.

AttrFullPlan^Required

public object AttrFullPlan { get; }

• Type: object

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 object AttrFullUuid { get; }

• Type: object

Attribute FullUuid: Uuid of full backup plan.

AttrHostUuid^Required

public object AttrHostUuid { get; }

• Type: object

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

AttrIncPlan^Required

public object AttrIncPlan { get; }

• Type: object

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

AttrIncUuid^Required

public object AttrIncUuid { get; }

• Type: object

Attribute IncUuid: Uuid of the incremental bakcup plan.

AttrInstanceUuid^Required

public object AttrInstanceUuid { get; }

• Type: object

Attribute InstanceUuid: Uuid of database instance.

AttrLogPlan^Required

public object AttrLogPlan { get; }

• Type: object

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

AttrLogUuid^Required

public object AttrLogUuid { get; }

• Type: object

Attribute LogUuid: Uuid of the log backup plan.

AttrMaxRateLimit^Required

public object AttrMaxRateLimit { get; }

• Type: object

Attribute MaxRateLimit: Max rate limit for backup job,.

AttrMaxRetrySeconds^Required

public object AttrMaxRetrySeconds { get; }

• Type: object

Attribute MaxRetrySeconds: Max retry seconds on network failure.

AttrOptions^Required

public object AttrOptions { get; }

• Type: object

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 object AttrPlanId { get; }

• Type: object

Attribute PlanId: Id of the backup plan.

AttrSourceType^Required

public object AttrSourceType { get; }

• Type: object

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

AttrTarget^Required

public object AttrTarget { get; }

• Type: object

Attribute Target: Target vault to backup.

AttrVaultId^Required

public object AttrVaultId { get; }

• Type: object

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

Props^Required

public DbPlanProps Props { get; }

• Type: DbPlanProps