Skip to content

BackupPlan

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

Initializers 

import { datasource } from '@alicloud/ros-cdk-dbs'
new datasource.BackupPlan(scope: Construct, id: string, props: BackupPlanProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props BackupPlanProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsRequired

enableResourcePropertyConstraintOptional

  • Type: boolean

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 toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { datasource } from '@alicloud/ros-cdk-dbs'
datasource.BackupPlan.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrBackupGatewayId @alicloud/ros-cdk-core.IResolvable Attribute BackupGatewayId: The ID of the backup gateway.
attrBackupMethod @alicloud/ros-cdk-core.IResolvable Attribute BackupMethod: Backup method.
attrBackupObjects @alicloud/ros-cdk-core.IResolvable Attribute BackupObjects: The backup object.
attrBackupPeriod @alicloud/ros-cdk-core.IResolvable Attribute BackupPeriod: Full backup cycle.
attrBackupPlanId @alicloud/ros-cdk-core.IResolvable Attribute BackupPlanId: The ID of the backup plan.
attrBackupPlanName @alicloud/ros-cdk-core.IResolvable Attribute BackupPlanName: The name of the backup plan.
attrBackupRetentionPeriod @alicloud/ros-cdk-core.IResolvable Attribute BackupRetentionPeriod: The retention time of backup data.
attrBackupStartTime @alicloud/ros-cdk-core.IResolvable Attribute BackupStartTime: The start time of full Backup.
attrBackupStorageType @alicloud/ros-cdk-core.IResolvable Attribute BackupStorageType: Built-in storage type:.
attrCreateTime @alicloud/ros-cdk-core.IResolvable Attribute CreateTime: The creation time of the backup plans.
attrCrossAliyunId @alicloud/ros-cdk-core.IResolvable Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts.
attrCrossRoleName @alicloud/ros-cdk-core.IResolvable Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts.
attrDatabaseType @alicloud/ros-cdk-core.IResolvable Attribute DatabaseType: Database type.
attrDuplicationArchivePeriod @alicloud/ros-cdk-core.IResolvable Attribute DuplicationArchivePeriod: The storage time for conversion to archive cold standby is 365 days by default.
attrDuplicationInfrequentAccessPeriod @alicloud/ros-cdk-core.IResolvable Attribute DuplicationInfrequentAccessPeriod: The storage time is converted to low-frequency access.
attrEnableBackupLog @alicloud/ros-cdk-core.IResolvable Attribute EnableBackupLog: Whether to enable incremental log Backup.
attrInstanceClass @alicloud/ros-cdk-core.IResolvable Attribute InstanceClass: Instance class.
attrOssBucketName @alicloud/ros-cdk-core.IResolvable Attribute OssBucketName: OSS Bucket name.
attrPaymentType @alicloud/ros-cdk-core.IResolvable Attribute PaymentType: The payment type of the resource.
attrResourceGroupId @alicloud/ros-cdk-core.IResolvable Attribute ResourceGroupId: The ID of the resource group.
attrSourceEndpointDatabaseName @alicloud/ros-cdk-core.IResolvable Attribute SourceEndpointDatabaseName: The name of the database.
attrSourceEndpointInstanceId @alicloud/ros-cdk-core.IResolvable Attribute SourceEndpointInstanceId: The ID of the database instance.
attrSourceEndpointInstanceType @alicloud/ros-cdk-core.IResolvable Attribute SourceEndpointInstanceType: The location of the database.
attrSourceEndpointRegion @alicloud/ros-cdk-core.IResolvable Attribute SourceEndpointRegion: The region of the database.
attrSourceEndpointSid @alicloud/ros-cdk-core.IResolvable Attribute SourceEndpointSid: Oracle SID name.
attrSourceEndpointUserName @alicloud/ros-cdk-core.IResolvable Attribute SourceEndpointUserName: Database account.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrBackupGatewayIdRequired 

public readonly attrBackupGatewayId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupGatewayId: The ID of the backup gateway.

attrBackupMethodRequired 

public readonly attrBackupMethod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupMethod: Backup method.

attrBackupObjectsRequired 

public readonly attrBackupObjects: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupObjects: The backup object.

attrBackupPeriodRequired 

public readonly attrBackupPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupPeriod: Full backup cycle.

attrBackupPlanIdRequired 

public readonly attrBackupPlanId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupPlanId: The ID of the backup plan.

attrBackupPlanNameRequired 

public readonly attrBackupPlanName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupPlanName: The name of the backup plan.

attrBackupRetentionPeriodRequired 

public readonly attrBackupRetentionPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupRetentionPeriod: The retention time of backup data.

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

attrBackupStartTimeRequired 

public readonly attrBackupStartTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupStartTime: The start time of full Backup.

attrBackupStorageTypeRequired 

public readonly attrBackupStorageType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BackupStorageType: Built-in storage type:.

attrCreateTimeRequired 

public readonly attrCreateTime: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute CreateTime: The creation time of the backup plans.

attrCrossAliyunIdRequired 

public readonly attrCrossAliyunId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrCrossRoleNameRequired 

public readonly attrCrossRoleName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrDatabaseTypeRequired 

public readonly attrDatabaseType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute DatabaseType: Database type.

attrDuplicationArchivePeriodRequired 

public readonly attrDuplicationArchivePeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrDuplicationInfrequentAccessPeriodRequired 

public readonly attrDuplicationInfrequentAccessPeriod: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

The default time is 180 days.

attrEnableBackupLogRequired 

public readonly attrEnableBackupLog: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableBackupLog: Whether to enable incremental log Backup.

attrInstanceClassRequired 

public readonly attrInstanceClass: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute InstanceClass: Instance class.

attrOssBucketNameRequired 

public readonly attrOssBucketName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute OssBucketName: OSS Bucket name.

attrPaymentTypeRequired 

public readonly attrPaymentType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PaymentType: The payment type of the resource.

attrResourceGroupIdRequired 

public readonly attrResourceGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSourceEndpointDatabaseNameRequired 

public readonly attrSourceEndpointDatabaseName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceEndpointDatabaseName: The name of the database.

attrSourceEndpointInstanceIdRequired 

public readonly attrSourceEndpointInstanceId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceEndpointInstanceId: The ID of the database instance.

attrSourceEndpointInstanceTypeRequired 

public readonly attrSourceEndpointInstanceType: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceEndpointInstanceType: The location of the database.

attrSourceEndpointRegionRequired 

public readonly attrSourceEndpointRegion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceEndpointRegion: The region of the database.

attrSourceEndpointSidRequired 

public readonly attrSourceEndpointSid: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceEndpointSid: Oracle SID name.

attrSourceEndpointUserNameRequired 

public readonly attrSourceEndpointUserName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute SourceEndpointUserName: Database account.