Skip to content

BackupPlan

  • Implements: AlibabaCloud.SDK.ROS.CDK.Dbs.datasource.IBackupPlan

This class encapsulates and extends the ROS resource type DATASOURCE::DBS::BackupPlan.

Initializers

using AlibabaCloud.SDK.ROS.CDK.Dbs;
new BackupPlan(Construct Scope, string Id, BackupPlanProps Props, bool EnableResourcePropertyConstraint = null);
Name Type Description
Scope AlibabaCloud.SDK.ROS.CDK.Core.Construct No description.
Id string No description.
Props BackupPlanProps 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.
FetchCondition No description.
FetchDependency No description.
FetchResourceDesc 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

FetchCondition

private RosCondition FetchCondition()

FetchDependency

private string[] FetchDependency()

FetchResourceDesc

private string FetchResourceDesc()

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.Dbs;
BackupPlan.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.
Env AlibabaCloud.SDK.ROS.CDK.Core.IResourceEnvironment The environment this resource belongs to.
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.
AttrBackupGatewayId object Attribute BackupGatewayId: The ID of the backup gateway.
AttrBackupMethod object Attribute BackupMethod: Backup method.
AttrBackupObjects object Attribute BackupObjects: The backup object.
AttrBackupPeriod object Attribute BackupPeriod: Full backup cycle.
AttrBackupPlanId object Attribute BackupPlanId: The ID of the backup plan.
AttrBackupPlanName object Attribute BackupPlanName: The name of the backup plan.
AttrBackupRetentionPeriod object Attribute BackupRetentionPeriod: The retention time of backup data.
AttrBackupStartTime object Attribute BackupStartTime: The start time of full Backup.
AttrBackupStorageType object Attribute BackupStorageType: Built-in storage type:.
AttrCreateTime object Attribute CreateTime: The creation time of the backup plans.
AttrCrossAliyunId object Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts.
AttrCrossRoleName object Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts.
AttrDatabaseType object Attribute DatabaseType: Database type.
AttrDuplicationArchivePeriod object Attribute DuplicationArchivePeriod: The storage time for conversion to archive cold standby is 365 days by default.
AttrDuplicationInfrequentAccessPeriod object Attribute DuplicationInfrequentAccessPeriod: The storage time is converted to low-frequency access.
AttrEnableBackupLog object Attribute EnableBackupLog: Whether to enable incremental log Backup.
AttrInstanceClass object Attribute InstanceClass: Instance class.
AttrOssBucketName object Attribute OssBucketName: OSS Bucket name.
AttrPaymentType object Attribute PaymentType: The payment type of the resource.
AttrResourceGroupId object Attribute ResourceGroupId: The ID of the resource group.
AttrSourceEndpointDatabaseName object Attribute SourceEndpointDatabaseName: The name of the database.
AttrSourceEndpointInstanceId object Attribute SourceEndpointInstanceId: The ID of the database instance.
AttrSourceEndpointInstanceType object Attribute SourceEndpointInstanceType: The location of the database.
AttrSourceEndpointRegion object Attribute SourceEndpointRegion: The region of the database.
AttrSourceEndpointSid object Attribute SourceEndpointSid: Oracle SID name.
AttrSourceEndpointUserName object Attribute SourceEndpointUserName: Database account.
Props BackupPlanProps No description.

NodeRequired

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

The construct tree node associated with this construct.


EnvRequired

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.


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

AttrBackupGatewayIdRequired

public object AttrBackupGatewayId { get; }
  • Type: object

Attribute BackupGatewayId: The ID of the backup gateway.


AttrBackupMethodRequired

public object AttrBackupMethod { get; }
  • Type: object

Attribute BackupMethod: Backup method.


AttrBackupObjectsRequired

public object AttrBackupObjects { get; }
  • Type: object

Attribute BackupObjects: The backup object.


AttrBackupPeriodRequired

public object AttrBackupPeriod { get; }
  • Type: object

Attribute BackupPeriod: Full backup cycle.


AttrBackupPlanIdRequired

public object AttrBackupPlanId { get; }
  • Type: object

Attribute BackupPlanId: The ID of the backup plan.


AttrBackupPlanNameRequired

public object AttrBackupPlanName { get; }
  • Type: object

Attribute BackupPlanName: The name of the backup plan.


AttrBackupRetentionPeriodRequired

public object AttrBackupRetentionPeriod { get; }
  • Type: object

Attribute BackupRetentionPeriod: The retention time of backup data.

Valid values: 0 to 1825. Default value: 730 days.


AttrBackupStartTimeRequired

public object AttrBackupStartTime { get; }
  • Type: object

Attribute BackupStartTime: The start time of full Backup.


AttrBackupStorageTypeRequired

public object AttrBackupStorageType { get; }
  • Type: object

Attribute BackupStorageType: Built-in storage type:.


AttrCreateTimeRequired

public object AttrCreateTime { get; }
  • Type: object

Attribute CreateTime: The creation time of the backup plans.


AttrCrossAliyunIdRequired

public object AttrCrossAliyunId { get; }
  • Type: object

Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts.


AttrCrossRoleNameRequired

public object AttrCrossRoleName { get; }
  • Type: object

Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts.


AttrDatabaseTypeRequired

public object AttrDatabaseType { get; }
  • Type: object

Attribute DatabaseType: Database type.


AttrDuplicationArchivePeriodRequired

public object AttrDuplicationArchivePeriod { get; }
  • Type: object

Attribute DuplicationArchivePeriod: The storage time for conversion to archive cold standby is 365 days by default.


AttrDuplicationInfrequentAccessPeriodRequired

public object AttrDuplicationInfrequentAccessPeriod { get; }
  • Type: object

Attribute DuplicationInfrequentAccessPeriod: The storage time is converted to low-frequency access.

The default time is 180 days.


AttrEnableBackupLogRequired

public object AttrEnableBackupLog { get; }
  • Type: object

Attribute EnableBackupLog: Whether to enable incremental log Backup.


AttrInstanceClassRequired

public object AttrInstanceClass { get; }
  • Type: object

Attribute InstanceClass: Instance class.


AttrOssBucketNameRequired

public object AttrOssBucketName { get; }
  • Type: object

Attribute OssBucketName: OSS Bucket name.


AttrPaymentTypeRequired

public object AttrPaymentType { get; }
  • Type: object

Attribute PaymentType: The payment type of the resource.


AttrResourceGroupIdRequired

public object AttrResourceGroupId { get; }
  • Type: object

Attribute ResourceGroupId: The ID of the resource group.


AttrSourceEndpointDatabaseNameRequired

public object AttrSourceEndpointDatabaseName { get; }
  • Type: object

Attribute SourceEndpointDatabaseName: The name of the database.


AttrSourceEndpointInstanceIdRequired

public object AttrSourceEndpointInstanceId { get; }
  • Type: object

Attribute SourceEndpointInstanceId: The ID of the database instance.


AttrSourceEndpointInstanceTypeRequired

public object AttrSourceEndpointInstanceType { get; }
  • Type: object

Attribute SourceEndpointInstanceType: The location of the database.


AttrSourceEndpointRegionRequired

public object AttrSourceEndpointRegion { get; }
  • Type: object

Attribute SourceEndpointRegion: The region of the database.


AttrSourceEndpointSidRequired

public object AttrSourceEndpointSid { get; }
  • Type: object

Attribute SourceEndpointSid: Oracle SID name.


AttrSourceEndpointUserNameRequired

public object AttrSourceEndpointUserName { get; }
  • Type: object

Attribute SourceEndpointUserName: Database account.


PropsRequired

public BackupPlanProps Props { get; }