RestoreJob

• Implements: IRestoreJob

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

Initializers

import com.aliyun.ros.cdk.hbr.RestoreJob;
RestoreJob.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .restoreType(java.lang.String)
    .restoreType(IResolvable)
    .snapshotId(java.lang.String)
    .snapshotId(IResolvable)
    .sourceClientId(java.lang.String)
    .sourceClientId(IResolvable)
    .sourceInstanceId(java.lang.String)
    .sourceInstanceId(IResolvable)
    .sourceType(java.lang.String)
    .sourceType(IResolvable)
    .targetClientId(java.lang.String)
    .targetClientId(IResolvable)
    .targetInstanceId(java.lang.String)
    .targetInstanceId(IResolvable)
    .targetPath(java.lang.String)
    .targetPath(IResolvable)
    .vaultId(java.lang.String)
    .vaultId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

restoreType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property restoreType: Restore type.

snapshotId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property snapshotId: Snapshot ID.

sourceClientId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceClientId: Source client ID.

It should be provided when SourceType=FILE.

sourceInstanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceInstanceId: Source instance ID.

It should be provided when SourceType=ECS_FILE.

sourceType^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property sourceType: Source type.

targetClientId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetClientId: Target client ID.

It should be provided when RestoreType=FILE.

targetInstanceId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetInstanceId: Target instance ID.

It should be provided when RestoreType=ECS_FILE.

targetPath^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetPath: The destination path for the restore.

This parameter is valid only when RestoreType is set to ECS_FILE.

vaultId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property vaultId: Vault ID.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.hbr.RestoreJob;
RestoreJob.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrErrorMessage^Required

public java.lang.Object getAttrErrorMessage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ErrorMessage: Error message of restore job.

attrRestoreId^Required

public java.lang.Object getAttrRestoreId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RestoreId: Restore job ID.

attrRestoreType^Required

public java.lang.Object getAttrRestoreType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RestoreType: Restore type.

attrSourceType^Required

public java.lang.Object getAttrSourceType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute SourceType: Source type.

attrStatus^Required

public java.lang.Object getAttrStatus();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: Restore job status.

props^Required

public RestoreJobProps getProps();

• Type: RestoreJobProps