Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Ibm Provider
  3. API Docs
  4. getDatabaseBackup
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

ibm.getDatabaseBackup

Explore with Pulumi AI

ibm logo
ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
ibm-cloud/terraform-provider-ibm

    Provides a read-only data source for Backup. You can then reference the fields of the data source in other resources within the same configuration using interpolation syntax.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";

const databaseBackup = ibm.getDatabaseBackup({
    backupId: "<backup_crn>",
});

    import pulumi
import pulumi_ibm as ibm

database_backup = ibm.get_database_backup(backup_id="<backup_crn>")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ibm.GetDatabaseBackup(ctx, &ibm.GetDatabaseBackupArgs{
			BackupId: "<backup_crn>",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;

return await Deployment.RunAsync(() => 
{
    var databaseBackup = Ibm.GetDatabaseBackup.Invoke(new()
    {
        BackupId = "<backup_crn>",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.IbmFunctions;
import com.pulumi.ibm.inputs.GetDatabaseBackupArgs;
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 databaseBackup = IbmFunctions.getDatabaseBackup(GetDatabaseBackupArgs.builder()
            .backupId("<backup_crn>")
            .build());

    }
}

    variables:
  databaseBackup:
    fn::invoke:
      function: ibm:getDatabaseBackup
      arguments:
        backupId: <backup_crn>

    Using getDatabaseBackup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabaseBackup(args: GetDatabaseBackupArgs, opts?: InvokeOptions): Promise<GetDatabaseBackupResult>
function getDatabaseBackupOutput(args: GetDatabaseBackupOutputArgs, opts?: InvokeOptions): Output<GetDatabaseBackupResult>
    def get_database_backup(backup_id: Optional[str] = None,
                        id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetDatabaseBackupResult
def get_database_backup_output(backup_id: Optional[pulumi.Input[str]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseBackupResult]
    func GetDatabaseBackup(ctx *Context, args *GetDatabaseBackupArgs, opts ...InvokeOption) (*GetDatabaseBackupResult, error)
func GetDatabaseBackupOutput(ctx *Context, args *GetDatabaseBackupOutputArgs, opts ...InvokeOption) GetDatabaseBackupResultOutput

    > Note: This function is named GetDatabaseBackup in the Go SDK.

    public static class GetDatabaseBackup 
{
    public static Task<GetDatabaseBackupResult> InvokeAsync(GetDatabaseBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseBackupResult> Invoke(GetDatabaseBackupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseBackupResult> getDatabaseBackup(GetDatabaseBackupArgs args, InvokeOptions options)
public static Output<GetDatabaseBackupResult> getDatabaseBackup(GetDatabaseBackupArgs args, InvokeOptions options)

    fn::invoke:
  function: ibm:index/getDatabaseBackup:getDatabaseBackup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    BackupId string
    Backup ID.
    Id string
    BackupId string
    Backup ID.
    Id string
    backupId String
    Backup ID.
    id String
    backupId string
    Backup ID.
    id string
    backup_id str
    Backup ID.
    id str
    backupId String
    Backup ID.
    id String

    getDatabaseBackup Result

    The following output properties are available:

    BackupId string
    The unique identifier of the Backup.
    CreatedAt string
    (Optional, String) Date and time when this backup was created.
    DeploymentId string
    (Optional, String) ID of the deployment this backup relates to.
    DownloadLink string
    (Optional, String) URI which is currently available for file downloading.
    Id string
    IsDownloadable bool
    (Optional, Boolean) Is this backup available to download?.
    IsRestorable bool
    (Optional, Boolean) Can this backup be used to restore an instance?.
    Status string
    (Optional, String) The status of this backup.

    • Constraints: Allowable values are: running, completed, failed.
    Type string
    (Optional, String) The type of backup.

    • Constraints: Allowable values are: scheduled, on_demand.
    BackupId string
    The unique identifier of the Backup.
    CreatedAt string
    (Optional, String) Date and time when this backup was created.
    DeploymentId string
    (Optional, String) ID of the deployment this backup relates to.
    DownloadLink string
    (Optional, String) URI which is currently available for file downloading.
    Id string
    IsDownloadable bool
    (Optional, Boolean) Is this backup available to download?.
    IsRestorable bool
    (Optional, Boolean) Can this backup be used to restore an instance?.
    Status string
    (Optional, String) The status of this backup.

    • Constraints: Allowable values are: running, completed, failed.
    Type string
    (Optional, String) The type of backup.

    • Constraints: Allowable values are: scheduled, on_demand.
    backupId String
    The unique identifier of the Backup.
    createdAt String
    (Optional, String) Date and time when this backup was created.
    deploymentId String
    (Optional, String) ID of the deployment this backup relates to.
    downloadLink String
    (Optional, String) URI which is currently available for file downloading.
    id String
    isDownloadable Boolean
    (Optional, Boolean) Is this backup available to download?.
    isRestorable Boolean
    (Optional, Boolean) Can this backup be used to restore an instance?.
    status String
    (Optional, String) The status of this backup.

    • Constraints: Allowable values are: running, completed, failed.
    type String
    (Optional, String) The type of backup.

    • Constraints: Allowable values are: scheduled, on_demand.
    backupId string
    The unique identifier of the Backup.
    createdAt string
    (Optional, String) Date and time when this backup was created.
    deploymentId string
    (Optional, String) ID of the deployment this backup relates to.
    downloadLink string
    (Optional, String) URI which is currently available for file downloading.
    id string
    isDownloadable boolean
    (Optional, Boolean) Is this backup available to download?.
    isRestorable boolean
    (Optional, Boolean) Can this backup be used to restore an instance?.
    status string
    (Optional, String) The status of this backup.

    • Constraints: Allowable values are: running, completed, failed.
    type string
    (Optional, String) The type of backup.

    • Constraints: Allowable values are: scheduled, on_demand.
    backup_id str
    The unique identifier of the Backup.
    created_at str
    (Optional, String) Date and time when this backup was created.
    deployment_id str
    (Optional, String) ID of the deployment this backup relates to.
    download_link str
    (Optional, String) URI which is currently available for file downloading.
    id str
    is_downloadable bool
    (Optional, Boolean) Is this backup available to download?.
    is_restorable bool
    (Optional, Boolean) Can this backup be used to restore an instance?.
    status str
    (Optional, String) The status of this backup.

    • Constraints: Allowable values are: running, completed, failed.
    type str
    (Optional, String) The type of backup.

    • Constraints: Allowable values are: scheduled, on_demand.
    backupId String
    The unique identifier of the Backup.
    createdAt String
    (Optional, String) Date and time when this backup was created.
    deploymentId String
    (Optional, String) ID of the deployment this backup relates to.
    downloadLink String
    (Optional, String) URI which is currently available for file downloading.
    id String
    isDownloadable Boolean
    (Optional, Boolean) Is this backup available to download?.
    isRestorable Boolean
    (Optional, Boolean) Can this backup be used to restore an instance?.
    status String
    (Optional, String) The status of this backup.

    • Constraints: Allowable values are: running, completed, failed.
    type String
    (Optional, String) The type of backup.

    • Constraints: Allowable values are: scheduled, on_demand.

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.78.0 published on Wednesday, Apr 30, 2025 by ibm-cloud
    ibm-cloud/terraform-provider-ibm