Skip to content

BackupPlan

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

Initializers 

import com.aliyun.ros.cdk.dbs.datasource.BackupPlan;
BackupPlan.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .backupPlanId(java.lang.String)
    .backupPlanId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
backupPlanId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property backupPlanId: The ID of the backup plan.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

backupPlanIdRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property backupPlanId: The ID of the backup plan.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

  • Never: Never refresh the datasource resource when the stack is updated.
  • Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public 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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.dbs.datasource.BackupPlan;
BackupPlan.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrBackupGatewayIdRequired 

public IResolvable getAttrBackupGatewayId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupGatewayId: The ID of the backup gateway.

attrBackupMethodRequired 

public IResolvable getAttrBackupMethod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupMethod: Backup method.

attrBackupObjectsRequired 

public IResolvable getAttrBackupObjects();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupObjects: The backup object.

attrBackupPeriodRequired 

public IResolvable getAttrBackupPeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupPeriod: Full backup cycle.

attrBackupPlanIdRequired 

public IResolvable getAttrBackupPlanId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupPlanId: The ID of the backup plan.

attrBackupPlanNameRequired 

public IResolvable getAttrBackupPlanName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupPlanName: The name of the backup plan.

attrBackupRetentionPeriodRequired 

public IResolvable getAttrBackupRetentionPeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupRetentionPeriod: The retention time of backup data.

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

attrBackupStartTimeRequired 

public IResolvable getAttrBackupStartTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupStartTime: The start time of full Backup.

attrBackupStorageTypeRequired 

public IResolvable getAttrBackupStorageType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BackupStorageType: Built-in storage type:.

attrCreateTimeRequired 

public IResolvable getAttrCreateTime();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute CreateTime: The creation time of the backup plans.

attrCrossAliyunIdRequired 

public IResolvable getAttrCrossAliyunId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrCrossRoleNameRequired 

public IResolvable getAttrCrossRoleName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDatabaseTypeRequired 

public IResolvable getAttrDatabaseType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute DatabaseType: Database type.

attrDuplicationArchivePeriodRequired 

public IResolvable getAttrDuplicationArchivePeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrDuplicationInfrequentAccessPeriodRequired 

public IResolvable getAttrDuplicationInfrequentAccessPeriod();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

The default time is 180 days.

attrEnableBackupLogRequired 

public IResolvable getAttrEnableBackupLog();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnableBackupLog: Whether to enable incremental log Backup.

attrInstanceClassRequired 

public IResolvable getAttrInstanceClass();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute InstanceClass: Instance class.

attrOssBucketNameRequired 

public IResolvable getAttrOssBucketName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute OssBucketName: OSS Bucket name.

attrPaymentTypeRequired 

public IResolvable getAttrPaymentType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PaymentType: The payment type of the resource.

attrResourceGroupIdRequired 

public IResolvable getAttrResourceGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ResourceGroupId: The ID of the resource group.

attrSourceEndpointDatabaseNameRequired 

public IResolvable getAttrSourceEndpointDatabaseName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceEndpointDatabaseName: The name of the database.

attrSourceEndpointInstanceIdRequired 

public IResolvable getAttrSourceEndpointInstanceId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceEndpointInstanceId: The ID of the database instance.

attrSourceEndpointInstanceTypeRequired 

public IResolvable getAttrSourceEndpointInstanceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceEndpointInstanceType: The location of the database.

attrSourceEndpointRegionRequired 

public IResolvable getAttrSourceEndpointRegion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceEndpointRegion: The region of the database.

attrSourceEndpointSidRequired 

public IResolvable getAttrSourceEndpointSid();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceEndpointSid: Oracle SID name.

attrSourceEndpointUserNameRequired 

public IResolvable getAttrSourceEndpointUserName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceEndpointUserName: Database account.