Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Planetscale Provider
  3. API Docs
  4. getBackup
planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale
planetscale/terraform-provider-planetscale

planetscale.getBackup

Explore with Pulumi AI

planetscale logo
planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale
planetscale/terraform-provider-planetscale

    A PlanetScale backup.

    Example Usage

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

const example = planetscale.getBackup({
    organization: "example.com",
    database: "example_db",
    branch: "main",
    id: "k20nb1b7ut18",
});
export const backup = example;

    import pulumi
import pulumi_planetscale as planetscale

example = planetscale.get_backup(organization="example.com",
    database="example_db",
    branch="main",
    id="k20nb1b7ut18")
pulumi.export("backup", example)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := planetscale.LookupBackup(ctx, &planetscale.LookupBackupArgs{
			Organization: "example.com",
			Database:     "example_db",
			Branch:       "main",
			Id:           "k20nb1b7ut18",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("backup", example)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Planetscale.GetBackup.Invoke(new()
    {
        Organization = "example.com",
        Database = "example_db",
        Branch = "main",
        Id = "k20nb1b7ut18",
    });

    return new Dictionary<string, object?>
    {
        ["backup"] = example,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.planetscale.PlanetscaleFunctions;
import com.pulumi.planetscale.inputs.GetBackupArgs;
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 = PlanetscaleFunctions.getBackup(GetBackupArgs.builder()
            .organization("example.com")
            .database("example_db")
            .branch("main")
            .id("k20nb1b7ut18")
            .build());

        ctx.export("backup", example.applyValue(getBackupResult -> getBackupResult));
    }
}

    variables:
  example:
    fn::invoke:
      function: planetscale:getBackup
      arguments:
        organization: example.com
        database: example_db
        branch: main
        id: k20nb1b7ut18
outputs:
  backup: ${example}

    Using getBackup

    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 getBackup(args: GetBackupArgs, opts?: InvokeOptions): Promise<GetBackupResult>
function getBackupOutput(args: GetBackupOutputArgs, opts?: InvokeOptions): Output<GetBackupResult>
    def get_backup(branch: Optional[str] = None,
               database: Optional[str] = None,
               id: Optional[str] = None,
               organization: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetBackupResult
def get_backup_output(branch: Optional[pulumi.Input[str]] = None,
               database: Optional[pulumi.Input[str]] = None,
               id: Optional[pulumi.Input[str]] = None,
               organization: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetBackupResult]
    func LookupBackup(ctx *Context, args *LookupBackupArgs, opts ...InvokeOption) (*LookupBackupResult, error)
func LookupBackupOutput(ctx *Context, args *LookupBackupOutputArgs, opts ...InvokeOption) LookupBackupResultOutput

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

    public static class GetBackup 
{
    public static Task<GetBackupResult> InvokeAsync(GetBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetBackupResult> Invoke(GetBackupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)
public static Output<GetBackupResult> getBackup(GetBackupArgs args, InvokeOptions options)

    fn::invoke:
  function: planetscale:index/getBackup:getBackup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Branch string
    The branch this backup belongs to.
    Database string
    The database this backup belongs to.
    Id string
    The ID of the backup.
    Organization string
    The organization this backup belongs to.
    Branch string
    The branch this backup belongs to.
    Database string
    The database this backup belongs to.
    Id string
    The ID of the backup.
    Organization string
    The organization this backup belongs to.
    branch String
    The branch this backup belongs to.
    database String
    The database this backup belongs to.
    id String
    The ID of the backup.
    organization String
    The organization this backup belongs to.
    branch string
    The branch this backup belongs to.
    database string
    The database this backup belongs to.
    id string
    The ID of the backup.
    organization string
    The organization this backup belongs to.
    branch str
    The branch this backup belongs to.
    database str
    The database this backup belongs to.
    id str
    The ID of the backup.
    organization str
    The organization this backup belongs to.
    branch String
    The branch this backup belongs to.
    database String
    The database this backup belongs to.
    id String
    The ID of the backup.
    organization String
    The organization this backup belongs to.

    getBackup Result

    The following output properties are available:

    Actor GetBackupActor
    The actor that created the backup.
    BackupPolicy GetBackupBackupPolicy
    The backup policy being followed.
    Branch string
    The branch this backup belongs to.
    CreatedAt string
    When the backup was created.
    Database string
    The database this backup belongs to.
    EstimatedStorageCost double
    The estimated storage cost of the backup.
    Id string
    The ID of the backup.
    Name string
    The name of the backup.
    Organization string
    The organization this backup belongs to.
    Required bool
    Whether or not the backup policy is required.
    RestoredBranches List<string>
    Branches that have been restored with this backup.
    Size double
    The size of the backup.
    State string
    The current state of the backup.
    UpdatedAt string
    When the backup was last updated.
    Actor GetBackupActor
    The actor that created the backup.
    BackupPolicy GetBackupBackupPolicy
    The backup policy being followed.
    Branch string
    The branch this backup belongs to.
    CreatedAt string
    When the backup was created.
    Database string
    The database this backup belongs to.
    EstimatedStorageCost float64
    The estimated storage cost of the backup.
    Id string
    The ID of the backup.
    Name string
    The name of the backup.
    Organization string
    The organization this backup belongs to.
    Required bool
    Whether or not the backup policy is required.
    RestoredBranches []string
    Branches that have been restored with this backup.
    Size float64
    The size of the backup.
    State string
    The current state of the backup.
    UpdatedAt string
    When the backup was last updated.
    actor GetBackupActor
    The actor that created the backup.
    backupPolicy GetBackupBackupPolicy
    The backup policy being followed.
    branch String
    The branch this backup belongs to.
    createdAt String
    When the backup was created.
    database String
    The database this backup belongs to.
    estimatedStorageCost Double
    The estimated storage cost of the backup.
    id String
    The ID of the backup.
    name String
    The name of the backup.
    organization String
    The organization this backup belongs to.
    required Boolean
    Whether or not the backup policy is required.
    restoredBranches List<String>
    Branches that have been restored with this backup.
    size Double
    The size of the backup.
    state String
    The current state of the backup.
    updatedAt String
    When the backup was last updated.
    actor GetBackupActor
    The actor that created the backup.
    backupPolicy GetBackupBackupPolicy
    The backup policy being followed.
    branch string
    The branch this backup belongs to.
    createdAt string
    When the backup was created.
    database string
    The database this backup belongs to.
    estimatedStorageCost number
    The estimated storage cost of the backup.
    id string
    The ID of the backup.
    name string
    The name of the backup.
    organization string
    The organization this backup belongs to.
    required boolean
    Whether or not the backup policy is required.
    restoredBranches string[]
    Branches that have been restored with this backup.
    size number
    The size of the backup.
    state string
    The current state of the backup.
    updatedAt string
    When the backup was last updated.
    actor GetBackupActor
    The actor that created the backup.
    backup_policy GetBackupBackupPolicy
    The backup policy being followed.
    branch str
    The branch this backup belongs to.
    created_at str
    When the backup was created.
    database str
    The database this backup belongs to.
    estimated_storage_cost float
    The estimated storage cost of the backup.
    id str
    The ID of the backup.
    name str
    The name of the backup.
    organization str
    The organization this backup belongs to.
    required bool
    Whether or not the backup policy is required.
    restored_branches Sequence[str]
    Branches that have been restored with this backup.
    size float
    The size of the backup.
    state str
    The current state of the backup.
    updated_at str
    When the backup was last updated.
    actor Property Map
    The actor that created the backup.
    backupPolicy Property Map
    The backup policy being followed.
    branch String
    The branch this backup belongs to.
    createdAt String
    When the backup was created.
    database String
    The database this backup belongs to.
    estimatedStorageCost Number
    The estimated storage cost of the backup.
    id String
    The ID of the backup.
    name String
    The name of the backup.
    organization String
    The organization this backup belongs to.
    required Boolean
    Whether or not the backup policy is required.
    restoredBranches List<String>
    Branches that have been restored with this backup.
    size Number
    The size of the backup.
    state String
    The current state of the backup.
    updatedAt String
    When the backup was last updated.

    Supporting Types

    GetBackupActor

    AvatarUrl string
    The URL of the actor's avatar
    DisplayName string
    The name of the actor
    Id string
    The ID of the actor
    AvatarUrl string
    The URL of the actor's avatar
    DisplayName string
    The name of the actor
    Id string
    The ID of the actor
    avatarUrl String
    The URL of the actor's avatar
    displayName String
    The name of the actor
    id String
    The ID of the actor
    avatarUrl string
    The URL of the actor's avatar
    displayName string
    The name of the actor
    id string
    The ID of the actor
    avatar_url str
    The URL of the actor's avatar
    display_name str
    The name of the actor
    id str
    The ID of the actor
    avatarUrl String
    The URL of the actor's avatar
    displayName String
    The name of the actor
    id String
    The ID of the actor

    GetBackupBackupPolicy

    CreatedAt string
    When the backup policy was created.
    FrequencyUnit string
    The unit for the frequency of the backup policy.
    FrequencyValue double
    A number value for the frequency of the backup policy.
    Id string
    The ID of the backup policy.
    LastRanAt string
    When the backup was last run.
    Name string
    The name of the backup policy.
    NextRunAt string
    When the backup will next run.
    RetentionUnit string
    The unit for the retention period of the backup policy.
    RetentionValue double
    A number value for the retention period of the backup policy.
    ScheduleDay string
    Day of the week that the backup is scheduled.
    ScheduleWeek string
    Week of the month that the backup is scheduled.
    Target string
    Whether the backup policy is for a production or development database, or for a database branch.
    UpdatedAt string
    When the backup policy was last updated.
    CreatedAt string
    When the backup policy was created.
    FrequencyUnit string
    The unit for the frequency of the backup policy.
    FrequencyValue float64
    A number value for the frequency of the backup policy.
    Id string
    The ID of the backup policy.
    LastRanAt string
    When the backup was last run.
    Name string
    The name of the backup policy.
    NextRunAt string
    When the backup will next run.
    RetentionUnit string
    The unit for the retention period of the backup policy.
    RetentionValue float64
    A number value for the retention period of the backup policy.
    ScheduleDay string
    Day of the week that the backup is scheduled.
    ScheduleWeek string
    Week of the month that the backup is scheduled.
    Target string
    Whether the backup policy is for a production or development database, or for a database branch.
    UpdatedAt string
    When the backup policy was last updated.
    createdAt String
    When the backup policy was created.
    frequencyUnit String
    The unit for the frequency of the backup policy.
    frequencyValue Double
    A number value for the frequency of the backup policy.
    id String
    The ID of the backup policy.
    lastRanAt String
    When the backup was last run.
    name String
    The name of the backup policy.
    nextRunAt String
    When the backup will next run.
    retentionUnit String
    The unit for the retention period of the backup policy.
    retentionValue Double
    A number value for the retention period of the backup policy.
    scheduleDay String
    Day of the week that the backup is scheduled.
    scheduleWeek String
    Week of the month that the backup is scheduled.
    target String
    Whether the backup policy is for a production or development database, or for a database branch.
    updatedAt String
    When the backup policy was last updated.
    createdAt string
    When the backup policy was created.
    frequencyUnit string
    The unit for the frequency of the backup policy.
    frequencyValue number
    A number value for the frequency of the backup policy.
    id string
    The ID of the backup policy.
    lastRanAt string
    When the backup was last run.
    name string
    The name of the backup policy.
    nextRunAt string
    When the backup will next run.
    retentionUnit string
    The unit for the retention period of the backup policy.
    retentionValue number
    A number value for the retention period of the backup policy.
    scheduleDay string
    Day of the week that the backup is scheduled.
    scheduleWeek string
    Week of the month that the backup is scheduled.
    target string
    Whether the backup policy is for a production or development database, or for a database branch.
    updatedAt string
    When the backup policy was last updated.
    created_at str
    When the backup policy was created.
    frequency_unit str
    The unit for the frequency of the backup policy.
    frequency_value float
    A number value for the frequency of the backup policy.
    id str
    The ID of the backup policy.
    last_ran_at str
    When the backup was last run.
    name str
    The name of the backup policy.
    next_run_at str
    When the backup will next run.
    retention_unit str
    The unit for the retention period of the backup policy.
    retention_value float
    A number value for the retention period of the backup policy.
    schedule_day str
    Day of the week that the backup is scheduled.
    schedule_week str
    Week of the month that the backup is scheduled.
    target str
    Whether the backup policy is for a production or development database, or for a database branch.
    updated_at str
    When the backup policy was last updated.
    createdAt String
    When the backup policy was created.
    frequencyUnit String
    The unit for the frequency of the backup policy.
    frequencyValue Number
    A number value for the frequency of the backup policy.
    id String
    The ID of the backup policy.
    lastRanAt String
    When the backup was last run.
    name String
    The name of the backup policy.
    nextRunAt String
    When the backup will next run.
    retentionUnit String
    The unit for the retention period of the backup policy.
    retentionValue Number
    A number value for the retention period of the backup policy.
    scheduleDay String
    Day of the week that the backup is scheduled.
    scheduleWeek String
    Week of the month that the backup is scheduled.
    target String
    Whether the backup policy is for a production or development database, or for a database branch.
    updatedAt String
    When the backup policy was last updated.

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale logo
    planetscale 0.4.1 published on Tuesday, Mar 11, 2025 by planetscale
    planetscale/terraform-provider-planetscale