1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getPostgresBranchMaintenanceWindow
Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
planetscale
Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale

    PostgresBranchMaintenanceWindow DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as planetscale from "@pulumi/planetscale";
    
    const myPostgresbranchmaintenancewindow = planetscale.getPostgresBranchMaintenanceWindow({
        branch: "...my_branch...",
        database: "...my_database...",
        organization: "...my_organization...",
    });
    
    import pulumi
    import pulumi_planetscale as planetscale
    
    my_postgresbranchmaintenancewindow = planetscale.get_postgres_branch_maintenance_window(branch="...my_branch...",
        database="...my_database...",
        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.LookupPostgresBranchMaintenanceWindow(ctx, &planetscale.LookupPostgresBranchMaintenanceWindowArgs{
    			Branch:       "...my_branch...",
    			Database:     "...my_database...",
    			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 myPostgresbranchmaintenancewindow = Planetscale.GetPostgresBranchMaintenanceWindow.Invoke(new()
        {
            Branch = "...my_branch...",
            Database = "...my_database...",
            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.GetPostgresBranchMaintenanceWindowArgs;
    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 myPostgresbranchmaintenancewindow = PlanetscaleFunctions.getPostgresBranchMaintenanceWindow(GetPostgresBranchMaintenanceWindowArgs.builder()
                .branch("...my_branch...")
                .database("...my_database...")
                .organization("...my_organization...")
                .build());
    
        }
    }
    
    variables:
      myPostgresbranchmaintenancewindow:
        fn::invoke:
          function: planetscale:getPostgresBranchMaintenanceWindow
          arguments:
            branch: '...my_branch...'
            database: '...my_database...'
            organization: '...my_organization...'
    
    Example coming soon!
    

    Using getPostgresBranchMaintenanceWindow

    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 getPostgresBranchMaintenanceWindow(args: GetPostgresBranchMaintenanceWindowArgs, opts?: InvokeOptions): Promise<GetPostgresBranchMaintenanceWindowResult>
    function getPostgresBranchMaintenanceWindowOutput(args: GetPostgresBranchMaintenanceWindowOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresBranchMaintenanceWindowResult>
    def get_postgres_branch_maintenance_window(branch: Optional[str] = None,
                                               database: Optional[str] = None,
                                               organization: Optional[str] = None,
                                               opts: Optional[InvokeOptions] = None) -> GetPostgresBranchMaintenanceWindowResult
    def get_postgres_branch_maintenance_window_output(branch: pulumi.Input[Optional[str]] = None,
                                               database: pulumi.Input[Optional[str]] = None,
                                               organization: pulumi.Input[Optional[str]] = None,
                                               opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresBranchMaintenanceWindowResult]
    func LookupPostgresBranchMaintenanceWindow(ctx *Context, args *LookupPostgresBranchMaintenanceWindowArgs, opts ...InvokeOption) (*LookupPostgresBranchMaintenanceWindowResult, error)
    func LookupPostgresBranchMaintenanceWindowOutput(ctx *Context, args *LookupPostgresBranchMaintenanceWindowOutputArgs, opts ...InvokeOption) LookupPostgresBranchMaintenanceWindowResultOutput

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

    public static class GetPostgresBranchMaintenanceWindow 
    {
        public static Task<GetPostgresBranchMaintenanceWindowResult> InvokeAsync(GetPostgresBranchMaintenanceWindowArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresBranchMaintenanceWindowResult> Invoke(GetPostgresBranchMaintenanceWindowInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresBranchMaintenanceWindowResult> Invoke(GetPostgresBranchMaintenanceWindowInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPostgresBranchMaintenanceWindowResult> getPostgresBranchMaintenanceWindow(GetPostgresBranchMaintenanceWindowArgs args, InvokeOptions options)
    public static Output<GetPostgresBranchMaintenanceWindowResult> getPostgresBranchMaintenanceWindow(GetPostgresBranchMaintenanceWindowArgs args, InvokeOptions options)
    public static Output<GetPostgresBranchMaintenanceWindowResult> getPostgresBranchMaintenanceWindow(GetPostgresBranchMaintenanceWindowArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: planetscale:index/getPostgresBranchMaintenanceWindow:getPostgresBranchMaintenanceWindow
      arguments:
        # arguments dictionary
    data "planetscale_get_postgres_branch_maintenance_window" "name" {
        # arguments
    }

    The following arguments are supported:

    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Organization string
    Organization name slug from list_organizations. Example: acme.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    organization string
    Organization name slug from list_organizations. Example: acme.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    organization String
    Organization name slug from list_organizations. Example: acme.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    organization string
    Organization name slug from list_organizations. Example: acme.
    branch str
    Branch name from list_branches. Example: main.
    database str
    Database name slug from list_databases. Example: app-db.
    organization str
    Organization name slug from list_organizations. Example: acme.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    organization String
    Organization name slug from list_organizations. Example: acme.

    getPostgresBranchMaintenanceWindow Result

    The following output properties are available:

    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Day double
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    Duration double
    The duration of the maintenance window in hours
    Hour double
    Hour of the day in UTC (0-23)
    Id string
    The ID of the maintenance schedule
    Organization string
    Organization name slug from list_organizations. Example: acme.
    Branch string
    Branch name from list_branches. Example: main.
    Database string
    Database name slug from list_databases. Example: app-db.
    Day float64
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    Duration float64
    The duration of the maintenance window in hours
    Hour float64
    Hour of the day in UTC (0-23)
    Id string
    The ID of the maintenance schedule
    Organization string
    Organization name slug from list_organizations. Example: acme.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    day number
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    duration number
    The duration of the maintenance window in hours
    hour number
    Hour of the day in UTC (0-23)
    id string
    The ID of the maintenance schedule
    organization string
    Organization name slug from list_organizations. Example: acme.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    day Double
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    duration Double
    The duration of the maintenance window in hours
    hour Double
    Hour of the day in UTC (0-23)
    id String
    The ID of the maintenance schedule
    organization String
    Organization name slug from list_organizations. Example: acme.
    branch string
    Branch name from list_branches. Example: main.
    database string
    Database name slug from list_databases. Example: app-db.
    day number
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    duration number
    The duration of the maintenance window in hours
    hour number
    Hour of the day in UTC (0-23)
    id string
    The ID of the maintenance schedule
    organization string
    Organization name slug from list_organizations. Example: acme.
    branch str
    Branch name from list_branches. Example: main.
    database str
    Database name slug from list_databases. Example: app-db.
    day float
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    duration float
    The duration of the maintenance window in hours
    hour float
    Hour of the day in UTC (0-23)
    id str
    The ID of the maintenance schedule
    organization str
    Organization name slug from list_organizations. Example: acme.
    branch String
    Branch name from list_branches. Example: main.
    database String
    Database name slug from list_databases. Example: app-db.
    day Number
    Day of the week (0 = Sunday, 6 = Saturday, 7 = every day)
    duration Number
    The duration of the maintenance window in hours
    hour Number
    Hour of the day in UTC (0-23)
    id String
    The ID of the maintenance schedule
    organization String
    Organization name slug from list_organizations. Example: acme.

    Package Details

    Repository
    planetscale planetscale/terraform-provider-planetscale
    License
    Notes
    This Pulumi package is based on the planetscale Terraform Provider.
    planetscale
    Viewing docs for planetscale 1.20.0
    published on Thursday, Nov 12, 2026 by planetscale

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial