1. Packages
  2. Vkcs Provider
  3. API Docs
  4. getDbBackup
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

vkcs.getDbBackup

Explore with Pulumi AI

vkcs logo
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs

    Use this data source to get the information on a db backup resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vkcs from "@pulumi/vkcs";
    
    const dbBackup = vkcs.getDbBackup({
        id: "d27fbf1a-373a-479c-b951-31041756f289",
    });
    
    import pulumi
    import pulumi_vkcs as vkcs
    
    db_backup = vkcs.get_db_backup(id="d27fbf1a-373a-479c-b951-31041756f289")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := vkcs.LookupDbBackup(ctx, &vkcs.LookupDbBackupArgs{
    			Id: pulumi.StringRef("d27fbf1a-373a-479c-b951-31041756f289"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vkcs = Pulumi.Vkcs;
    
    return await Deployment.RunAsync(() => 
    {
        var dbBackup = Vkcs.GetDbBackup.Invoke(new()
        {
            Id = "d27fbf1a-373a-479c-b951-31041756f289",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vkcs.VkcsFunctions;
    import com.pulumi.vkcs.inputs.GetDbBackupArgs;
    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 dbBackup = VkcsFunctions.getDbBackup(GetDbBackupArgs.builder()
                .id("d27fbf1a-373a-479c-b951-31041756f289")
                .build());
    
        }
    }
    
    variables:
      dbBackup:
        fn::invoke:
          function: vkcs:getDbBackup
          arguments:
            id: d27fbf1a-373a-479c-b951-31041756f289
    

    Using getDbBackup

    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 getDbBackup(args: GetDbBackupArgs, opts?: InvokeOptions): Promise<GetDbBackupResult>
    function getDbBackupOutput(args: GetDbBackupOutputArgs, opts?: InvokeOptions): Output<GetDbBackupResult>
    def get_db_backup(backup_id: Optional[str] = None,
                      description: Optional[str] = None,
                      id: Optional[str] = None,
                      region: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetDbBackupResult
    def get_db_backup_output(backup_id: Optional[pulumi.Input[str]] = None,
                      description: Optional[pulumi.Input[str]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetDbBackupResult]
    func LookupDbBackup(ctx *Context, args *LookupDbBackupArgs, opts ...InvokeOption) (*LookupDbBackupResult, error)
    func LookupDbBackupOutput(ctx *Context, args *LookupDbBackupOutputArgs, opts ...InvokeOption) LookupDbBackupResultOutput

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

    public static class GetDbBackup 
    {
        public static Task<GetDbBackupResult> InvokeAsync(GetDbBackupArgs args, InvokeOptions? opts = null)
        public static Output<GetDbBackupResult> Invoke(GetDbBackupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDbBackupResult> getDbBackup(GetDbBackupArgs args, InvokeOptions options)
    public static Output<GetDbBackupResult> getDbBackup(GetDbBackupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vkcs:index/getDbBackup:getDbBackup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    BackupId string
    optional deprecated string → The UUID of the backup. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    Description string
    optional string → The description of the backup
    Id string
    optional string → The UUID of the backup.
    Region string
    optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    BackupId string
    optional deprecated string → The UUID of the backup. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    Description string
    optional string → The description of the backup
    Id string
    optional string → The UUID of the backup.
    Region string
    optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    backupId String
    optional deprecated string → The UUID of the backup. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    description String
    optional string → The description of the backup
    id String
    optional string → The UUID of the backup.
    region String
    optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    backupId string
    optional deprecated string → The UUID of the backup. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    description string
    optional string → The description of the backup
    id string
    optional string → The UUID of the backup.
    region string
    optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    backup_id str
    optional deprecated string → The UUID of the backup. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    description str
    optional string → The description of the backup
    id str
    optional string → The UUID of the backup.
    region str
    optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.
    backupId String
    optional deprecated string → The UUID of the backup. Deprecated This argument is deprecated, please, use the id attribute instead.

    Deprecated: Deprecated

    description String
    optional string → The description of the backup
    id String
    optional string → The UUID of the backup.
    region String
    optional string → The region in which to obtain the service client. If omitted, the region argument of the provider is used.New since v0.4.0.

    getDbBackup Result

    The following output properties are available:

    BackupId string

    Deprecated: Deprecated

    Created string
    string → Backup creation timestamp
    Datastores List<GetDbBackupDatastore>
    list → Object that represents datastore of backup
    DbmsId string
    string → ID of the backed up instance or cluster
    DbmsType string
    string → Type of dbms of the backup, can be "instance" or "cluster".
    Id string
    LocationRef string
    string → Location of backup data on backup storage
    Meta string
    string → Metadata of the backup
    Name string
    string → The name of the backup.
    Region string
    Size double
    number → Backup's volume size
    Updated string
    string → Timestamp of backup's last update
    WalSize double
    number → Backup's WAL volume size
    Description string
    BackupId string

    Deprecated: Deprecated

    Created string
    string → Backup creation timestamp
    Datastores []GetDbBackupDatastore
    list → Object that represents datastore of backup
    DbmsId string
    string → ID of the backed up instance or cluster
    DbmsType string
    string → Type of dbms of the backup, can be "instance" or "cluster".
    Id string
    LocationRef string
    string → Location of backup data on backup storage
    Meta string
    string → Metadata of the backup
    Name string
    string → The name of the backup.
    Region string
    Size float64
    number → Backup's volume size
    Updated string
    string → Timestamp of backup's last update
    WalSize float64
    number → Backup's WAL volume size
    Description string
    backupId String

    Deprecated: Deprecated

    created String
    string → Backup creation timestamp
    datastores List<GetDbBackupDatastore>
    list → Object that represents datastore of backup
    dbmsId String
    string → ID of the backed up instance or cluster
    dbmsType String
    string → Type of dbms of the backup, can be "instance" or "cluster".
    id String
    locationRef String
    string → Location of backup data on backup storage
    meta String
    string → Metadata of the backup
    name String
    string → The name of the backup.
    region String
    size Double
    number → Backup's volume size
    updated String
    string → Timestamp of backup's last update
    walSize Double
    number → Backup's WAL volume size
    description String
    backupId string

    Deprecated: Deprecated

    created string
    string → Backup creation timestamp
    datastores GetDbBackupDatastore[]
    list → Object that represents datastore of backup
    dbmsId string
    string → ID of the backed up instance or cluster
    dbmsType string
    string → Type of dbms of the backup, can be "instance" or "cluster".
    id string
    locationRef string
    string → Location of backup data on backup storage
    meta string
    string → Metadata of the backup
    name string
    string → The name of the backup.
    region string
    size number
    number → Backup's volume size
    updated string
    string → Timestamp of backup's last update
    walSize number
    number → Backup's WAL volume size
    description string
    backup_id str

    Deprecated: Deprecated

    created str
    string → Backup creation timestamp
    datastores Sequence[GetDbBackupDatastore]
    list → Object that represents datastore of backup
    dbms_id str
    string → ID of the backed up instance or cluster
    dbms_type str
    string → Type of dbms of the backup, can be "instance" or "cluster".
    id str
    location_ref str
    string → Location of backup data on backup storage
    meta str
    string → Metadata of the backup
    name str
    string → The name of the backup.
    region str
    size float
    number → Backup's volume size
    updated str
    string → Timestamp of backup's last update
    wal_size float
    number → Backup's WAL volume size
    description str
    backupId String

    Deprecated: Deprecated

    created String
    string → Backup creation timestamp
    datastores List<Property Map>
    list → Object that represents datastore of backup
    dbmsId String
    string → ID of the backed up instance or cluster
    dbmsType String
    string → Type of dbms of the backup, can be "instance" or "cluster".
    id String
    locationRef String
    string → Location of backup data on backup storage
    meta String
    string → Metadata of the backup
    name String
    string → The name of the backup.
    region String
    size Number
    number → Backup's volume size
    updated String
    string → Timestamp of backup's last update
    walSize Number
    number → Backup's WAL volume size
    description String

    Supporting Types

    GetDbBackupDatastore

    Type string
    string → Type of the datastore.
    Version string
    string → Version of the datastore.
    Type string
    string → Type of the datastore.
    Version string
    string → Version of the datastore.
    type String
    string → Type of the datastore.
    version String
    string → Version of the datastore.
    type string
    string → Type of the datastore.
    version string
    string → Version of the datastore.
    type str
    string → Type of the datastore.
    version str
    string → Version of the datastore.
    type String
    string → Type of the datastore.
    version String
    string → Version of the datastore.

    Package Details

    Repository
    vkcs vk-cs/terraform-provider-vkcs
    License
    Notes
    This Pulumi package is based on the vkcs Terraform Provider.
    vkcs logo
    vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs