BackupPlan
- Implements: com.aliyun.ros.cdk.dbs.datasource.IBackupPlan
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. |
fetchCondition | No description. |
fetchDependency | No description. |
fetchResourceDesc | 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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- Type: com.aliyun.ros.cdk.core.RemovalPolicy
fetchCondition
public RosCondition fetchCondition()
fetchDependency
public java.util.List<java.lang.String> fetchDependency()
fetchResourceDesc
public java.lang.String fetchResourceDesc()
getAtt
public IResolvable getAtt(java.lang.String name)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- Type: java.lang.Object
Properties
| Name | Type | Description |
|---|---|---|
node | com.aliyun.ros.cdk.core.ConstructNode | The construct tree node associated with this construct. |
env | com.aliyun.ros.cdk.core.IResourceEnvironment | The environment this resource belongs to. |
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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupGatewayId: The ID of the backup gateway. |
attrBackupMethod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupMethod: Backup method. |
attrBackupObjects | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupObjects: The backup object. |
attrBackupPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupPeriod: Full backup cycle. |
attrBackupPlanId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupPlanId: The ID of the backup plan. |
attrBackupPlanName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupPlanName: The name of the backup plan. |
attrBackupRetentionPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupRetentionPeriod: The retention time of backup data. |
attrBackupStartTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupStartTime: The start time of full Backup. |
attrBackupStorageType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BackupStorageType: Built-in storage type:. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The creation time of the backup plans. |
attrCrossAliyunId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts. |
attrCrossRoleName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts. |
attrDatabaseType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DatabaseType: Database type. |
attrDuplicationArchivePeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DuplicationArchivePeriod: The storage time for conversion to archive cold standby is 365 days by default. |
attrDuplicationInfrequentAccessPeriod | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute DuplicationInfrequentAccessPeriod: The storage time is converted to low-frequency access. |
attrEnableBackupLog | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute EnableBackupLog: Whether to enable incremental log Backup. |
attrInstanceClass | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute InstanceClass: Instance class. |
attrOssBucketName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute OssBucketName: OSS Bucket name. |
attrPaymentType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute PaymentType: The payment type of the resource. |
attrResourceGroupId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ResourceGroupId: The ID of the resource group. |
attrSourceEndpointDatabaseName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceEndpointDatabaseName: The name of the database. |
attrSourceEndpointInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceEndpointInstanceId: The ID of the database instance. |
attrSourceEndpointInstanceType | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceEndpointInstanceType: The location of the database. |
attrSourceEndpointRegion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceEndpointRegion: The region of the database. |
attrSourceEndpointSid | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceEndpointSid: Oracle SID name. |
attrSourceEndpointUserName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute SourceEndpointUserName: Database account. |
props | BackupPlanProps | No description. |
nodeRequired
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
envRequired
public IResourceEnvironment getEnv();
- Type: com.aliyun.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 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 java.lang.Object getAttrBackupGatewayId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupGatewayId: The ID of the backup gateway.
attrBackupMethodRequired
public java.lang.Object getAttrBackupMethod();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupMethod: Backup method.
attrBackupObjectsRequired
public java.lang.Object getAttrBackupObjects();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupObjects: The backup object.
attrBackupPeriodRequired
public java.lang.Object getAttrBackupPeriod();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupPeriod: Full backup cycle.
attrBackupPlanIdRequired
public java.lang.Object getAttrBackupPlanId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupPlanId: The ID of the backup plan.
attrBackupPlanNameRequired
public java.lang.Object getAttrBackupPlanName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupPlanName: The name of the backup plan.
attrBackupRetentionPeriodRequired
public java.lang.Object getAttrBackupRetentionPeriod();
- Type: java.lang.String OR 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 java.lang.Object getAttrBackupStartTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupStartTime: The start time of full Backup.
attrBackupStorageTypeRequired
public java.lang.Object getAttrBackupStorageType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute BackupStorageType: Built-in storage type:.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The creation time of the backup plans.
attrCrossAliyunIdRequired
public java.lang.Object getAttrCrossAliyunId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CrossAliyunId: The UID that is backed up across Alibaba cloud accounts.
attrCrossRoleNameRequired
public java.lang.Object getAttrCrossRoleName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CrossRoleName: The name of the RAM role that is backed up across Alibaba cloud accounts.
attrDatabaseTypeRequired
public java.lang.Object getAttrDatabaseType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DatabaseType: Database type.
attrDuplicationArchivePeriodRequired
public java.lang.Object getAttrDuplicationArchivePeriod();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute DuplicationArchivePeriod: The storage time for conversion to archive cold standby is 365 days by default.
attrDuplicationInfrequentAccessPeriodRequired
public java.lang.Object getAttrDuplicationInfrequentAccessPeriod();
- Type: java.lang.String OR 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 java.lang.Object getAttrEnableBackupLog();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute EnableBackupLog: Whether to enable incremental log Backup.
attrInstanceClassRequired
public java.lang.Object getAttrInstanceClass();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute InstanceClass: Instance class.
attrOssBucketNameRequired
public java.lang.Object getAttrOssBucketName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute OssBucketName: OSS Bucket name.
attrPaymentTypeRequired
public java.lang.Object getAttrPaymentType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute PaymentType: The payment type of the resource.
attrResourceGroupIdRequired
public java.lang.Object getAttrResourceGroupId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ResourceGroupId: The ID of the resource group.
attrSourceEndpointDatabaseNameRequired
public java.lang.Object getAttrSourceEndpointDatabaseName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceEndpointDatabaseName: The name of the database.
attrSourceEndpointInstanceIdRequired
public java.lang.Object getAttrSourceEndpointInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceEndpointInstanceId: The ID of the database instance.
attrSourceEndpointInstanceTypeRequired
public java.lang.Object getAttrSourceEndpointInstanceType();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceEndpointInstanceType: The location of the database.
attrSourceEndpointRegionRequired
public java.lang.Object getAttrSourceEndpointRegion();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceEndpointRegion: The region of the database.
attrSourceEndpointSidRequired
public java.lang.Object getAttrSourceEndpointSid();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceEndpointSid: Oracle SID name.
attrSourceEndpointUserNameRequired
public java.lang.Object getAttrSourceEndpointUserName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute SourceEndpointUserName: Database account.
propsRequired
public BackupPlanProps getProps();
- Type: BackupPlanProps