RestoreTaskProps

Properties for defining a RestoreTask.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-dbs-restoretask

Initializer

import com.aliyun.ros.cdk.dbs.RestoreTaskProps;
RestoreTaskProps.builder()
    .backupPlanId(java.lang.String)
    .backupPlanId(IResolvable)
    .destinationEndpointInstanceType(java.lang.String)
    .destinationEndpointInstanceType(IResolvable)
    .restoreTaskName(java.lang.String)
    .restoreTaskName(IResolvable)
//  .backupGatewayId(java.lang.Number)
//  .backupGatewayId(IResolvable)
//  .backupSetId(java.lang.String)
//  .backupSetId(IResolvable)
//  .destinationEndpointDatabaseName(java.lang.String)
//  .destinationEndpointDatabaseName(IResolvable)
//  .destinationEndpointInstanceId(java.lang.String)
//  .destinationEndpointInstanceId(IResolvable)
//  .destinationEndpointIp(java.lang.String)
//  .destinationEndpointIp(IResolvable)
//  .destinationEndpointOracleSid(java.lang.String)
//  .destinationEndpointOracleSid(IResolvable)
//  .destinationEndpointPassword(java.lang.String)
//  .destinationEndpointPassword(IResolvable)
//  .destinationEndpointPort(java.lang.Number)
//  .destinationEndpointPort(IResolvable)
//  .destinationEndpointRegion(java.lang.String)
//  .destinationEndpointRegion(IResolvable)
//  .destinationEndpointUserName(java.lang.String)
//  .destinationEndpointUserName(IResolvable)
//  .duplicateConflict(java.lang.String)
//  .duplicateConflict(IResolvable)
//  .restoreDir(java.lang.String)
//  .restoreDir(IResolvable)
//  .restoreHome(java.lang.String)
//  .restoreHome(IResolvable)
//  .restoreObjects(java.lang.String)
//  .restoreObjects(IResolvable)
//  .restoreTime(java.lang.Number)
//  .restoreTime(IResolvable)
//  .startTask(java.lang.Boolean)
//  .startTask(IResolvable)
    .build();

Properties

Name	Type	Description
backupPlanId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property backupPlanId: The ID of the backup plan.
destinationEndpointInstanceType	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointInstanceType: The location of the database.
restoreTaskName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property restoreTaskName: The name of the restoration task.
backupGatewayId	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property backupGatewayId: The ID of the backup gateway.
backupSetId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property backupSetId: The ID of the full backup set used for restoration, which is mutually exclusive to RestoreTime.
destinationEndpointDatabaseName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointDatabaseName: The name of the RDS database.
destinationEndpointInstanceId	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointInstanceId: The ID of the ApsaraDB RDS instance to query.
destinationEndpointIp	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointIp: The endpoint used to connect to the database.
destinationEndpointOracleSid	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointOracleSid: The SID of the Oracle instance.
destinationEndpointPassword	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointPassword: The password that is used to log on to the RDS instance.
destinationEndpointPort	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointPort: The port that is used to access the database of the primary MySQL server.
destinationEndpointRegion	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointRegion: The region of the database.
destinationEndpointUserName	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property destinationEndpointUserName: The database account.
duplicateConflict	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property duplicateConflict: The handling method for conflicts between objects with the same name.
restoreDir	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property restoreDir: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule is MySQL.
restoreHome	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property restoreHome: Database Program Directory.
restoreObjects	java.lang.String OR com.aliyun.ros.cdk.core.IResolvable	Property restoreObjects: Restore an object.
restoreTime	java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable	Property restoreTime: The time when the fault is restored.
startTask	java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable	Property startTask: Start restore task after creating a recovery task.

---

backupPlanId^Required

public java.lang.Object getBackupPlanId();

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

Property backupPlanId: The ID of the backup plan.

---

destinationEndpointInstanceType^Required

public java.lang.Object getDestinationEndpointInstanceType();

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

Property destinationEndpointInstanceType: The location of the database.

Valid values:

• rds
• ecs
• express: a database connected over express connect, VPN Gateway, or smart gateway.
• agent: The database connected through the backup Gateway
• dds: apsaradb for MongoDB
• kvstore
• polardb
• drds
• dg: the database is directly connected through IP Address: Port.

---

restoreTaskName^Required

public java.lang.Object getRestoreTaskName();

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

Property restoreTaskName: The name of the restoration task.

---

backupGatewayId^Optional

public java.lang.Object getBackupGatewayId();

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

Property backupGatewayId: The ID of the backup gateway.

NoteDestinationEndpointInstanceType if you set this parameter to agent, this parameter is required.

---

backupSetId^Optional

public java.lang.Object getBackupSetId();

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

Property backupSetId: The ID of the full backup set used for restoration, which is mutually exclusive to RestoreTime.

---

destinationEndpointDatabaseName^Optional

public java.lang.Object getDestinationEndpointDatabaseName();

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

Property destinationEndpointDatabaseName: The name of the RDS database.

Note When the database type is PostgreSQL or MongoDB, this parameter is required.

---

destinationEndpointInstanceId^Optional

public java.lang.Object getDestinationEndpointInstanceId();

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

Property destinationEndpointInstanceId: The ID of the ApsaraDB RDS instance to query.

NoteDestinationEndpointInstanceType if the value is RDS, ECS, DDS, or Express, this parameter is required.

---

destinationEndpointIp^Optional

public java.lang.Object getDestinationEndpointIp();

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

Property destinationEndpointIp: The endpoint used to connect to the database.

NoteDestinationEndpointInstanceType is express, agent, or other. This parameter is required.

---

destinationEndpointOracleSid^Optional

public java.lang.Object getDestinationEndpointOracleSid();

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

Property destinationEndpointOracleSid: The SID of the Oracle instance.

Note This parameter is required if the database type is Oracle.

---

destinationEndpointPassword^Optional

public java.lang.Object getDestinationEndpointPassword();

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

Property destinationEndpointPassword: The password that is used to log on to the RDS instance.

Note You must specify this parameter when the database type is Redis, or the database location is agent and the database type is MSSQL.

---

destinationEndpointPort^Optional

public java.lang.Object getDestinationEndpointPort();

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

Property destinationEndpointPort: The port that is used to access the database of the primary MySQL server.

NoteDestinationEndpointInstanceType is in the format of express, agent, other, or ECS. This parameter is required.

---

destinationEndpointRegion^Optional

public java.lang.Object getDestinationEndpointRegion();

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

Property destinationEndpointRegion: The region of the database.

NoteDestinationEndpointInstanceType for RDS, ECS, DDS, Express, or Agent, this parameter is required.

---

destinationEndpointUserName^Optional

public java.lang.Object getDestinationEndpointUserName();

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

Property destinationEndpointUserName: The database account.

Note You must specify this parameter when the database type is Redis, or the database location is agent and the database type is MSSQL.

---

duplicateConflict^Optional

public java.lang.Object getDuplicateConflict();

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

Property duplicateConflict: The handling method for conflicts between objects with the same name.

Valid values: failure: The object with the same name fails (default). renamenew: renames an object with the same name.

---

restoreDir^Optional

public java.lang.Object getRestoreDir();

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

Property restoreDir: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule is MySQL.

---

restoreHome^Optional

public java.lang.Object getRestoreHome();

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

Property restoreHome: Database Program Directory.

---

restoreObjects^Optional

public java.lang.Object getRestoreObjects();

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

Property restoreObjects: Restore an object.

Note For details, see the following RestoreObjects if the database is located in an agent, this parameter is required in other scenarios.

---

restoreTime^Optional

public java.lang.Object getRestoreTime();

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

Property restoreTime: The time when the fault is restored.

Set the value to 1554560477000.

---

startTask^Optional

public java.lang.Object getStartTask();

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

Property startTask: Start restore task after creating a recovery task.

---