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 

using AlibabaCloud.SDK.ROS.CDK.Hbr;
new DbPlan(Construct Scope, string Id, DbPlanProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props DbPlanProps No description.
EnableResourcePropertyConstraint bool No description.

ScopeRequired

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

IdRequired

  • Type: string

PropsRequired

EnableResourcePropertyConstraintOptional

  • Type: bool

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 

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.

SessionRequired

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

The synthesis session.

AddCondition 

private void AddCondition(RosCondition Condition)

ConditionRequired

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

AddCount 

private void AddCount(object Count)

CountRequired

  • Type: object

AddDependency 

private void AddDependency(Resource Resource)

ResourceRequired

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

AddResourceDesc 

private void AddResourceDesc(string Desc)

DescRequired

  • Type: string

ApplyRemovalPolicy 

private void ApplyRemovalPolicy(RemovalPolicy Policy)

PolicyRequired

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

GetAtt 

private IResolvable GetAtt(string Name)

NameRequired

  • Type: string

SetMetadata 

private void SetMetadata(string Key, object Value)

KeyRequired

  • Type: string

ValueRequired

  • Type: object

Static Functions

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

IsConstruct 

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

Return whether the given object is a Construct.

XRequired

  • Type: object

Properties

Name Type Description
Node AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode The construct tree node associated with this construct.
Ref string No description.
Stack AlibabaCloud.SDK.ROS.CDK.Core.Stack The stack in which this resource is defined.
Resource AlibabaCloud.SDK.ROS.CDK.Core.RosResource No description.
AttrContinuousPlan AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ContinuousPlan: Continuous backup plan schedule.
AttrContinuousUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute ContinuousUuid: Uuid of continuous backup plan.
AttrCumulativePlan AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CumulativePlan: Cumulative plan schedule, only for mssql.
AttrCumulativeUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute CumulativeUuid: Uuid of cumulative plan.
AttrDbPlanName AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute DbPlanName: Display name of the backup plan.
AttrFullPlan AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute FullPlan: Full backup plan schedule.
AttrFullUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute FullUuid: Uuid of full backup plan.
AttrHostUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute HostUuid: Uuid of the host of the database instance.
AttrIncPlan AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute IncPlan: Incremental backup plan schedule.
AttrIncUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute IncUuid: Uuid of the incremental bakcup plan.
AttrInstanceUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute InstanceUuid: Uuid of database instance.
AttrLogPlan AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute LogPlan: Log backup plan schedule.More details see FullPlan.
AttrLogUuid AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute LogUuid: Uuid of the log backup plan.
AttrMaxRateLimit AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute MaxRateLimit: Max rate limit for backup job,.
AttrMaxRetrySeconds AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute MaxRetrySeconds: Max retry seconds on network failure.
AttrOptions AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Options: Backup options in json format, different for each type of database.
AttrPlanId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute PlanId: Id of the backup plan.
AttrSourceType AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute SourceType: Database type, allowed value: MYSQL, ORACLE, MSSQL.
AttrTarget AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute Target: Target vault to backup.
AttrVaultId AlibabaCloud.SDK.ROS.CDK.Core.IResolvable Attribute VaultId: Vault ID to create backup plan, the backup data will be stored to the vault.

NodeRequired 

public ConstructNode Node { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.ConstructNode

The construct tree node associated with this construct.

RefRequired 

public string Ref { get; }
  • Type: string

StackRequired 

public Stack Stack { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.Stack

The stack in which this resource is defined.

ResourceOptional 

public RosResource Resource { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.RosResource

AttrContinuousPlanRequired 

public IResolvable AttrContinuousPlan { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ContinuousPlan: Continuous backup plan schedule.

Use { "type": "continuous" }.

AttrContinuousUuidRequired 

public IResolvable AttrContinuousUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute ContinuousUuid: Uuid of continuous backup plan.

AttrCumulativePlanRequired 

public IResolvable AttrCumulativePlan { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CumulativePlan: Cumulative plan schedule, only for mssql.

More details see FullPlan.

AttrCumulativeUuidRequired 

public IResolvable AttrCumulativeUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute CumulativeUuid: Uuid of cumulative plan.

AttrDbPlanNameRequired 

public IResolvable AttrDbPlanName { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute DbPlanName: Display name of the backup plan.

AttrFullPlanRequired 

public IResolvable AttrFullPlan { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrFullUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute FullUuid: Uuid of full backup plan.

AttrHostUuidRequired 

public IResolvable AttrHostUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrIncPlanRequired 

public IResolvable AttrIncPlan { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute IncPlan: Incremental backup plan schedule.

Only for mysql and oracle. More details see FullPlan.

AttrIncUuidRequired 

public IResolvable AttrIncUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute IncUuid: Uuid of the incremental bakcup plan.

AttrInstanceUuidRequired 

public IResolvable AttrInstanceUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute InstanceUuid: Uuid of database instance.

AttrLogPlanRequired 

public IResolvable AttrLogPlan { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrLogUuidRequired 

public IResolvable AttrLogUuid { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute LogUuid: Uuid of the log backup plan.

AttrMaxRateLimitRequired 

public IResolvable AttrMaxRateLimit { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute MaxRateLimit: Max rate limit for backup job,.

AttrMaxRetrySecondsRequired 

public IResolvable AttrMaxRetrySeconds { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute MaxRetrySeconds: Max retry seconds on network failure.

AttrOptionsRequired 

public IResolvable AttrOptions { get; }
  • Type: AlibabaCloud.SDK.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 IResolvable AttrPlanId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute PlanId: Id of the backup plan.

AttrSourceTypeRequired 

public IResolvable AttrSourceType { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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

AttrTargetRequired 

public IResolvable AttrTarget { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

Attribute Target: Target vault to backup.

AttrVaultIdRequired 

public IResolvable AttrVaultId { get; }
  • Type: AlibabaCloud.SDK.ROS.CDK.Core.IResolvable

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