alicloud.hbr.RestoreJob
Explore with Pulumi AI
Provides a Hybrid Backup Recovery (HBR) Restore Job resource.
For information about Hybrid Backup Recovery (HBR) Restore Job and how to use it, see What is Restore Job.
NOTE: Available in v1.133.0+.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
const default = alicloud.hbr.getEcsBackupPlans({
nameRegex: "plan-tf-used-dont-delete",
});
const defaultGetOssBackupPlans = alicloud.hbr.getOssBackupPlans({
nameRegex: "plan-tf-used-dont-delete",
});
const defaultGetNasBackupPlans = alicloud.hbr.getNasBackupPlans({
nameRegex: "plan-tf-used-dont-delete",
});
const ecsSnapshots = Promise.all([_default, _default]).then(([_default, _default1]) => alicloud.hbr.getSnapshots({
sourceType: "ECS_FILE",
vaultId: _default.plans?.[0]?.vaultId,
instanceId: _default1.plans?.[0]?.instanceId,
}));
const ossSnapshots = Promise.all([defaultGetOssBackupPlans, defaultGetOssBackupPlans]).then(([defaultGetOssBackupPlans, defaultGetOssBackupPlans1]) => alicloud.hbr.getSnapshots({
sourceType: "OSS",
vaultId: defaultGetOssBackupPlans.plans?.[0]?.vaultId,
bucket: defaultGetOssBackupPlans1.plans?.[0]?.bucket,
}));
const nasSnapshots = Promise.all([defaultGetNasBackupPlans, defaultGetNasBackupPlans, defaultGetNasBackupPlans]).then(([defaultGetNasBackupPlans, defaultGetNasBackupPlans1, defaultGetNasBackupPlans2]) => alicloud.hbr.getSnapshots({
sourceType: "NAS",
vaultId: defaultGetNasBackupPlans.plans?.[0]?.vaultId,
fileSystemId: defaultGetNasBackupPlans1.plans?.[0]?.fileSystemId,
createTime: defaultGetNasBackupPlans2.plans?.[0]?.createTime,
}));
const nasJob = new alicloud.hbr.RestoreJob("nasJob", {
snapshotHash: nasSnapshots.then(nasSnapshots => nasSnapshots.snapshots?.[0]?.snapshotHash),
vaultId: defaultGetNasBackupPlans.then(defaultGetNasBackupPlans => defaultGetNasBackupPlans.plans?.[0]?.vaultId),
sourceType: "NAS",
restoreType: "NAS",
snapshotId: nasSnapshots.then(nasSnapshots => nasSnapshots.snapshots?.[0]?.snapshotId),
targetFileSystemId: defaultGetNasBackupPlans.then(defaultGetNasBackupPlans => defaultGetNasBackupPlans.plans?.[0]?.fileSystemId),
targetCreateTime: defaultGetNasBackupPlans.then(defaultGetNasBackupPlans => defaultGetNasBackupPlans.plans?.[0]?.createTime),
targetPath: "/",
options: " {\"includes\":[], \"excludes\":[]}\n",
});
const ossJob = new alicloud.hbr.RestoreJob("ossJob", {
snapshotHash: ossSnapshots.then(ossSnapshots => ossSnapshots.snapshots?.[0]?.snapshotHash),
vaultId: defaultGetOssBackupPlans.then(defaultGetOssBackupPlans => defaultGetOssBackupPlans.plans?.[0]?.vaultId),
sourceType: "OSS",
restoreType: "OSS",
snapshotId: ossSnapshots.then(ossSnapshots => ossSnapshots.snapshots?.[0]?.snapshotId),
targetBucket: defaultGetOssBackupPlans.then(defaultGetOssBackupPlans => defaultGetOssBackupPlans.plans?.[0]?.bucket),
targetPrefix: "",
options: " {\"includes\":[], \"excludes\":[]}\n",
});
const ecsJob = new alicloud.hbr.RestoreJob("ecsJob", {
snapshotHash: ecsSnapshots.then(ecsSnapshots => ecsSnapshots.snapshots?.[0]?.snapshotHash),
vaultId: _default.then(_default => _default.plans?.[0]?.vaultId),
sourceType: "ECS_FILE",
restoreType: "ECS_FILE",
snapshotId: ecsSnapshots.then(ecsSnapshots => ecsSnapshots.snapshots?.[0]?.snapshotId),
targetInstanceId: _default.then(_default => _default.plans?.[0]?.instanceId),
targetPath: "/",
});
import pulumi
import pulumi_alicloud as alicloud
default = alicloud.hbr.get_ecs_backup_plans(name_regex="plan-tf-used-dont-delete")
default_get_oss_backup_plans = alicloud.hbr.get_oss_backup_plans(name_regex="plan-tf-used-dont-delete")
default_get_nas_backup_plans = alicloud.hbr.get_nas_backup_plans(name_regex="plan-tf-used-dont-delete")
ecs_snapshots = alicloud.hbr.get_snapshots(source_type="ECS_FILE",
vault_id=default.plans[0].vault_id,
instance_id=default.plans[0].instance_id)
oss_snapshots = alicloud.hbr.get_snapshots(source_type="OSS",
vault_id=default_get_oss_backup_plans.plans[0].vault_id,
bucket=default_get_oss_backup_plans.plans[0].bucket)
nas_snapshots = alicloud.hbr.get_snapshots(source_type="NAS",
vault_id=default_get_nas_backup_plans.plans[0].vault_id,
file_system_id=default_get_nas_backup_plans.plans[0].file_system_id,
create_time=default_get_nas_backup_plans.plans[0].create_time)
nas_job = alicloud.hbr.RestoreJob("nasJob",
snapshot_hash=nas_snapshots.snapshots[0].snapshot_hash,
vault_id=default_get_nas_backup_plans.plans[0].vault_id,
source_type="NAS",
restore_type="NAS",
snapshot_id=nas_snapshots.snapshots[0].snapshot_id,
target_file_system_id=default_get_nas_backup_plans.plans[0].file_system_id,
target_create_time=default_get_nas_backup_plans.plans[0].create_time,
target_path="/",
options=" {\"includes\":[], \"excludes\":[]}\n")
oss_job = alicloud.hbr.RestoreJob("ossJob",
snapshot_hash=oss_snapshots.snapshots[0].snapshot_hash,
vault_id=default_get_oss_backup_plans.plans[0].vault_id,
source_type="OSS",
restore_type="OSS",
snapshot_id=oss_snapshots.snapshots[0].snapshot_id,
target_bucket=default_get_oss_backup_plans.plans[0].bucket,
target_prefix="",
options=" {\"includes\":[], \"excludes\":[]}\n")
ecs_job = alicloud.hbr.RestoreJob("ecsJob",
snapshot_hash=ecs_snapshots.snapshots[0].snapshot_hash,
vault_id=default.plans[0].vault_id,
source_type="ECS_FILE",
restore_type="ECS_FILE",
snapshot_id=ecs_snapshots.snapshots[0].snapshot_id,
target_instance_id=default.plans[0].instance_id,
target_path="/")
package main
import (
"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_default, err := hbr.GetEcsBackupPlans(ctx, &hbr.GetEcsBackupPlansArgs{
NameRegex: pulumi.StringRef("plan-tf-used-dont-delete"),
}, nil)
if err != nil {
return err
}
defaultGetOssBackupPlans, err := hbr.GetOssBackupPlans(ctx, &hbr.GetOssBackupPlansArgs{
NameRegex: pulumi.StringRef("plan-tf-used-dont-delete"),
}, nil)
if err != nil {
return err
}
defaultGetNasBackupPlans, err := hbr.GetNasBackupPlans(ctx, &hbr.GetNasBackupPlansArgs{
NameRegex: pulumi.StringRef("plan-tf-used-dont-delete"),
}, nil)
if err != nil {
return err
}
ecsSnapshots, err := hbr.GetSnapshots(ctx, &hbr.GetSnapshotsArgs{
SourceType: "ECS_FILE",
VaultId: _default.Plans[0].VaultId,
InstanceId: pulumi.StringRef(_default.Plans[0].InstanceId),
}, nil)
if err != nil {
return err
}
ossSnapshots, err := hbr.GetSnapshots(ctx, &hbr.GetSnapshotsArgs{
SourceType: "OSS",
VaultId: defaultGetOssBackupPlans.Plans[0].VaultId,
Bucket: pulumi.StringRef(defaultGetOssBackupPlans.Plans[0].Bucket),
}, nil)
if err != nil {
return err
}
nasSnapshots, err := hbr.GetSnapshots(ctx, &hbr.GetSnapshotsArgs{
SourceType: "NAS",
VaultId: defaultGetNasBackupPlans.Plans[0].VaultId,
FileSystemId: pulumi.StringRef(defaultGetNasBackupPlans.Plans[0].FileSystemId),
CreateTime: pulumi.StringRef(defaultGetNasBackupPlans.Plans[0].CreateTime),
}, nil)
if err != nil {
return err
}
_, err = hbr.NewRestoreJob(ctx, "nasJob", &hbr.RestoreJobArgs{
SnapshotHash: pulumi.String(nasSnapshots.Snapshots[0].SnapshotHash),
VaultId: pulumi.String(defaultGetNasBackupPlans.Plans[0].VaultId),
SourceType: pulumi.String("NAS"),
RestoreType: pulumi.String("NAS"),
SnapshotId: pulumi.String(nasSnapshots.Snapshots[0].SnapshotId),
TargetFileSystemId: pulumi.String(defaultGetNasBackupPlans.Plans[0].FileSystemId),
TargetCreateTime: pulumi.String(defaultGetNasBackupPlans.Plans[0].CreateTime),
TargetPath: pulumi.String("/"),
Options: pulumi.String(" {\"includes\":[], \"excludes\":[]}\n"),
})
if err != nil {
return err
}
_, err = hbr.NewRestoreJob(ctx, "ossJob", &hbr.RestoreJobArgs{
SnapshotHash: pulumi.String(ossSnapshots.Snapshots[0].SnapshotHash),
VaultId: pulumi.String(defaultGetOssBackupPlans.Plans[0].VaultId),
SourceType: pulumi.String("OSS"),
RestoreType: pulumi.String("OSS"),
SnapshotId: pulumi.String(ossSnapshots.Snapshots[0].SnapshotId),
TargetBucket: pulumi.String(defaultGetOssBackupPlans.Plans[0].Bucket),
TargetPrefix: pulumi.String(""),
Options: pulumi.String(" {\"includes\":[], \"excludes\":[]}\n"),
})
if err != nil {
return err
}
_, err = hbr.NewRestoreJob(ctx, "ecsJob", &hbr.RestoreJobArgs{
SnapshotHash: pulumi.String(ecsSnapshots.Snapshots[0].SnapshotHash),
VaultId: pulumi.String(_default.Plans[0].VaultId),
SourceType: pulumi.String("ECS_FILE"),
RestoreType: pulumi.String("ECS_FILE"),
SnapshotId: pulumi.String(ecsSnapshots.Snapshots[0].SnapshotId),
TargetInstanceId: pulumi.String(_default.Plans[0].InstanceId),
TargetPath: pulumi.String("/"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
return await Deployment.RunAsync(() =>
{
var @default = AliCloud.Hbr.GetEcsBackupPlans.Invoke(new()
{
NameRegex = "plan-tf-used-dont-delete",
});
var defaultGetOssBackupPlans = AliCloud.Hbr.GetOssBackupPlans.Invoke(new()
{
NameRegex = "plan-tf-used-dont-delete",
});
var defaultGetNasBackupPlans = AliCloud.Hbr.GetNasBackupPlans.Invoke(new()
{
NameRegex = "plan-tf-used-dont-delete",
});
var ecsSnapshots = AliCloud.Hbr.GetSnapshots.Invoke(new()
{
SourceType = "ECS_FILE",
VaultId = @default.Apply(getEcsBackupPlansResult => getEcsBackupPlansResult.Plans[0]?.VaultId),
InstanceId = @default.Apply(getEcsBackupPlansResult => getEcsBackupPlansResult.Plans[0]?.InstanceId),
});
var ossSnapshots = AliCloud.Hbr.GetSnapshots.Invoke(new()
{
SourceType = "OSS",
VaultId = defaultGetOssBackupPlans.Apply(getOssBackupPlansResult => getOssBackupPlansResult.Plans[0]?.VaultId),
Bucket = defaultGetOssBackupPlans.Apply(getOssBackupPlansResult => getOssBackupPlansResult.Plans[0]?.Bucket),
});
var nasSnapshots = AliCloud.Hbr.GetSnapshots.Invoke(new()
{
SourceType = "NAS",
VaultId = defaultGetNasBackupPlans.Apply(getNasBackupPlansResult => getNasBackupPlansResult.Plans[0]?.VaultId),
FileSystemId = defaultGetNasBackupPlans.Apply(getNasBackupPlansResult => getNasBackupPlansResult.Plans[0]?.FileSystemId),
CreateTime = defaultGetNasBackupPlans.Apply(getNasBackupPlansResult => getNasBackupPlansResult.Plans[0]?.CreateTime),
});
var nasJob = new AliCloud.Hbr.RestoreJob("nasJob", new()
{
SnapshotHash = nasSnapshots.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.SnapshotHash),
VaultId = defaultGetNasBackupPlans.Apply(getNasBackupPlansResult => getNasBackupPlansResult.Plans[0]?.VaultId),
SourceType = "NAS",
RestoreType = "NAS",
SnapshotId = nasSnapshots.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.SnapshotId),
TargetFileSystemId = defaultGetNasBackupPlans.Apply(getNasBackupPlansResult => getNasBackupPlansResult.Plans[0]?.FileSystemId),
TargetCreateTime = defaultGetNasBackupPlans.Apply(getNasBackupPlansResult => getNasBackupPlansResult.Plans[0]?.CreateTime),
TargetPath = "/",
Options = @" {""includes"":[], ""excludes"":[]}
",
});
var ossJob = new AliCloud.Hbr.RestoreJob("ossJob", new()
{
SnapshotHash = ossSnapshots.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.SnapshotHash),
VaultId = defaultGetOssBackupPlans.Apply(getOssBackupPlansResult => getOssBackupPlansResult.Plans[0]?.VaultId),
SourceType = "OSS",
RestoreType = "OSS",
SnapshotId = ossSnapshots.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.SnapshotId),
TargetBucket = defaultGetOssBackupPlans.Apply(getOssBackupPlansResult => getOssBackupPlansResult.Plans[0]?.Bucket),
TargetPrefix = "",
Options = @" {""includes"":[], ""excludes"":[]}
",
});
var ecsJob = new AliCloud.Hbr.RestoreJob("ecsJob", new()
{
SnapshotHash = ecsSnapshots.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.SnapshotHash),
VaultId = @default.Apply(@default => @default.Apply(getEcsBackupPlansResult => getEcsBackupPlansResult.Plans[0]?.VaultId)),
SourceType = "ECS_FILE",
RestoreType = "ECS_FILE",
SnapshotId = ecsSnapshots.Apply(getSnapshotsResult => getSnapshotsResult.Snapshots[0]?.SnapshotId),
TargetInstanceId = @default.Apply(@default => @default.Apply(getEcsBackupPlansResult => getEcsBackupPlansResult.Plans[0]?.InstanceId)),
TargetPath = "/",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.hbr.HbrFunctions;
import com.pulumi.alicloud.hbr.inputs.GetEcsBackupPlansArgs;
import com.pulumi.alicloud.hbr.inputs.GetOssBackupPlansArgs;
import com.pulumi.alicloud.hbr.inputs.GetNasBackupPlansArgs;
import com.pulumi.alicloud.hbr.inputs.GetSnapshotsArgs;
import com.pulumi.alicloud.hbr.RestoreJob;
import com.pulumi.alicloud.hbr.RestoreJobArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var default = HbrFunctions.getEcsBackupPlans(GetEcsBackupPlansArgs.builder()
.nameRegex("plan-tf-used-dont-delete")
.build());
final var defaultGetOssBackupPlans = HbrFunctions.getOssBackupPlans(GetOssBackupPlansArgs.builder()
.nameRegex("plan-tf-used-dont-delete")
.build());
final var defaultGetNasBackupPlans = HbrFunctions.getNasBackupPlans(GetNasBackupPlansArgs.builder()
.nameRegex("plan-tf-used-dont-delete")
.build());
final var ecsSnapshots = HbrFunctions.getSnapshots(GetSnapshotsArgs.builder()
.sourceType("ECS_FILE")
.vaultId(default_.plans()[0].vaultId())
.instanceId(default_.plans()[0].instanceId())
.build());
final var ossSnapshots = HbrFunctions.getSnapshots(GetSnapshotsArgs.builder()
.sourceType("OSS")
.vaultId(defaultGetOssBackupPlans.applyValue(getOssBackupPlansResult -> getOssBackupPlansResult.plans()[0].vaultId()))
.bucket(defaultGetOssBackupPlans.applyValue(getOssBackupPlansResult -> getOssBackupPlansResult.plans()[0].bucket()))
.build());
final var nasSnapshots = HbrFunctions.getSnapshots(GetSnapshotsArgs.builder()
.sourceType("NAS")
.vaultId(defaultGetNasBackupPlans.applyValue(getNasBackupPlansResult -> getNasBackupPlansResult.plans()[0].vaultId()))
.fileSystemId(defaultGetNasBackupPlans.applyValue(getNasBackupPlansResult -> getNasBackupPlansResult.plans()[0].fileSystemId()))
.createTime(defaultGetNasBackupPlans.applyValue(getNasBackupPlansResult -> getNasBackupPlansResult.plans()[0].createTime()))
.build());
var nasJob = new RestoreJob("nasJob", RestoreJobArgs.builder()
.snapshotHash(nasSnapshots.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].snapshotHash()))
.vaultId(defaultGetNasBackupPlans.applyValue(getNasBackupPlansResult -> getNasBackupPlansResult.plans()[0].vaultId()))
.sourceType("NAS")
.restoreType("NAS")
.snapshotId(nasSnapshots.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].snapshotId()))
.targetFileSystemId(defaultGetNasBackupPlans.applyValue(getNasBackupPlansResult -> getNasBackupPlansResult.plans()[0].fileSystemId()))
.targetCreateTime(defaultGetNasBackupPlans.applyValue(getNasBackupPlansResult -> getNasBackupPlansResult.plans()[0].createTime()))
.targetPath("/")
.options("""
{"includes":[], "excludes":[]}
""")
.build());
var ossJob = new RestoreJob("ossJob", RestoreJobArgs.builder()
.snapshotHash(ossSnapshots.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].snapshotHash()))
.vaultId(defaultGetOssBackupPlans.applyValue(getOssBackupPlansResult -> getOssBackupPlansResult.plans()[0].vaultId()))
.sourceType("OSS")
.restoreType("OSS")
.snapshotId(ossSnapshots.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].snapshotId()))
.targetBucket(defaultGetOssBackupPlans.applyValue(getOssBackupPlansResult -> getOssBackupPlansResult.plans()[0].bucket()))
.targetPrefix("")
.options("""
{"includes":[], "excludes":[]}
""")
.build());
var ecsJob = new RestoreJob("ecsJob", RestoreJobArgs.builder()
.snapshotHash(ecsSnapshots.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].snapshotHash()))
.vaultId(default_.plans()[0].vaultId())
.sourceType("ECS_FILE")
.restoreType("ECS_FILE")
.snapshotId(ecsSnapshots.applyValue(getSnapshotsResult -> getSnapshotsResult.snapshots()[0].snapshotId()))
.targetInstanceId(default_.plans()[0].instanceId())
.targetPath("/")
.build());
}
}
resources:
nasJob:
type: alicloud:hbr:RestoreJob
properties:
snapshotHash: ${nasSnapshots.snapshots[0].snapshotHash}
vaultId: ${defaultGetNasBackupPlans.plans[0].vaultId}
sourceType: NAS
restoreType: NAS
snapshotId: ${nasSnapshots.snapshots[0].snapshotId}
targetFileSystemId: ${defaultGetNasBackupPlans.plans[0].fileSystemId}
targetCreateTime: ${defaultGetNasBackupPlans.plans[0].createTime}
targetPath: /
options: |2
{"includes":[], "excludes":[]}
ossJob:
type: alicloud:hbr:RestoreJob
properties:
snapshotHash: ${ossSnapshots.snapshots[0].snapshotHash}
vaultId: ${defaultGetOssBackupPlans.plans[0].vaultId}
sourceType: OSS
restoreType: OSS
snapshotId: ${ossSnapshots.snapshots[0].snapshotId}
targetBucket: ${defaultGetOssBackupPlans.plans[0].bucket}
targetPrefix:
options: |2
{"includes":[], "excludes":[]}
ecsJob:
type: alicloud:hbr:RestoreJob
properties:
snapshotHash: ${ecsSnapshots.snapshots[0].snapshotHash}
vaultId: ${default.plans[0].vaultId}
sourceType: ECS_FILE
restoreType: ECS_FILE
snapshotId: ${ecsSnapshots.snapshots[0].snapshotId}
targetInstanceId: ${default.plans[0].instanceId}
targetPath: /
variables:
default:
fn::invoke:
Function: alicloud:hbr:getEcsBackupPlans
Arguments:
nameRegex: plan-tf-used-dont-delete
defaultGetOssBackupPlans:
fn::invoke:
Function: alicloud:hbr:getOssBackupPlans
Arguments:
nameRegex: plan-tf-used-dont-delete
defaultGetNasBackupPlans:
fn::invoke:
Function: alicloud:hbr:getNasBackupPlans
Arguments:
nameRegex: plan-tf-used-dont-delete
ecsSnapshots:
fn::invoke:
Function: alicloud:hbr:getSnapshots
Arguments:
sourceType: ECS_FILE
vaultId: ${default.plans[0].vaultId}
instanceId: ${default.plans[0].instanceId}
ossSnapshots:
fn::invoke:
Function: alicloud:hbr:getSnapshots
Arguments:
sourceType: OSS
vaultId: ${defaultGetOssBackupPlans.plans[0].vaultId}
bucket: ${defaultGetOssBackupPlans.plans[0].bucket}
nasSnapshots:
fn::invoke:
Function: alicloud:hbr:getSnapshots
Arguments:
sourceType: NAS
vaultId: ${defaultGetNasBackupPlans.plans[0].vaultId}
fileSystemId: ${defaultGetNasBackupPlans.plans[0].fileSystemId}
createTime: ${defaultGetNasBackupPlans.plans[0].createTime}
NOTE: This resource can only be created, cannot be modified or deleted. Therefore, any modification of the resource attribute will not affect exist resource.
Create RestoreJob Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new RestoreJob(name: string, args: RestoreJobArgs, opts?: CustomResourceOptions);
@overload
def RestoreJob(resource_name: str,
args: RestoreJobArgs,
opts: Optional[ResourceOptions] = None)
@overload
def RestoreJob(resource_name: str,
opts: Optional[ResourceOptions] = None,
restore_type: Optional[str] = None,
vault_id: Optional[str] = None,
source_type: Optional[str] = None,
snapshot_id: Optional[str] = None,
snapshot_hash: Optional[str] = None,
target_bucket: Optional[str] = None,
target_create_time: Optional[str] = None,
restore_job_id: Optional[str] = None,
options: Optional[str] = None,
include: Optional[str] = None,
exclude: Optional[str] = None,
cross_account_user_id: Optional[int] = None,
cross_account_role_name: Optional[str] = None,
target_client_id: Optional[str] = None,
ots_detail: Optional[RestoreJobOtsDetailArgs] = None,
target_data_source_id: Optional[str] = None,
target_file_system_id: Optional[str] = None,
target_instance_id: Optional[str] = None,
target_instance_name: Optional[str] = None,
target_path: Optional[str] = None,
target_prefix: Optional[str] = None,
target_table_name: Optional[str] = None,
target_time: Optional[str] = None,
udm_detail: Optional[str] = None,
cross_account_type: Optional[str] = None)
func NewRestoreJob(ctx *Context, name string, args RestoreJobArgs, opts ...ResourceOption) (*RestoreJob, error)
public RestoreJob(string name, RestoreJobArgs args, CustomResourceOptions? opts = null)
public RestoreJob(String name, RestoreJobArgs args)
public RestoreJob(String name, RestoreJobArgs args, CustomResourceOptions options)
type: alicloud:hbr:RestoreJob
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args RestoreJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args RestoreJobArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args RestoreJobArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args RestoreJobArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args RestoreJobArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var restoreJobResource = new AliCloud.Hbr.RestoreJob("restoreJobResource", new()
{
RestoreType = "string",
VaultId = "string",
SourceType = "string",
SnapshotId = "string",
SnapshotHash = "string",
TargetBucket = "string",
TargetCreateTime = "string",
RestoreJobId = "string",
Options = "string",
Include = "string",
Exclude = "string",
CrossAccountUserId = 0,
CrossAccountRoleName = "string",
TargetClientId = "string",
OtsDetail = new AliCloud.Hbr.Inputs.RestoreJobOtsDetailArgs
{
OverwriteExisting = false,
},
TargetDataSourceId = "string",
TargetFileSystemId = "string",
TargetInstanceId = "string",
TargetInstanceName = "string",
TargetPath = "string",
TargetPrefix = "string",
TargetTableName = "string",
TargetTime = "string",
UdmDetail = "string",
CrossAccountType = "string",
});
example, err := hbr.NewRestoreJob(ctx, "restoreJobResource", &hbr.RestoreJobArgs{
RestoreType: pulumi.String("string"),
VaultId: pulumi.String("string"),
SourceType: pulumi.String("string"),
SnapshotId: pulumi.String("string"),
SnapshotHash: pulumi.String("string"),
TargetBucket: pulumi.String("string"),
TargetCreateTime: pulumi.String("string"),
RestoreJobId: pulumi.String("string"),
Options: pulumi.String("string"),
Include: pulumi.String("string"),
Exclude: pulumi.String("string"),
CrossAccountUserId: pulumi.Int(0),
CrossAccountRoleName: pulumi.String("string"),
TargetClientId: pulumi.String("string"),
OtsDetail: &hbr.RestoreJobOtsDetailArgs{
OverwriteExisting: pulumi.Bool(false),
},
TargetDataSourceId: pulumi.String("string"),
TargetFileSystemId: pulumi.String("string"),
TargetInstanceId: pulumi.String("string"),
TargetInstanceName: pulumi.String("string"),
TargetPath: pulumi.String("string"),
TargetPrefix: pulumi.String("string"),
TargetTableName: pulumi.String("string"),
TargetTime: pulumi.String("string"),
UdmDetail: pulumi.String("string"),
CrossAccountType: pulumi.String("string"),
})
var restoreJobResource = new RestoreJob("restoreJobResource", RestoreJobArgs.builder()
.restoreType("string")
.vaultId("string")
.sourceType("string")
.snapshotId("string")
.snapshotHash("string")
.targetBucket("string")
.targetCreateTime("string")
.restoreJobId("string")
.options("string")
.include("string")
.exclude("string")
.crossAccountUserId(0)
.crossAccountRoleName("string")
.targetClientId("string")
.otsDetail(RestoreJobOtsDetailArgs.builder()
.overwriteExisting(false)
.build())
.targetDataSourceId("string")
.targetFileSystemId("string")
.targetInstanceId("string")
.targetInstanceName("string")
.targetPath("string")
.targetPrefix("string")
.targetTableName("string")
.targetTime("string")
.udmDetail("string")
.crossAccountType("string")
.build());
restore_job_resource = alicloud.hbr.RestoreJob("restoreJobResource",
restore_type="string",
vault_id="string",
source_type="string",
snapshot_id="string",
snapshot_hash="string",
target_bucket="string",
target_create_time="string",
restore_job_id="string",
options="string",
include="string",
exclude="string",
cross_account_user_id=0,
cross_account_role_name="string",
target_client_id="string",
ots_detail=alicloud.hbr.RestoreJobOtsDetailArgs(
overwrite_existing=False,
),
target_data_source_id="string",
target_file_system_id="string",
target_instance_id="string",
target_instance_name="string",
target_path="string",
target_prefix="string",
target_table_name="string",
target_time="string",
udm_detail="string",
cross_account_type="string")
const restoreJobResource = new alicloud.hbr.RestoreJob("restoreJobResource", {
restoreType: "string",
vaultId: "string",
sourceType: "string",
snapshotId: "string",
snapshotHash: "string",
targetBucket: "string",
targetCreateTime: "string",
restoreJobId: "string",
options: "string",
include: "string",
exclude: "string",
crossAccountUserId: 0,
crossAccountRoleName: "string",
targetClientId: "string",
otsDetail: {
overwriteExisting: false,
},
targetDataSourceId: "string",
targetFileSystemId: "string",
targetInstanceId: "string",
targetInstanceName: "string",
targetPath: "string",
targetPrefix: "string",
targetTableName: "string",
targetTime: "string",
udmDetail: "string",
crossAccountType: "string",
});
type: alicloud:hbr:RestoreJob
properties:
crossAccountRoleName: string
crossAccountType: string
crossAccountUserId: 0
exclude: string
include: string
options: string
otsDetail:
overwriteExisting: false
restoreJobId: string
restoreType: string
snapshotHash: string
snapshotId: string
sourceType: string
targetBucket: string
targetClientId: string
targetCreateTime: string
targetDataSourceId: string
targetFileSystemId: string
targetInstanceId: string
targetInstanceName: string
targetPath: string
targetPrefix: string
targetTableName: string
targetTime: string
udmDetail: string
vaultId: string
RestoreJob Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The RestoreJob resource accepts the following input properties:
- Restore
Type string - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - Snapshot
Hash string - The hashcode of Snapshot.
- Snapshot
Id string - The ID of Snapshot.
- Source
Type string - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - Vault
Id string - The ID of backup vault.
- Cross
Account stringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - Cross
Account intUser Id - The original account ID of the cross account backup managed by the current account.
- Exclude string
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Include string
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Options string
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - Ots
Detail Pulumi.Ali Cloud. Hbr. Inputs. Restore Job Ots Detail - The details about the Tablestore instance. See the following
Block ots_detail
. - Restore
Job stringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- Target
Bucket string - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - Target
Client stringId - The target client ID.
- Target
Create stringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - Target
Data stringSource Id - The target data source ID.
- Target
File stringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- Target
Instance stringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- Target
Instance stringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - Target
Path string - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Prefix string - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Table stringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - Target
Time string - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - Udm
Detail string - The full machine backup details.
- Restore
Type string - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - Snapshot
Hash string - The hashcode of Snapshot.
- Snapshot
Id string - The ID of Snapshot.
- Source
Type string - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - Vault
Id string - The ID of backup vault.
- Cross
Account stringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - Cross
Account intUser Id - The original account ID of the cross account backup managed by the current account.
- Exclude string
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Include string
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Options string
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - Ots
Detail RestoreJob Ots Detail Args - The details about the Tablestore instance. See the following
Block ots_detail
. - Restore
Job stringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- Target
Bucket string - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - Target
Client stringId - The target client ID.
- Target
Create stringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - Target
Data stringSource Id - The target data source ID.
- Target
File stringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- Target
Instance stringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- Target
Instance stringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - Target
Path string - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Prefix string - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Table stringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - Target
Time string - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - Udm
Detail string - The full machine backup details.
- restore
Type String - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot
Hash String - The hashcode of Snapshot.
- snapshot
Id String - The ID of Snapshot.
- source
Type String - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - vault
Id String - The ID of backup vault.
- cross
Account StringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross
Account IntegerUser Id - The original account ID of the cross account backup managed by the current account.
- exclude String
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include String
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options String
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots
Detail RestoreJob Ots Detail - The details about the Tablestore instance. See the following
Block ots_detail
. - restore
Job StringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- target
Bucket String - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target
Client StringId - The target client ID.
- target
Create StringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target
Data StringSource Id - The target data source ID.
- target
File StringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target
Instance StringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target
Instance StringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target
Path String - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Prefix String - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Table StringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target
Time String - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm
Detail String - The full machine backup details.
- restore
Type string - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot
Hash string - The hashcode of Snapshot.
- snapshot
Id string - The ID of Snapshot.
- source
Type string - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - vault
Id string - The ID of backup vault.
- cross
Account stringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account stringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross
Account numberUser Id - The original account ID of the cross account backup managed by the current account.
- exclude string
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include string
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options string
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots
Detail RestoreJob Ots Detail - The details about the Tablestore instance. See the following
Block ots_detail
. - restore
Job stringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- target
Bucket string - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target
Client stringId - The target client ID.
- target
Create stringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target
Data stringSource Id - The target data source ID.
- target
File stringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target
Instance stringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target
Instance stringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target
Path string - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Prefix string - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Table stringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target
Time string - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm
Detail string - The full machine backup details.
- restore_
type str - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot_
hash str - The hashcode of Snapshot.
- snapshot_
id str - The ID of Snapshot.
- source_
type str - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - vault_
id str - The ID of backup vault.
- cross_
account_ strrole_ name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross_
account_ strtype - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross_
account_ intuser_ id - The original account ID of the cross account backup managed by the current account.
- exclude str
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include str
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options str
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots_
detail RestoreJob Ots Detail Args - The details about the Tablestore instance. See the following
Block ots_detail
. - restore_
job_ strid - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- target_
bucket str - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target_
client_ strid - The target client ID.
- target_
create_ strtime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target_
data_ strsource_ id - The target data source ID.
- target_
file_ strsystem_ id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target_
instance_ strid - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target_
instance_ strname - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target_
path str - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target_
prefix str - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target_
table_ strname - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target_
time str - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm_
detail str - The full machine backup details.
- restore
Type String - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot
Hash String - The hashcode of Snapshot.
- snapshot
Id String - The ID of Snapshot.
- source
Type String - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - vault
Id String - The ID of backup vault.
- cross
Account StringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross
Account NumberUser Id - The original account ID of the cross account backup managed by the current account.
- exclude String
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include String
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options String
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots
Detail Property Map - The details about the Tablestore instance. See the following
Block ots_detail
. - restore
Job StringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- target
Bucket String - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target
Client StringId - The target client ID.
- target
Create StringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target
Data StringSource Id - The target data source ID.
- target
File StringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target
Instance StringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target
Instance StringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target
Path String - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Prefix String - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Table StringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target
Time String - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm
Detail String - The full machine backup details.
Outputs
All input properties are implicitly available as output properties. Additionally, the RestoreJob resource produces the following output properties:
Look up Existing RestoreJob Resource
Get an existing RestoreJob resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: RestoreJobState, opts?: CustomResourceOptions): RestoreJob
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cross_account_role_name: Optional[str] = None,
cross_account_type: Optional[str] = None,
cross_account_user_id: Optional[int] = None,
exclude: Optional[str] = None,
include: Optional[str] = None,
options: Optional[str] = None,
ots_detail: Optional[RestoreJobOtsDetailArgs] = None,
restore_job_id: Optional[str] = None,
restore_type: Optional[str] = None,
snapshot_hash: Optional[str] = None,
snapshot_id: Optional[str] = None,
source_type: Optional[str] = None,
status: Optional[str] = None,
target_bucket: Optional[str] = None,
target_client_id: Optional[str] = None,
target_create_time: Optional[str] = None,
target_data_source_id: Optional[str] = None,
target_file_system_id: Optional[str] = None,
target_instance_id: Optional[str] = None,
target_instance_name: Optional[str] = None,
target_path: Optional[str] = None,
target_prefix: Optional[str] = None,
target_table_name: Optional[str] = None,
target_time: Optional[str] = None,
udm_detail: Optional[str] = None,
vault_id: Optional[str] = None) -> RestoreJob
func GetRestoreJob(ctx *Context, name string, id IDInput, state *RestoreJobState, opts ...ResourceOption) (*RestoreJob, error)
public static RestoreJob Get(string name, Input<string> id, RestoreJobState? state, CustomResourceOptions? opts = null)
public static RestoreJob get(String name, Output<String> id, RestoreJobState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cross
Account stringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - Cross
Account intUser Id - The original account ID of the cross account backup managed by the current account.
- Exclude string
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Include string
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Options string
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - Ots
Detail Pulumi.Ali Cloud. Hbr. Inputs. Restore Job Ots Detail - The details about the Tablestore instance. See the following
Block ots_detail
. - Restore
Job stringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- Restore
Type string - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - Snapshot
Hash string - The hashcode of Snapshot.
- Snapshot
Id string - The ID of Snapshot.
- Source
Type string - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - Status string
- The Restore Job Status.
- Target
Bucket string - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - Target
Client stringId - The target client ID.
- Target
Create stringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - Target
Data stringSource Id - The target data source ID.
- Target
File stringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- Target
Instance stringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- Target
Instance stringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - Target
Path string - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Prefix string - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Table stringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - Target
Time string - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - Udm
Detail string - The full machine backup details.
- Vault
Id string - The ID of backup vault.
- Cross
Account stringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- Cross
Account stringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - Cross
Account intUser Id - The original account ID of the cross account backup managed by the current account.
- Exclude string
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Include string
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Options string
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - Ots
Detail RestoreJob Ots Detail Args - The details about the Tablestore instance. See the following
Block ots_detail
. - Restore
Job stringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- Restore
Type string - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - Snapshot
Hash string - The hashcode of Snapshot.
- Snapshot
Id string - The ID of Snapshot.
- Source
Type string - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - Status string
- The Restore Job Status.
- Target
Bucket string - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - Target
Client stringId - The target client ID.
- Target
Create stringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - Target
Data stringSource Id - The target data source ID.
- Target
File stringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- Target
Instance stringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- Target
Instance stringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - Target
Path string - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Prefix string - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - Target
Table stringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - Target
Time string - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - Udm
Detail string - The full machine backup details.
- Vault
Id string - The ID of backup vault.
- cross
Account StringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross
Account IntegerUser Id - The original account ID of the cross account backup managed by the current account.
- exclude String
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include String
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options String
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots
Detail RestoreJob Ots Detail - The details about the Tablestore instance. See the following
Block ots_detail
. - restore
Job StringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- restore
Type String - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot
Hash String - The hashcode of Snapshot.
- snapshot
Id String - The ID of Snapshot.
- source
Type String - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - status String
- The Restore Job Status.
- target
Bucket String - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target
Client StringId - The target client ID.
- target
Create StringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target
Data StringSource Id - The target data source ID.
- target
File StringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target
Instance StringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target
Instance StringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target
Path String - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Prefix String - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Table StringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target
Time String - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm
Detail String - The full machine backup details.
- vault
Id String - The ID of backup vault.
- cross
Account stringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account stringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross
Account numberUser Id - The original account ID of the cross account backup managed by the current account.
- exclude string
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include string
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options string
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots
Detail RestoreJob Ots Detail - The details about the Tablestore instance. See the following
Block ots_detail
. - restore
Job stringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- restore
Type string - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot
Hash string - The hashcode of Snapshot.
- snapshot
Id string - The ID of Snapshot.
- source
Type string - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - status string
- The Restore Job Status.
- target
Bucket string - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target
Client stringId - The target client ID.
- target
Create stringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target
Data stringSource Id - The target data source ID.
- target
File stringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target
Instance stringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target
Instance stringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target
Path string - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Prefix string - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Table stringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target
Time string - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm
Detail string - The full machine backup details.
- vault
Id string - The ID of backup vault.
- cross_
account_ strrole_ name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross_
account_ strtype - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross_
account_ intuser_ id - The original account ID of the cross account backup managed by the current account.
- exclude str
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include str
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options str
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots_
detail RestoreJob Ots Detail Args - The details about the Tablestore instance. See the following
Block ots_detail
. - restore_
job_ strid - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- restore_
type str - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot_
hash str - The hashcode of Snapshot.
- snapshot_
id str - The ID of Snapshot.
- source_
type str - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - status str
- The Restore Job Status.
- target_
bucket str - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target_
client_ strid - The target client ID.
- target_
create_ strtime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target_
data_ strsource_ id - The target data source ID.
- target_
file_ strsystem_ id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target_
instance_ strid - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target_
instance_ strname - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target_
path str - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target_
prefix str - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target_
table_ strname - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target_
time str - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm_
detail str - The full machine backup details.
- vault_
id str - The ID of backup vault.
- cross
Account StringRole Name - The role name created in the original account RAM backup by the cross account managed by the current account.
- cross
Account StringType - The type of the cross account backup. Valid values:
SELF_ACCOUNT
,CROSS_ACCOUNT
. - cross
Account NumberUser Id - The original account ID of the cross account backup managed by the current account.
- exclude String
- The exclude path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/excludePath]
, up to 255 characters. WARNING: If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - include String
- The include path. NOTE: Invalid while source_type equals
OSS
orNAS
. It's a json string with format:["/includePath"]
, Up to 255 characters. WARNING: The field is required while source_type equalsOTS_TABLE
which means source table name. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - options String
- Recovery options. NOTE: Required while source_type equals
OSS
orNAS
, invalid while source_type equalsECS_FILE
. It's a json string with format:"{"includes":[],"excludes":[]}",
. Recovery options. When restores OTS_TABLE and real target time is the rangEnd time of the snapshot, it should be a string with format:{"UI_TargetTime":1650032529018}
. - ots
Detail Property Map - The details about the Tablestore instance. See the following
Block ots_detail
. - restore
Job StringId - Restore Job ID. It's the unique key of this resource, if you want to set this argument by yourself, you must specify a unique keyword that never appears.
- restore
Type String - The type of recovery destination. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS_ROLLBACK
. Note: Currently, there is a one-to-one correspondence between the data source type with the recovery destination type. - snapshot
Hash String - The hashcode of Snapshot.
- snapshot
Id String - The ID of Snapshot.
- source
Type String - The type of data source. Valid values:
ECS_FILE
,NAS
,OSS
,OTS_TABLE
,UDM_ECS
. - status String
- The Restore Job Status.
- target
Bucket String - The target name of OSS bucket. NOTE: Required while source_type equals
OSS
, - target
Client StringId - The target client ID.
- target
Create StringTime - The creation time of destination File System. NOTE: While source_type equals
NAS
, this parameter must be set. Note: The time format of the API adopts the ISO 8601 format, such as2021-07-09T15:45:30CST
or2021-07-09T07:45:30Z
. - target
Data StringSource Id - The target data source ID.
- target
File StringSystem Id - The ID of destination File System. NOTE: Required while source_type equals
NAS
- target
Instance StringId - The target ID of ECS instance. NOTE: Required while source_type equals
ECS_FILE
- target
Instance StringName - The name of the Table store instance to which you want to restore data.WARNING: Required while source_type equals
OTS_TABLE
. - target
Path String - The target file path of (ECS) instance. WARNING: Required while source_type equals
NAS
orECS_FILE
, If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Prefix String - The target prefix of the OSS object. WARNING: Required while source_type equals
OSS
. If this value filled in incorrectly, the task may not start correctly, so please check the parameters before executing the plan. - target
Table StringName - The name of the table that stores the restored data. WARNING: Required while source_type equals
OTS_TABLE
. - target
Time String - The time when data is restored to the Table store instance. This value is a UNIX timestamp. Unit: seconds. WARNING: Required while source_type equals
OTS_TABLE
. Note: The time when data is restored to the Tablestore instance. It should be 0 if restores data at the End time of the snapshot. - udm
Detail String - The full machine backup details.
- vault
Id String - The ID of backup vault.
Supporting Types
RestoreJobOtsDetail, RestoreJobOtsDetailArgs
- Overwrite
Existing bool
- Overwrite
Existing bool
- overwrite
Existing Boolean
- overwrite
Existing boolean
- overwrite_
existing bool
- overwrite
Existing Boolean
Import
Hybrid Backup Recovery (HBR) Restore Job can be imported using the id. Format to <restore_job_id>:<restore_type>
, e.g.
$ pulumi import alicloud:hbr/restoreJob:RestoreJob example your_restore_job_id:your_restore_type
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Alibaba Cloud pulumi/pulumi-alicloud
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
alicloud
Terraform Provider.