Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getVitessBackupPolicy
Viewing docs for planetscale 1.2.0
published on Tuesday, Jun 16, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

planetscale.getVitessBackupPolicy

Viewing docs for planetscale 1.2.0
published on Tuesday, Jun 16, 2026 by planetscale
Schema (JSON)
planetscale/terraform-provider-planetscale

    VitessBackupPolicy DataSource

    Example Usage

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

const myVitessbackuppolicy = planetscale.getVitessBackupPolicy({
    database: "...my_database...",
    id: "...my_id...",
    organization: "...my_organization...",
});

    import pulumi
import pulumi_planetscale as planetscale

my_vitessbackuppolicy = planetscale.get_vitess_backup_policy(database="...my_database...",
    id="...my_id...",
    organization="...my_organization...")

    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 {
		_, err := planetscale.LookupVitessBackupPolicy(ctx, &planetscale.LookupVitessBackupPolicyArgs{
			Database:     "...my_database...",
			Id:           "...my_id...",
			Organization: "...my_organization...",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var myVitessbackuppolicy = Planetscale.GetVitessBackupPolicy.Invoke(new()
    {
        Database = "...my_database...",
        Id = "...my_id...",
        Organization = "...my_organization...",
    });

});

    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.GetVitessBackupPolicyArgs;
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 myVitessbackuppolicy = PlanetscaleFunctions.getVitessBackupPolicy(GetVitessBackupPolicyArgs.builder()
            .database("...my_database...")
            .id("...my_id...")
            .organization("...my_organization...")
            .build());

    }
}

    variables:
  myVitessbackuppolicy:
    fn::invoke:
      function: planetscale:getVitessBackupPolicy
      arguments:
        database: '...my_database...'
        id: '...my_id...'
        organization: '...my_organization...'

    Example coming soon!

    Using getVitessBackupPolicy

    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 getVitessBackupPolicy(args: GetVitessBackupPolicyArgs, opts?: InvokeOptions): Promise<GetVitessBackupPolicyResult>
function getVitessBackupPolicyOutput(args: GetVitessBackupPolicyOutputArgs, opts?: InvokeOptions): Output<GetVitessBackupPolicyResult>
    def get_vitess_backup_policy(database: Optional[str] = None,
                             id: Optional[str] = None,
                             organization: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetVitessBackupPolicyResult
def get_vitess_backup_policy_output(database: pulumi.Input[Optional[str]] = None,
                             id: pulumi.Input[Optional[str]] = None,
                             organization: pulumi.Input[Optional[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetVitessBackupPolicyResult]
    func LookupVitessBackupPolicy(ctx *Context, args *LookupVitessBackupPolicyArgs, opts ...InvokeOption) (*LookupVitessBackupPolicyResult, error)
func LookupVitessBackupPolicyOutput(ctx *Context, args *LookupVitessBackupPolicyOutputArgs, opts ...InvokeOption) LookupVitessBackupPolicyResultOutput

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

    public static class GetVitessBackupPolicy 
{
    public static Task<GetVitessBackupPolicyResult> InvokeAsync(GetVitessBackupPolicyArgs args, InvokeOptions? opts = null)
    public static Output<GetVitessBackupPolicyResult> Invoke(GetVitessBackupPolicyInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetVitessBackupPolicyResult> getVitessBackupPolicy(GetVitessBackupPolicyArgs args, InvokeOptions options)
public static Output<GetVitessBackupPolicyResult> getVitessBackupPolicy(GetVitessBackupPolicyArgs args, InvokeOptions options)

    fn::invoke:
  function: planetscale:index/getVitessBackupPolicy:getVitessBackupPolicy
  arguments:
    # arguments dictionary
    data "planetscale_getvitessbackuppolicy" "name" {
    # arguments
}

    The following arguments are supported:

    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the backup policy
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Database string
    Database name slug from list_databases. Example: app-db.
    Id string
    The ID of the backup policy
    Organization string
    Organization name slug from list_organizations. Example: acme.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the backup policy
    organization string
    Organization name slug from list_organizations. Example: acme.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the backup policy
    organization String
    Organization name slug from list_organizations. Example: acme.
    database string
    Database name slug from list_databases. Example: app-db.
    id string
    The ID of the backup policy
    organization string
    Organization name slug from list_organizations. Example: acme.
    database str
    Database name slug from list_databases. Example: app-db.
    id str
    The ID of the backup policy
    organization str
    Organization name slug from list_organizations. Example: acme.
    database String
    Database name slug from list_databases. Example: app-db.
    id String
    The ID of the backup policy
    organization String
    Organization name slug from list_organizations. Example: acme.

    getVitessBackupPolicy Result

    The following output properties are available:

    Database string
    Database name slug from list_databases. Example: app-db.
    DisplayName string
    The display name of the backup policy
    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
    Name string
    The name of the backup policy
    Organization string
    Organization name slug from list_organizations. Example: acme.
    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 double
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    ScheduleTime string
    The time of day that the backup is scheduled, in HH:MM format
    ScheduleWeek double
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    Target string
    Whether the policy is for production or development branches
    Database string
    Database name slug from list_databases. Example: app-db.
    DisplayName string
    The display name of the backup policy
    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
    Name string
    The name of the backup policy
    Organization string
    Organization name slug from list_organizations. Example: acme.
    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 float64
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    ScheduleTime string
    The time of day that the backup is scheduled, in HH:MM format
    ScheduleWeek float64
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    Target string
    Whether the policy is for production or development branches
    database string
    Database name slug from list_databases. Example: app-db.
    display_name string
    The display name of the backup policy
    frequency_unit string
    The unit for the frequency of the backup policy
    frequency_value number
    A number value for the frequency of the backup policy
    id string
    The ID of the backup policy
    name string
    The name of the backup policy
    organization string
    Organization name slug from list_organizations. Example: acme.
    retention_unit string
    The unit for the retention period of the backup policy
    retention_value number
    A number value for the retention period of the backup policy
    schedule_day number
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    schedule_time string
    The time of day that the backup is scheduled, in HH:MM format
    schedule_week number
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    target string
    Whether the policy is for production or development branches
    database String
    Database name slug from list_databases. Example: app-db.
    displayName String
    The display name of the backup policy
    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
    name String
    The name of the backup policy
    organization String
    Organization name slug from list_organizations. Example: acme.
    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 Double
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    scheduleTime String
    The time of day that the backup is scheduled, in HH:MM format
    scheduleWeek Double
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    target String
    Whether the policy is for production or development branches
    database string
    Database name slug from list_databases. Example: app-db.
    displayName string
    The display name of the backup policy
    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
    name string
    The name of the backup policy
    organization string
    Organization name slug from list_organizations. Example: acme.
    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 number
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    scheduleTime string
    The time of day that the backup is scheduled, in HH:MM format
    scheduleWeek number
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    target string
    Whether the policy is for production or development branches
    database str
    Database name slug from list_databases. Example: app-db.
    display_name str
    The display name of the backup policy
    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
    name str
    The name of the backup policy
    organization str
    Organization name slug from list_organizations. Example: acme.
    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 float
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    schedule_time str
    The time of day that the backup is scheduled, in HH:MM format
    schedule_week float
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    target str
    Whether the policy is for production or development branches
    database String
    Database name slug from list_databases. Example: app-db.
    displayName String
    The display name of the backup policy
    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
    name String
    The name of the backup policy
    organization String
    Organization name slug from list_organizations. Example: acme.
    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 Number
    Day of the week that the backup is scheduled. 0 is Sunday, 6 is Saturday
    scheduleTime String
    The time of day that the backup is scheduled, in HH:MM format
    scheduleWeek Number
    Week of the month that the backup is scheduled. 0 is the first week, 3 is the fourth week
    target String
    Whether the policy is for production or development branches

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    Viewing docs for planetscale 1.2.0
    published on Tuesday, Jun 16, 2026 by planetscale
    Schema (JSON)
    planetscale/terraform-provider-planetscale

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial