Skip to content

RestoreTaskProps

Properties for defining a RestoreTask.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkdbs"
&alicloudroscdkdbs.RestoreTaskProps {
    BackupPlanId: interface{},
    DestinationEndpointInstanceType: interface{},
    RestoreTaskName: interface{},
    BackupGatewayId: interface{},
    BackupSetId: interface{},
    DestinationEndpointDatabaseName: interface{},
    DestinationEndpointInstanceId: interface{},
    DestinationEndpointIp: interface{},
    DestinationEndpointOracleSid: interface{},
    DestinationEndpointPassword: interface{},
    DestinationEndpointPort: interface{},
    DestinationEndpointRegion: interface{},
    DestinationEndpointUserName: interface{},
    DuplicateConflict: interface{},
    RestoreDir: interface{},
    RestoreHome: interface{},
    RestoreObjects: interface{},
    RestoreTime: interface{},
    StartTask: interface{},
}

Properties

Name Type Description
BackupPlanId interface{} Property backupPlanId: The ID of the backup plan.
DestinationEndpointInstanceType interface{} Property destinationEndpointInstanceType: The location of the database.
RestoreTaskName interface{} Property restoreTaskName: The name of the restoration task.
BackupGatewayId interface{} Property backupGatewayId: The ID of the backup gateway.
BackupSetId interface{} Property backupSetId: The ID of the full backup set used for restoration, which is mutually exclusive to RestoreTime.
DestinationEndpointDatabaseName interface{} Property destinationEndpointDatabaseName: The name of the RDS database.
DestinationEndpointInstanceId interface{} Property destinationEndpointInstanceId: The ID of the ApsaraDB RDS instance to query.
DestinationEndpointIp interface{} Property destinationEndpointIp: The endpoint used to connect to the database.
DestinationEndpointOracleSid interface{} Property destinationEndpointOracleSid: The SID of the Oracle instance.
DestinationEndpointPassword interface{} Property destinationEndpointPassword: The password that is used to log on to the RDS instance.
DestinationEndpointPort interface{} Property destinationEndpointPort: The port that is used to access the database of the primary MySQL server.
DestinationEndpointRegion interface{} Property destinationEndpointRegion: The region of the database.
DestinationEndpointUserName interface{} Property destinationEndpointUserName: The database account.
DuplicateConflict interface{} Property duplicateConflict: The handling method for conflicts between objects with the same name.
RestoreDir interface{} Property restoreDir: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule is MySQL.
RestoreHome interface{} Property restoreHome: Database Program Directory.
RestoreObjects interface{} Property restoreObjects: Restore an object.
RestoreTime interface{} Property restoreTime: The time when the fault is restored.
StartTask interface{} Property startTask: Start restore task after creating a recovery task.

BackupPlanIdRequired

BackupPlanId interface{}
  • Type: interface{}

Property backupPlanId: The ID of the backup plan.


DestinationEndpointInstanceTypeRequired

DestinationEndpointInstanceType interface{}
  • Type: interface{}

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

RestoreTaskName interface{}
  • Type: interface{}

Property restoreTaskName: The name of the restoration task.


BackupGatewayIdOptional

BackupGatewayId interface{}
  • Type: interface{}

Property backupGatewayId: The ID of the backup gateway.

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


BackupSetIdOptional

BackupSetId interface{}
  • Type: interface{}

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


DestinationEndpointDatabaseNameOptional

DestinationEndpointDatabaseName interface{}
  • Type: interface{}

Property destinationEndpointDatabaseName: The name of the RDS database.

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


DestinationEndpointInstanceIdOptional

DestinationEndpointInstanceId interface{}
  • Type: interface{}

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

DestinationEndpointIp interface{}
  • Type: interface{}

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

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


DestinationEndpointOracleSidOptional

DestinationEndpointOracleSid interface{}
  • Type: interface{}

Property destinationEndpointOracleSid: The SID of the Oracle instance.

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


DestinationEndpointPasswordOptional

DestinationEndpointPassword interface{}
  • Type: interface{}

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

DestinationEndpointPort interface{}
  • Type: interface{}

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

DestinationEndpointRegion interface{}
  • Type: interface{}

Property destinationEndpointRegion: The region of the database.

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


DestinationEndpointUserNameOptional

DestinationEndpointUserName interface{}
  • Type: interface{}

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

DuplicateConflict interface{}
  • Type: interface{}

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

RestoreDir interface{}
  • Type: interface{}

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


RestoreHomeOptional

RestoreHome interface{}
  • Type: interface{}

Property restoreHome: Database Program Directory.


RestoreObjectsOptional

RestoreObjects interface{}
  • Type: interface{}

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

RestoreTime interface{}
  • Type: interface{}

Property restoreTime: The time when the fault is restored.

Set the value to 1554560477000.


StartTaskOptional

StartTask interface{}
  • Type: interface{}

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