RestoreJob

This class encapsulates and extends the ROS resource type ALIYUN::HBR::RestoreJob, which is used to create a restore job.

Initializers

import ros_cdk_hbr
ros_cdk_hbr.RestoreJob(
  scope: Construct,
  id: str,
  restore_type: typing.Union[str, IResolvable],
  snapshot_id: typing.Union[str, IResolvable],
  source_client_id: typing.Union[str, IResolvable],
  source_instance_id: typing.Union[str, IResolvable],
  source_type: typing.Union[str, IResolvable],
  target_client_id: typing.Union[str, IResolvable],
  target_instance_id: typing.Union[str, IResolvable],
  target_path: typing.Union[str, IResolvable],
  vault_id: typing.Union[str, IResolvable],
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
scope	ros_cdk_core.Construct	No description.
id	str	No description.
restore_type	typing.Union[str, ros_cdk_core.IResolvable]	Property restoreType: Restore type.
snapshot_id	typing.Union[str, ros_cdk_core.IResolvable]	Property snapshotId: Snapshot ID.
source_client_id	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceClientId: Source client ID.
source_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceInstanceId: Source instance ID.
source_type	typing.Union[str, ros_cdk_core.IResolvable]	Property sourceType: Source type.
target_client_id	typing.Union[str, ros_cdk_core.IResolvable]	Property targetClientId: Target client ID.
target_instance_id	typing.Union[str, ros_cdk_core.IResolvable]	Property targetInstanceId: Target instance ID.
target_path	typing.Union[str, ros_cdk_core.IResolvable]	Property targetPath: Target path.
vault_id	typing.Union[str, ros_cdk_core.IResolvable]	Property vaultId: Vault ID.
enable_resource_property_constraint	bool	No description.

---

scope^Required

• Type: ros_cdk_core.Construct

---

id^Required

• Type: str

---

restore_type^Required

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

Property restoreType: Restore type.

---

snapshot_id^Required

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

Property snapshotId: Snapshot ID.

---

source_client_id^Required

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

Property sourceClientId: Source client ID.

It should be provided when SourceType=FILE.

---

source_instance_id^Required

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

Property sourceInstanceId: Source instance ID.

It should be provided when SourceType=ECS_FILE.

---

source_type^Required

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

Property sourceType: Source type.

---

target_client_id^Required

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

Property targetClientId: Target client ID.

It should be provided when RestoreType=FILE.

---

target_instance_id^Required

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

Property targetInstanceId: Target instance ID.

It should be provided when RestoreType=ECS_FILE.

---

target_path^Required

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

Property targetPath: Target path.

For instance, "/".

---

vault_id^Required

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

Property vaultId: Vault ID.

---

enable_resource_property_constraint^Optional

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

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

---

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

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

---

is_construct

import ros_cdk_hbr
ros_cdk_hbr.RestoreJob.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• 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_error_message	ros_cdk_core.IResolvable	Attribute ErrorMessage: Error message of restore job.
attr_restore_id	ros_cdk_core.IResolvable	Attribute RestoreId: Restore job ID.
attr_restore_type	ros_cdk_core.IResolvable	Attribute RestoreType: Restore type.
attr_source_type	ros_cdk_core.IResolvable	Attribute SourceType: Source type.
attr_status	ros_cdk_core.IResolvable	Attribute Status: Restore job status.

---

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

---

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_error_message^Required

attr_error_message: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute ErrorMessage: Error message of restore job.

---

attr_restore_id^Required

attr_restore_id: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RestoreId: Restore job ID.

---

attr_restore_type^Required

attr_restore_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute RestoreType: Restore type.

---

attr_source_type^Required

attr_source_type: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute SourceType: Source type.

---

attr_status^Required

attr_status: IResolvable

• Type: ros_cdk_core.IResolvable

Attribute Status: Restore job status.

---