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

Name	Type	Description
backup_plan_id	typing.Union[str, ros_cdk_core.IResolvable]	Property backupPlanId: The ID of the backup plan.
destination_endpoint_instance_type	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointInstanceType: The location of the database.
restore_task_name	typing.Union[str, ros_cdk_core.IResolvable]	Property restoreTaskName: The name of the restoration task.
backup_gateway_id	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property backupGatewayId: The ID of the backup gateway.
backup_set_id	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	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointDatabaseName: The name of the RDS database.
destination_endpoint_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointInstanceId: The ID of the ApsaraDB RDS instance to query.
destination_endpoint_ip	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointIp: The endpoint used to connect to the database.
destination_endpoint_oracle_sid	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointOracleSid: The SID of the Oracle instance.
destination_endpoint_password	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointPassword: The password that is used to log on to the RDS instance.
destination_endpoint_port	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.
destination_endpoint_region	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointRegion: The region of the database.
destination_endpoint_user_name	typing.Union[str, ros_cdk_core.IResolvable]	Property destinationEndpointUserName: The database account.
duplicate_conflict	typing.Union[str, ros_cdk_core.IResolvable]	Property duplicateConflict: The handling method for conflicts between objects with the same name.
restore_dir	typing.Union[str, ros_cdk_core.IResolvable]	Property restoreDir: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule is MySQL.
restore_home	typing.Union[str, ros_cdk_core.IResolvable]	Property restoreHome: Database Program Directory.
restore_objects	typing.Union[str, ros_cdk_core.IResolvable]	Property restoreObjects: Restore an object.
restore_time	typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]	Property restoreTime: The time when the fault is restored.
start_task	typing.Union[bool, ros_cdk_core.IResolvable]	Property startTask: Start restore task after creating a recovery task.

---

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 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.

---

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 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.

---

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 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.

---

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: DestinationEndpointInstanceType this parameter is required when agent is specified and the backup schedule 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: 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.

---

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 time when the fault is restored.

Set the value to 1554560477000.

---

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.

---