Skip to content

RestoreTaskProps

Properties for defining a RestoreTask.

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

Initializer 

import { RestoreTaskProps } from '@alicloud/ros-cdk-dbs'
const restoreTaskProps: RestoreTaskProps = { ... }

Properties

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

backupPlanIdRequired 

public readonly backupPlanId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property backupPlanId: The ID of the backup plan.

destinationEndpointInstanceTypeRequired 

public readonly destinationEndpointInstanceType: string | IResolvable;
  • Type: string | @alicloud/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.

restoreTaskNameRequired 

public readonly restoreTaskName: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property restoreTaskName: The name of the restoration task.

backupGatewayIdOptional 

public readonly backupGatewayId: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property backupGatewayId: The ID of the backup gateway.

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

backupSetIdOptional 

public readonly backupSetId: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

destinationEndpointDatabaseNameOptional 

public readonly destinationEndpointDatabaseName: string | IResolvable;
  • Type: string | @alicloud/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.

destinationEndpointInstanceIdOptional 

public readonly destinationEndpointInstanceId: string | IResolvable;
  • Type: string | @alicloud/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.

destinationEndpointIpOptional 

public readonly destinationEndpointIp: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

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

destinationEndpointOracleSidOptional 

public readonly destinationEndpointOracleSid: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property destinationEndpointOracleSid: The SID of the Oracle instance.

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

destinationEndpointPasswordOptional 

public readonly destinationEndpointPassword: string | IResolvable;
  • Type: string | @alicloud/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.

destinationEndpointPortOptional 

public readonly destinationEndpointPort: number | IResolvable;
  • Type: number | @alicloud/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.

destinationEndpointRegionOptional 

public readonly destinationEndpointRegion: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property destinationEndpointRegion: The region of the database.

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

destinationEndpointUserNameOptional 

public readonly destinationEndpointUserName: string | IResolvable;
  • Type: string | @alicloud/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.

duplicateConflictOptional 

public readonly duplicateConflict: string | IResolvable;
  • Type: string | @alicloud/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.

restoreDirOptional 

public readonly restoreDir: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

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

restoreHomeOptional 

public readonly restoreHome: string | IResolvable;
  • Type: string | @alicloud/ros-cdk-core.IResolvable

Property restoreHome: Database Program Directory.

restoreObjectsOptional 

public readonly restoreObjects: string | IResolvable;
  • Type: string | @alicloud/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.

restoreTimeOptional 

public readonly restoreTime: number | IResolvable;
  • Type: number | @alicloud/ros-cdk-core.IResolvable

Property restoreTime: The time when the fault is restored.

Set the value to 1554560477000.

startTaskOptional 

public readonly startTask: boolean | IResolvable;
  • Type: boolean | @alicloud/ros-cdk-core.IResolvable

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