RestoreTask

• Implements: IRestoreTask

This class encapsulates and extends the ROS resource type ALIYUN::DBS::RestoreTask.

Initializers

import ros_cdk_dbs
ros_cdk_dbs.RestoreTask(
  scope: Construct,
  id: str,
  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,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

backup_plan_id^Required

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

Property backupPlanId: The ID of the backup plan.

destination_endpoint_instance_type^Required

• 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

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

Property restoreTaskName: The name of the restoration task.

backup_gateway_id^Optional

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

• 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

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

Property restoreHome: Database Program Directory.

restore_objects^Optional

• 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

• 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

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

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

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_dbs
ros_cdk_dbs.RestoreTask.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_restore_task_id^Required

attr_restore_task_id: typing.Union[str, IResolvable]

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

Attribute RestoreTaskId: The ID of the restoration task.

props^Required

props: RestoreTaskProps

• Type: RestoreTaskProps