Skip to content

RestoreTask

This class encapsulates and extends the ROS resource type ALIYUN::DBS::RestoreTask, which is used to create a restore task.

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No 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.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

backup_plan_idRequired

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

Property backupPlanId: The ID of the backup plan.

destination_endpoint_instance_typeRequired

  • 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_nameRequired

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

Property restoreTaskName: The name of the restoration task.

backup_gateway_idOptional

  • 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_idOptional

  • 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_nameOptional

  • 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_idOptional

  • 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_ipOptional

  • 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_sidOptional

  • 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_passwordOptional

  • 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_portOptional

  • 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_regionOptional

  • 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_nameOptional

  • 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_conflictOptional

  • 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_dirOptional

  • 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_homeOptional

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

Property restoreHome: Database Program Directory.

restore_objectsOptional

  • 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_timeOptional

  • 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_taskOptional

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

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

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_restore_task_id ros_cdk_core.IResolvable Attribute RestoreTaskId: The ID of the restoration task.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_restore_task_idRequired 

attr_restore_task_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RestoreTaskId: The ID of the restoration task.