1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. hbr
  5. HanaBackupPlan
Alibaba Cloud v3.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

alicloud.hbr.HanaBackupPlan

Explore with Pulumi AI

Provides a Hybrid Backup Recovery (HBR) Hana Backup Plan resource.

For information about Hybrid Backup Recovery (HBR) Hana Backup Plan and how to use it, see What is Hana Backup Plan.

NOTE: Available in v1.179.0+.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";
import * as random from "@pulumi/random";

const example = alicloud.resourcemanager.getResourceGroups({
    status: "OK",
});
const _default = new random.index.Integer("default", {
    min: 10000,
    max: 99999,
});
const exampleVault = new alicloud.hbr.Vault("example", {vaultName: `terraform-example-${_default.result}`});
const exampleHanaInstance = new alicloud.hbr.HanaInstance("example", {
    alertSetting: "INHERITED",
    hanaName: `terraform-example-${_default.result}`,
    host: "1.1.1.1",
    instanceNumber: 1,
    password: "YouPassword123",
    resourceGroupId: example.then(example => example.groups?.[0]?.id),
    sid: "HXE",
    useSsl: false,
    userName: "admin",
    validateCertificate: false,
    vaultId: exampleVault.id,
});
const exampleHanaBackupPlan = new alicloud.hbr.HanaBackupPlan("example", {
    backupPrefix: "DIFF_DATA_BACKUP",
    backupType: "COMPLETE",
    clusterId: exampleHanaInstance.hanaInstanceId,
    databaseName: "SYSTEMDB",
    planName: "terraform-example",
    resourceGroupId: example.then(example => example.groups?.[0]?.id),
    schedule: "I|1602673264|P1D",
    vaultId: exampleHanaInstance.vaultId,
});
Copy
import pulumi
import pulumi_alicloud as alicloud
import pulumi_random as random

example = alicloud.resourcemanager.get_resource_groups(status="OK")
default = random.index.Integer("default",
    min=10000,
    max=99999)
example_vault = alicloud.hbr.Vault("example", vault_name=f"terraform-example-{default['result']}")
example_hana_instance = alicloud.hbr.HanaInstance("example",
    alert_setting="INHERITED",
    hana_name=f"terraform-example-{default['result']}",
    host="1.1.1.1",
    instance_number=1,
    password="YouPassword123",
    resource_group_id=example.groups[0].id,
    sid="HXE",
    use_ssl=False,
    user_name="admin",
    validate_certificate=False,
    vault_id=example_vault.id)
example_hana_backup_plan = alicloud.hbr.HanaBackupPlan("example",
    backup_prefix="DIFF_DATA_BACKUP",
    backup_type="COMPLETE",
    cluster_id=example_hana_instance.hana_instance_id,
    database_name="SYSTEMDB",
    plan_name="terraform-example",
    resource_group_id=example.groups[0].id,
    schedule="I|1602673264|P1D",
    vault_id=example_hana_instance.vault_id)
Copy
package main

import (
	"fmt"

	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/hbr"
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/resourcemanager"
	"github.com/pulumi/pulumi-random/sdk/v4/go/random"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := resourcemanager.GetResourceGroups(ctx, &resourcemanager.GetResourceGroupsArgs{
			Status: pulumi.StringRef("OK"),
		}, nil)
		if err != nil {
			return err
		}
		_default, err := random.NewInteger(ctx, "default", &random.IntegerArgs{
			Min: 10000,
			Max: 99999,
		})
		if err != nil {
			return err
		}
		exampleVault, err := hbr.NewVault(ctx, "example", &hbr.VaultArgs{
			VaultName: pulumi.Sprintf("terraform-example-%v", _default.Result),
		})
		if err != nil {
			return err
		}
		exampleHanaInstance, err := hbr.NewHanaInstance(ctx, "example", &hbr.HanaInstanceArgs{
			AlertSetting:        pulumi.String("INHERITED"),
			HanaName:            pulumi.Sprintf("terraform-example-%v", _default.Result),
			Host:                pulumi.String("1.1.1.1"),
			InstanceNumber:      pulumi.Int(1),
			Password:            pulumi.String("YouPassword123"),
			ResourceGroupId:     pulumi.String(example.Groups[0].Id),
			Sid:                 pulumi.String("HXE"),
			UseSsl:              pulumi.Bool(false),
			UserName:            pulumi.String("admin"),
			ValidateCertificate: pulumi.Bool(false),
			VaultId:             exampleVault.ID(),
		})
		if err != nil {
			return err
		}
		_, err = hbr.NewHanaBackupPlan(ctx, "example", &hbr.HanaBackupPlanArgs{
			BackupPrefix:    pulumi.String("DIFF_DATA_BACKUP"),
			BackupType:      pulumi.String("COMPLETE"),
			ClusterId:       exampleHanaInstance.HanaInstanceId,
			DatabaseName:    pulumi.String("SYSTEMDB"),
			PlanName:        pulumi.String("terraform-example"),
			ResourceGroupId: pulumi.String(example.Groups[0].Id),
			Schedule:        pulumi.String("I|1602673264|P1D"),
			VaultId:         exampleHanaInstance.VaultId,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;
using Random = Pulumi.Random;

return await Deployment.RunAsync(() => 
{
    var example = AliCloud.ResourceManager.GetResourceGroups.Invoke(new()
    {
        Status = "OK",
    });

    var @default = new Random.Index.Integer("default", new()
    {
        Min = 10000,
        Max = 99999,
    });

    var exampleVault = new AliCloud.Hbr.Vault("example", new()
    {
        VaultName = $"terraform-example-{@default.Result}",
    });

    var exampleHanaInstance = new AliCloud.Hbr.HanaInstance("example", new()
    {
        AlertSetting = "INHERITED",
        HanaName = $"terraform-example-{@default.Result}",
        Host = "1.1.1.1",
        InstanceNumber = 1,
        Password = "YouPassword123",
        ResourceGroupId = example.Apply(getResourceGroupsResult => getResourceGroupsResult.Groups[0]?.Id),
        Sid = "HXE",
        UseSsl = false,
        UserName = "admin",
        ValidateCertificate = false,
        VaultId = exampleVault.Id,
    });

    var exampleHanaBackupPlan = new AliCloud.Hbr.HanaBackupPlan("example", new()
    {
        BackupPrefix = "DIFF_DATA_BACKUP",
        BackupType = "COMPLETE",
        ClusterId = exampleHanaInstance.HanaInstanceId,
        DatabaseName = "SYSTEMDB",
        PlanName = "terraform-example",
        ResourceGroupId = example.Apply(getResourceGroupsResult => getResourceGroupsResult.Groups[0]?.Id),
        Schedule = "I|1602673264|P1D",
        VaultId = exampleHanaInstance.VaultId,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.resourcemanager.ResourcemanagerFunctions;
import com.pulumi.alicloud.resourcemanager.inputs.GetResourceGroupsArgs;
import com.pulumi.random.integer;
import com.pulumi.random.IntegerArgs;
import com.pulumi.alicloud.hbr.Vault;
import com.pulumi.alicloud.hbr.VaultArgs;
import com.pulumi.alicloud.hbr.HanaInstance;
import com.pulumi.alicloud.hbr.HanaInstanceArgs;
import com.pulumi.alicloud.hbr.HanaBackupPlan;
import com.pulumi.alicloud.hbr.HanaBackupPlanArgs;
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 example = ResourcemanagerFunctions.getResourceGroups(GetResourceGroupsArgs.builder()
            .status("OK")
            .build());

        var default_ = new Integer("default", IntegerArgs.builder()
            .min(10000)
            .max(99999)
            .build());

        var exampleVault = new Vault("exampleVault", VaultArgs.builder()
            .vaultName(String.format("terraform-example-%s", default_.result()))
            .build());

        var exampleHanaInstance = new HanaInstance("exampleHanaInstance", HanaInstanceArgs.builder()
            .alertSetting("INHERITED")
            .hanaName(String.format("terraform-example-%s", default_.result()))
            .host("1.1.1.1")
            .instanceNumber(1)
            .password("YouPassword123")
            .resourceGroupId(example.applyValue(getResourceGroupsResult -> getResourceGroupsResult.groups()[0].id()))
            .sid("HXE")
            .useSsl(false)
            .userName("admin")
            .validateCertificate(false)
            .vaultId(exampleVault.id())
            .build());

        var exampleHanaBackupPlan = new HanaBackupPlan("exampleHanaBackupPlan", HanaBackupPlanArgs.builder()
            .backupPrefix("DIFF_DATA_BACKUP")
            .backupType("COMPLETE")
            .clusterId(exampleHanaInstance.hanaInstanceId())
            .databaseName("SYSTEMDB")
            .planName("terraform-example")
            .resourceGroupId(example.applyValue(getResourceGroupsResult -> getResourceGroupsResult.groups()[0].id()))
            .schedule("I|1602673264|P1D")
            .vaultId(exampleHanaInstance.vaultId())
            .build());

    }
}
Copy
resources:
  default:
    type: random:integer
    properties:
      min: 10000
      max: 99999
  exampleVault:
    type: alicloud:hbr:Vault
    name: example
    properties:
      vaultName: terraform-example-${default.result}
  exampleHanaInstance:
    type: alicloud:hbr:HanaInstance
    name: example
    properties:
      alertSetting: INHERITED
      hanaName: terraform-example-${default.result}
      host: 1.1.1.1
      instanceNumber: 1
      password: YouPassword123
      resourceGroupId: ${example.groups[0].id}
      sid: HXE
      useSsl: false
      userName: admin
      validateCertificate: false
      vaultId: ${exampleVault.id}
  exampleHanaBackupPlan:
    type: alicloud:hbr:HanaBackupPlan
    name: example
    properties:
      backupPrefix: DIFF_DATA_BACKUP
      backupType: COMPLETE
      clusterId: ${exampleHanaInstance.hanaInstanceId}
      databaseName: SYSTEMDB
      planName: terraform-example
      resourceGroupId: ${example.groups[0].id}
      schedule: I|1602673264|P1D
      vaultId: ${exampleHanaInstance.vaultId}
variables:
  example:
    fn::invoke:
      function: alicloud:resourcemanager:getResourceGroups
      arguments:
        status: OK
Copy

Create HanaBackupPlan Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HanaBackupPlan(name: string, args: HanaBackupPlanArgs, opts?: CustomResourceOptions);
@overload
def HanaBackupPlan(resource_name: str,
                   args: HanaBackupPlanArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def HanaBackupPlan(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   backup_type: Optional[str] = None,
                   cluster_id: Optional[str] = None,
                   database_name: Optional[str] = None,
                   plan_name: Optional[str] = None,
                   schedule: Optional[str] = None,
                   vault_id: Optional[str] = None,
                   backup_prefix: Optional[str] = None,
                   resource_group_id: Optional[str] = None,
                   status: Optional[str] = None)
func NewHanaBackupPlan(ctx *Context, name string, args HanaBackupPlanArgs, opts ...ResourceOption) (*HanaBackupPlan, error)
public HanaBackupPlan(string name, HanaBackupPlanArgs args, CustomResourceOptions? opts = null)
public HanaBackupPlan(String name, HanaBackupPlanArgs args)
public HanaBackupPlan(String name, HanaBackupPlanArgs args, CustomResourceOptions options)
type: alicloud:hbr:HanaBackupPlan
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HanaBackupPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. HanaBackupPlanArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. HanaBackupPlanArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HanaBackupPlanArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HanaBackupPlanArgs
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 hanaBackupPlanResource = new AliCloud.Hbr.HanaBackupPlan("hanaBackupPlanResource", new()
{
    BackupType = "string",
    ClusterId = "string",
    DatabaseName = "string",
    PlanName = "string",
    Schedule = "string",
    VaultId = "string",
    BackupPrefix = "string",
    ResourceGroupId = "string",
    Status = "string",
});
Copy
example, err := hbr.NewHanaBackupPlan(ctx, "hanaBackupPlanResource", &hbr.HanaBackupPlanArgs{
	BackupType:      pulumi.String("string"),
	ClusterId:       pulumi.String("string"),
	DatabaseName:    pulumi.String("string"),
	PlanName:        pulumi.String("string"),
	Schedule:        pulumi.String("string"),
	VaultId:         pulumi.String("string"),
	BackupPrefix:    pulumi.String("string"),
	ResourceGroupId: pulumi.String("string"),
	Status:          pulumi.String("string"),
})
Copy
var hanaBackupPlanResource = new HanaBackupPlan("hanaBackupPlanResource", HanaBackupPlanArgs.builder()
    .backupType("string")
    .clusterId("string")
    .databaseName("string")
    .planName("string")
    .schedule("string")
    .vaultId("string")
    .backupPrefix("string")
    .resourceGroupId("string")
    .status("string")
    .build());
Copy
hana_backup_plan_resource = alicloud.hbr.HanaBackupPlan("hanaBackupPlanResource",
    backup_type="string",
    cluster_id="string",
    database_name="string",
    plan_name="string",
    schedule="string",
    vault_id="string",
    backup_prefix="string",
    resource_group_id="string",
    status="string")
Copy
const hanaBackupPlanResource = new alicloud.hbr.HanaBackupPlan("hanaBackupPlanResource", {
    backupType: "string",
    clusterId: "string",
    databaseName: "string",
    planName: "string",
    schedule: "string",
    vaultId: "string",
    backupPrefix: "string",
    resourceGroupId: "string",
    status: "string",
});
Copy
type: alicloud:hbr:HanaBackupPlan
properties:
    backupPrefix: string
    backupType: string
    clusterId: string
    databaseName: string
    planName: string
    resourceGroupId: string
    schedule: string
    status: string
    vaultId: string
Copy

HanaBackupPlan Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The HanaBackupPlan resource accepts the following input properties:

BackupType
This property is required.
Changes to this property will trigger replacement.
string
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SAP HANA instance.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
PlanName This property is required. string
The name of the backup plan.
Schedule This property is required. string
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
VaultId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the backup vault.
BackupPrefix string
The backup prefix.
ResourceGroupId string
The resource attribute field that represents the resource group ID.
Status string
The status of the resource. Valid values: Enabled, Disabled.
BackupType
This property is required.
Changes to this property will trigger replacement.
string
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SAP HANA instance.
DatabaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
PlanName This property is required. string
The name of the backup plan.
Schedule This property is required. string
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
VaultId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the backup vault.
BackupPrefix string
The backup prefix.
ResourceGroupId string
The resource attribute field that represents the resource group ID.
Status string
The status of the resource. Valid values: Enabled, Disabled.
backupType
This property is required.
Changes to this property will trigger replacement.
String
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SAP HANA instance.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
planName This property is required. String
The name of the backup plan.
schedule This property is required. String
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
vaultId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the backup vault.
backupPrefix String
The backup prefix.
resourceGroupId String
The resource attribute field that represents the resource group ID.
status String
The status of the resource. Valid values: Enabled, Disabled.
backupType
This property is required.
Changes to this property will trigger replacement.
string
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
clusterId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the SAP HANA instance.
databaseName
This property is required.
Changes to this property will trigger replacement.
string
The name of the database.
planName This property is required. string
The name of the backup plan.
schedule This property is required. string
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
vaultId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the backup vault.
backupPrefix string
The backup prefix.
resourceGroupId string
The resource attribute field that represents the resource group ID.
status string
The status of the resource. Valid values: Enabled, Disabled.
backup_type
This property is required.
Changes to this property will trigger replacement.
str
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the SAP HANA instance.
database_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the database.
plan_name This property is required. str
The name of the backup plan.
schedule This property is required. str
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
vault_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the backup vault.
backup_prefix str
The backup prefix.
resource_group_id str
The resource attribute field that represents the resource group ID.
status str
The status of the resource. Valid values: Enabled, Disabled.
backupType
This property is required.
Changes to this property will trigger replacement.
String
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
clusterId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the SAP HANA instance.
databaseName
This property is required.
Changes to this property will trigger replacement.
String
The name of the database.
planName This property is required. String
The name of the backup plan.
schedule This property is required. String
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
vaultId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the backup vault.
backupPrefix String
The backup prefix.
resourceGroupId String
The resource attribute field that represents the resource group ID.
status String
The status of the resource. Valid values: Enabled, Disabled.

Outputs

All input properties are implicitly available as output properties. Additionally, the HanaBackupPlan resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
PlanId string
The id of the plan.
Id string
The provider-assigned unique ID for this managed resource.
PlanId string
The id of the plan.
id String
The provider-assigned unique ID for this managed resource.
planId String
The id of the plan.
id string
The provider-assigned unique ID for this managed resource.
planId string
The id of the plan.
id str
The provider-assigned unique ID for this managed resource.
plan_id str
The id of the plan.
id String
The provider-assigned unique ID for this managed resource.
planId String
The id of the plan.

Look up Existing HanaBackupPlan Resource

Get an existing HanaBackupPlan 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?: HanaBackupPlanState, opts?: CustomResourceOptions): HanaBackupPlan
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        backup_prefix: Optional[str] = None,
        backup_type: Optional[str] = None,
        cluster_id: Optional[str] = None,
        database_name: Optional[str] = None,
        plan_id: Optional[str] = None,
        plan_name: Optional[str] = None,
        resource_group_id: Optional[str] = None,
        schedule: Optional[str] = None,
        status: Optional[str] = None,
        vault_id: Optional[str] = None) -> HanaBackupPlan
func GetHanaBackupPlan(ctx *Context, name string, id IDInput, state *HanaBackupPlanState, opts ...ResourceOption) (*HanaBackupPlan, error)
public static HanaBackupPlan Get(string name, Input<string> id, HanaBackupPlanState? state, CustomResourceOptions? opts = null)
public static HanaBackupPlan get(String name, Output<String> id, HanaBackupPlanState state, CustomResourceOptions options)
resources:  _:    type: alicloud:hbr:HanaBackupPlan    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
BackupPrefix string
The backup prefix.
BackupType Changes to this property will trigger replacement. string
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
ClusterId Changes to this property will trigger replacement. string
The ID of the SAP HANA instance.
DatabaseName Changes to this property will trigger replacement. string
The name of the database.
PlanId string
The id of the plan.
PlanName string
The name of the backup plan.
ResourceGroupId string
The resource attribute field that represents the resource group ID.
Schedule string
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
Status string
The status of the resource. Valid values: Enabled, Disabled.
VaultId Changes to this property will trigger replacement. string
The ID of the backup vault.
BackupPrefix string
The backup prefix.
BackupType Changes to this property will trigger replacement. string
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
ClusterId Changes to this property will trigger replacement. string
The ID of the SAP HANA instance.
DatabaseName Changes to this property will trigger replacement. string
The name of the database.
PlanId string
The id of the plan.
PlanName string
The name of the backup plan.
ResourceGroupId string
The resource attribute field that represents the resource group ID.
Schedule string
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
Status string
The status of the resource. Valid values: Enabled, Disabled.
VaultId Changes to this property will trigger replacement. string
The ID of the backup vault.
backupPrefix String
The backup prefix.
backupType Changes to this property will trigger replacement. String
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
clusterId Changes to this property will trigger replacement. String
The ID of the SAP HANA instance.
databaseName Changes to this property will trigger replacement. String
The name of the database.
planId String
The id of the plan.
planName String
The name of the backup plan.
resourceGroupId String
The resource attribute field that represents the resource group ID.
schedule String
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
status String
The status of the resource. Valid values: Enabled, Disabled.
vaultId Changes to this property will trigger replacement. String
The ID of the backup vault.
backupPrefix string
The backup prefix.
backupType Changes to this property will trigger replacement. string
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
clusterId Changes to this property will trigger replacement. string
The ID of the SAP HANA instance.
databaseName Changes to this property will trigger replacement. string
The name of the database.
planId string
The id of the plan.
planName string
The name of the backup plan.
resourceGroupId string
The resource attribute field that represents the resource group ID.
schedule string
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
status string
The status of the resource. Valid values: Enabled, Disabled.
vaultId Changes to this property will trigger replacement. string
The ID of the backup vault.
backup_prefix str
The backup prefix.
backup_type Changes to this property will trigger replacement. str
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
cluster_id Changes to this property will trigger replacement. str
The ID of the SAP HANA instance.
database_name Changes to this property will trigger replacement. str
The name of the database.
plan_id str
The id of the plan.
plan_name str
The name of the backup plan.
resource_group_id str
The resource attribute field that represents the resource group ID.
schedule str
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
status str
The status of the resource. Valid values: Enabled, Disabled.
vault_id Changes to this property will trigger replacement. str
The ID of the backup vault.
backupPrefix String
The backup prefix.
backupType Changes to this property will trigger replacement. String
The backup type. Valid values:

  • COMPLETE: full backup.
  • INCREMENTAL: incremental backup.
  • DIFFERENTIAL: differential backup.
clusterId Changes to this property will trigger replacement. String
The ID of the SAP HANA instance.
databaseName Changes to this property will trigger replacement. String
The name of the database.
planId String
The id of the plan.
planName String
The name of the backup plan.
resourceGroupId String
The resource attribute field that represents the resource group ID.
schedule String
The backup policy. Format: I|{startTime}|{interval}. The system runs the first backup job at a point in time that is specified in the {startTime} parameter and the subsequent backup jobs at an interval that is specified in the {interval} parameter. The system does not run a backup job before the specified point in time. Each backup job, except the first one, starts only after the previous backup job is completed. For example, I|1631685600|P1D specifies that the system runs the first backup job at 14:00:00 on September 15, 2021 and the subsequent backup jobs once a day.
status String
The status of the resource. Valid values: Enabled, Disabled.
vaultId Changes to this property will trigger replacement. String
The ID of the backup vault.

Import

Hybrid Backup Recovery (HBR) Hana Backup Plan can be imported using the id, e.g.

$ pulumi import alicloud:hbr/hanaBackupPlan:HanaBackupPlan example <plan_id>:<vault_id>:<cluster_id>
Copy

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.