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

backupPlanId^Required

public readonly backupPlanId: string | IResolvable;

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

Property backupPlanId: The ID of the backup plan.

destinationEndpointInstanceType^Required

public readonly destinationEndpointInstanceType: string | IResolvable;

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

Property destinationEndpointInstanceType: The type of the destination endpoint.

Valid values: - RDS: an ApsaraDB RDS instance. - ECS: a self-managed database hosted on an ECS instance. - Express: a database connected over a leased line, VPN Gateway, or Smart Access Gateway. - Agent: a database connected via a backup gateway. - DDS: an ApsaraDB for MongoDB (DDS) instance. - Other: a database connected over the internet by using a public IP address and port. - dg: a self-managed database without a public endpoint, connected via Database Gateway.

restoreTaskName^Required

public readonly restoreTaskName: string | IResolvable;

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

Property restoreTaskName: The name of the restoration task.

backupGatewayId^Optional

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.

backupSetId^Optional

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.

destinationEndpointDatabaseName^Optional

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.

destinationEndpointInstanceId^Optional

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.

destinationEndpointIp^Optional

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.

destinationEndpointOracleSid^Optional

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.

destinationEndpointPassword^Optional

public readonly destinationEndpointPassword: string | IResolvable;

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

Property destinationEndpointPassword: The password for the destination database account.

This parameter is optional if the database engine is Redis, or if DestinationEndpointInstanceType is set to Agent and the database engine is MSSQL. In other scenarios, this parameter is required.

destinationEndpointPort^Optional

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.

destinationEndpointRegion^Optional

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.

destinationEndpointUserName^Optional

public readonly destinationEndpointUserName: string | IResolvable;

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

Property destinationEndpointUserName: The username for the destination database account.

This parameter is optional if the database engine is Redis, or if DestinationEndpointInstanceType is set to Agent and the database engine is MSSQL. In other scenarios, this parameter is required.

duplicateConflict^Optional

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.

restoreDir^Optional

public readonly restoreDir: string | IResolvable;

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

Property restoreDir: The restore directory.

This parameter is required if DestinationEndpointInstanceType is set to Agent and the database type is MySQL.

restoreHome^Optional

public readonly restoreHome: string | IResolvable;

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

Property restoreHome: Database Program Directory.

restoreObjects^Optional

public readonly restoreObjects: string | IResolvable;

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

Property restoreObjects: The objects to restore.

This parameter is optional if DestinationEndpointInstanceType is set to Agent. In other scenarios, this parameter is required. - The value must be a JSON string in the following format: [{ "DBName": "source_database_name", "NewDBName": "destination_database_name" }]

You can use this API operation to restore data only at the database level. To restore data at the table level, log on to the console.

restoreTime^Optional

public readonly restoreTime: number | IResolvable;

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

Property restoreTime: The point-in-time for the restore, specified as a UNIX timestamp in milliseconds.

startTask^Optional

public readonly startTask: boolean | IResolvable;

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

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