RestoreTaskProps

Properties for defining a RestoreTask.

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

Initializer

import ros_cdk_dbs
ros_cdk_dbs.RestoreTaskProps(
  backup_plan_id: typing.Union[str, IResolvable],
  destination_endpoint_instance_type: typing.Union[str, IResolvable],
  restore_task_name: typing.Union[str, IResolvable],
  backup_gateway_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  backup_set_id: typing.Union[str, IResolvable] = None,
  destination_endpoint_database_name: typing.Union[str, IResolvable] = None,
  destination_endpoint_instance_id: typing.Union[str, IResolvable] = None,
  destination_endpoint_ip: typing.Union[str, IResolvable] = None,
  destination_endpoint_oracle_sid: typing.Union[str, IResolvable] = None,
  destination_endpoint_password: typing.Union[str, IResolvable] = None,
  destination_endpoint_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  destination_endpoint_region: typing.Union[str, IResolvable] = None,
  destination_endpoint_user_name: typing.Union[str, IResolvable] = None,
  duplicate_conflict: typing.Union[str, IResolvable] = None,
  restore_dir: typing.Union[str, IResolvable] = None,
  restore_home: typing.Union[str, IResolvable] = None,
  restore_objects: typing.Union[str, IResolvable] = None,
  restore_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  start_task: typing.Union[bool, IResolvable] = None
)

Properties

backup_plan_id^Required

backup_plan_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property backupPlanId: The ID of the backup plan.

destination_endpoint_instance_type^Required

destination_endpoint_instance_type: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

restore_task_name^Required

restore_task_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property restoreTaskName: The name of the restoration task.

backup_gateway_id^Optional

backup_gateway_id: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property backupGatewayId: The ID of the backup gateway.

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

backup_set_id^Optional

backup_set_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

destination_endpoint_database_name^Optional

destination_endpoint_database_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

destination_endpoint_instance_id^Optional

destination_endpoint_instance_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

destination_endpoint_ip^Optional

destination_endpoint_ip: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

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

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

destination_endpoint_oracle_sid^Optional

destination_endpoint_oracle_sid: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property destinationEndpointOracleSid: The SID of the Oracle instance.

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

destination_endpoint_password^Optional

destination_endpoint_password: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

destination_endpoint_port^Optional

destination_endpoint_port: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], 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.

destination_endpoint_region^Optional

destination_endpoint_region: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property destinationEndpointRegion: The region of the database.

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

destination_endpoint_user_name^Optional

destination_endpoint_user_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

duplicate_conflict^Optional

duplicate_conflict: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

restore_dir^Optional

restore_dir: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

restore_home^Optional

restore_home: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property restoreHome: Database Program Directory.

restore_objects^Optional

restore_objects: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

restore_time^Optional

restore_time: typing.Union[typing.Union[int, float], IResolvable]

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

start_task^Optional

start_task: typing.Union[bool, IResolvable]

• Type: typing.Union[bool, ros_cdk_core.IResolvable]

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