Skip to content

RestoreJob

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();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
restoreType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property restoreType: Restore type.
snapshotId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property snapshotId: Snapshot ID.
sourceClientId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceClientId: Source client ID.
sourceInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceInstanceId: Source instance ID.
sourceType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sourceType: Source type.
targetClientId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetClientId: Target client ID.
targetInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetInstanceId: Target instance ID.
targetPath java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetPath: Target path.
vaultId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vaultId: Vault ID.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

restoreTypeRequired

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

Property restoreType: Restore type.

snapshotIdRequired

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

Property snapshotId: Snapshot ID.

sourceClientIdRequired

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

Property sourceClientId: Source client ID.

It should be provided when SourceType=FILE.

sourceInstanceIdRequired

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

Property sourceInstanceId: Source instance ID.

It should be provided when SourceType=ECS_FILE.

sourceTypeRequired

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

Property sourceType: Source type.

targetClientIdRequired

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

Property targetClientId: Target client ID.

It should be provided when RestoreType=FILE.

targetInstanceIdRequired

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

Property targetInstanceId: Target instance ID.

It should be provided when RestoreType=ECS_FILE.

targetPathRequired

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

Property targetPath: Target path.

For instance, "/".

vaultIdRequired

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

Property vaultId: Vault ID.

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

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.

sessionRequired

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

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

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

addCount 

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

countRequired

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

addDependency 

public void addDependency(Resource resource)

resourceRequired

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

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

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

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

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

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

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

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrErrorMessage com.aliyun.ros.cdk.core.IResolvable Attribute ErrorMessage: Error message of restore job.
attrRestoreId com.aliyun.ros.cdk.core.IResolvable Attribute RestoreId: Restore job ID.
attrRestoreType com.aliyun.ros.cdk.core.IResolvable Attribute RestoreType: Restore type.
attrSourceType com.aliyun.ros.cdk.core.IResolvable Attribute SourceType: Source type.
attrStatus com.aliyun.ros.cdk.core.IResolvable Attribute Status: Restore job status.

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrErrorMessageRequired 

public IResolvable getAttrErrorMessage();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ErrorMessage: Error message of restore job.

attrRestoreIdRequired 

public IResolvable getAttrRestoreId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RestoreId: Restore job ID.

attrRestoreTypeRequired 

public IResolvable getAttrRestoreType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RestoreType: Restore type.

attrSourceTypeRequired 

public IResolvable getAttrSourceType();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute SourceType: Source type.

attrStatusRequired 

public IResolvable getAttrStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Status: Restore job status.