BackupPlan

• Implements: @alicloud/ros-cdk-dbs.datasource.IBackupPlan

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)

scope^Required

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

id^Required

• Type: string

props^Required

• Type: BackupPlanProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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 readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrBackupGatewayId^Required

public readonly attrBackupGatewayId: string | IResolvable;

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

Attribute BackupGatewayId: The ID of the backup gateway.

attrBackupMethod^Required

public readonly attrBackupMethod: string | IResolvable;

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

Attribute BackupMethod: Backup method.

attrBackupObjects^Required

public readonly attrBackupObjects: string | IResolvable;

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

Attribute BackupObjects: The backup object.

attrBackupPeriod^Required

public readonly attrBackupPeriod: string | IResolvable;

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

Attribute BackupPeriod: Full backup cycle.

attrBackupPlanId^Required

public readonly attrBackupPlanId: string | IResolvable;

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

Attribute BackupPlanId: The ID of the backup plan.

attrBackupPlanName^Required

public readonly attrBackupPlanName: string | IResolvable;

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

Attribute BackupPlanName: The name of the backup plan.

attrBackupRetentionPeriod^Required

public readonly attrBackupRetentionPeriod: string | IResolvable;

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

Attribute BackupRetentionPeriod: The retention time of backup data.

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

attrBackupStartTime^Required

public readonly attrBackupStartTime: string | IResolvable;

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

Attribute BackupStartTime: The start time of full Backup.

attrBackupStorageType^Required

public readonly attrBackupStorageType: string | IResolvable;

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

Attribute BackupStorageType: Built-in storage type:.

attrCreateTime^Required

public readonly attrCreateTime: string | IResolvable;

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

Attribute CreateTime: The creation time of the backup plans.

attrCrossAliyunId^Required

public readonly attrCrossAliyunId: string | IResolvable;

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

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

attrCrossRoleName^Required

public readonly attrCrossRoleName: string | IResolvable;

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

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

attrDatabaseType^Required

public readonly attrDatabaseType: string | IResolvable;

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

Attribute DatabaseType: Database type.

attrDuplicationArchivePeriod^Required

public readonly attrDuplicationArchivePeriod: string | IResolvable;

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

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

attrDuplicationInfrequentAccessPeriod^Required

public readonly attrDuplicationInfrequentAccessPeriod: string | IResolvable;

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

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

The default time is 180 days.

attrEnableBackupLog^Required

public readonly attrEnableBackupLog: string | IResolvable;

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

Attribute EnableBackupLog: Whether to enable incremental log Backup.

attrInstanceClass^Required

public readonly attrInstanceClass: string | IResolvable;

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

Attribute InstanceClass: Instance class.

attrOssBucketName^Required

public readonly attrOssBucketName: string | IResolvable;

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

Attribute OssBucketName: OSS Bucket name.

attrPaymentType^Required

public readonly attrPaymentType: string | IResolvable;

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

Attribute PaymentType: The payment type of the resource.

attrResourceGroupId^Required

public readonly attrResourceGroupId: string | IResolvable;

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

Attribute ResourceGroupId: The ID of the resource group.

attrSourceEndpointDatabaseName^Required

public readonly attrSourceEndpointDatabaseName: string | IResolvable;

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

Attribute SourceEndpointDatabaseName: The name of the database.

attrSourceEndpointInstanceId^Required

public readonly attrSourceEndpointInstanceId: string | IResolvable;

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

Attribute SourceEndpointInstanceId: The ID of the database instance.

attrSourceEndpointInstanceType^Required

public readonly attrSourceEndpointInstanceType: string | IResolvable;

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

Attribute SourceEndpointInstanceType: The location of the database.

attrSourceEndpointRegion^Required

public readonly attrSourceEndpointRegion: string | IResolvable;

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

Attribute SourceEndpointRegion: The region of the database.

attrSourceEndpointSid^Required

public readonly attrSourceEndpointSid: string | IResolvable;

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

Attribute SourceEndpointSid: Oracle SID name.

attrSourceEndpointUserName^Required

public readonly attrSourceEndpointUserName: string | IResolvable;

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

Attribute SourceEndpointUserName: Database account.

props^Required

public readonly props: BackupPlanProps;

• Type: BackupPlanProps