1. Registry
  2. Packages
  3. Planetscale Provider
  4. API Docs
  5. getPostgresIpRestrictions
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

    PostgresIPRestrictions DataSource

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as planetscale from "@pulumi/planetscale";
    
    const myPostgresiprestrictions = planetscale.getPostgresIpRestrictions({
        database: "...my_database...",
        organization: "...my_organization...",
    });
    
    import pulumi
    import pulumi_planetscale as planetscale
    
    my_postgresiprestrictions = planetscale.get_postgres_ip_restrictions(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.GetPostgresIpRestrictions(ctx, &planetscale.GetPostgresIpRestrictionsArgs{
    			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 myPostgresiprestrictions = Planetscale.GetPostgresIpRestrictions.Invoke(new()
        {
            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.GetPostgresIpRestrictionsArgs;
    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 myPostgresiprestrictions = PlanetscaleFunctions.getPostgresIpRestrictions(GetPostgresIpRestrictionsArgs.builder()
                .database("...my_database...")
                .organization("...my_organization...")
                .build());
    
        }
    }
    
    variables:
      myPostgresiprestrictions:
        fn::invoke:
          function: planetscale:getPostgresIpRestrictions
          arguments:
            database: '...my_database...'
            organization: '...my_organization...'
    
    Example coming soon!
    

    Using getPostgresIpRestrictions

    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 getPostgresIpRestrictions(args: GetPostgresIpRestrictionsArgs, opts?: InvokeOptions): Promise<GetPostgresIpRestrictionsResult>
    function getPostgresIpRestrictionsOutput(args: GetPostgresIpRestrictionsOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresIpRestrictionsResult>
    def get_postgres_ip_restrictions(database: Optional[str] = None,
                                     organization: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetPostgresIpRestrictionsResult
    def get_postgres_ip_restrictions_output(database: pulumi.Input[Optional[str]] = None,
                                     organization: pulumi.Input[Optional[str]] = None,
                                     opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresIpRestrictionsResult]
    func GetPostgresIpRestrictions(ctx *Context, args *GetPostgresIpRestrictionsArgs, opts ...InvokeOption) (*GetPostgresIpRestrictionsResult, error)
    func GetPostgresIpRestrictionsOutput(ctx *Context, args *GetPostgresIpRestrictionsOutputArgs, opts ...InvokeOption) GetPostgresIpRestrictionsResultOutput

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

    public static class GetPostgresIpRestrictions 
    {
        public static Task<GetPostgresIpRestrictionsResult> InvokeAsync(GetPostgresIpRestrictionsArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresIpRestrictionsResult> Invoke(GetPostgresIpRestrictionsInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresIpRestrictionsResult> Invoke(GetPostgresIpRestrictionsInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPostgresIpRestrictionsResult> getPostgresIpRestrictions(GetPostgresIpRestrictionsArgs args, InvokeOptions options)
    public static Output<GetPostgresIpRestrictionsResult> getPostgresIpRestrictions(GetPostgresIpRestrictionsArgs args, InvokeOptions options)
    public static Output<GetPostgresIpRestrictionsResult> getPostgresIpRestrictions(GetPostgresIpRestrictionsArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: planetscale:index/getPostgresIpRestrictions:getPostgresIpRestrictions
      arguments:
        # arguments dictionary
    data "planetscale_get_postgres_ip_restrictions" "name" {
        # arguments
    }

    The following arguments are supported:

    Database string
    The name of the database
    Organization string
    The name of the organization the database belongs to
    Database string
    The name of the database
    Organization string
    The name of the organization the database belongs to
    database string
    The name of the database
    organization string
    The name of the organization the database belongs to
    database String
    The name of the database
    organization String
    The name of the organization the database belongs to
    database string
    The name of the database
    organization string
    The name of the organization the database belongs to
    database str
    The name of the database
    organization str
    The name of the organization the database belongs to
    database String
    The name of the database
    organization String
    The name of the organization the database belongs to

    getPostgresIpRestrictions Result

    The following output properties are available:

    Database string
    The name of the database
    Datas List<GetPostgresIpRestrictionsData>
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    The name of the organization the database belongs to
    Database string
    The name of the database
    Datas []GetPostgresIpRestrictionsData
    Id string
    The provider-assigned unique ID for this managed resource.
    Organization string
    The name of the organization the database belongs to
    database string
    The name of the database
    datas list(object)
    id string
    The provider-assigned unique ID for this managed resource.
    organization string
    The name of the organization the database belongs to
    database String
    The name of the database
    datas List<GetPostgresIpRestrictionsData>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    The name of the organization the database belongs to
    database string
    The name of the database
    datas GetPostgresIpRestrictionsData[]
    id string
    The provider-assigned unique ID for this managed resource.
    organization string
    The name of the organization the database belongs to
    database str
    The name of the database
    datas Sequence[GetPostgresIpRestrictionsData]
    id str
    The provider-assigned unique ID for this managed resource.
    organization str
    The name of the organization the database belongs to
    database String
    The name of the database
    datas List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    The name of the organization the database belongs to

    Supporting Types

    GetPostgresIpRestrictionsData

    Actor GetPostgresIpRestrictionsDataActor
    Cidrs List<string>
    The IPv4 ranges allowed to connect, in CIDR notation.
    Description string
    A description of the entry.
    Id string
    The ID of the IP restriction entry
    Role string
    The Postgres role the entry applies to. Empty when it applies to all roles.
    Schema string
    The Postgres schema the entry applies to. Empty when it applies to all schemas.
    Actor GetPostgresIpRestrictionsDataActor
    Cidrs []string
    The IPv4 ranges allowed to connect, in CIDR notation.
    Description string
    A description of the entry.
    Id string
    The ID of the IP restriction entry
    Role string
    The Postgres role the entry applies to. Empty when it applies to all roles.
    Schema string
    The Postgres schema the entry applies to. Empty when it applies to all schemas.
    actor object
    cidrs list(string)
    The IPv4 ranges allowed to connect, in CIDR notation.
    description string
    A description of the entry.
    id string
    The ID of the IP restriction entry
    role string
    The Postgres role the entry applies to. Empty when it applies to all roles.
    schema string
    The Postgres schema the entry applies to. Empty when it applies to all schemas.
    actor GetPostgresIpRestrictionsDataActor
    cidrs List<String>
    The IPv4 ranges allowed to connect, in CIDR notation.
    description String
    A description of the entry.
    id String
    The ID of the IP restriction entry
    role String
    The Postgres role the entry applies to. Empty when it applies to all roles.
    schema String
    The Postgres schema the entry applies to. Empty when it applies to all schemas.
    actor GetPostgresIpRestrictionsDataActor
    cidrs string[]
    The IPv4 ranges allowed to connect, in CIDR notation.
    description string
    A description of the entry.
    id string
    The ID of the IP restriction entry
    role string
    The Postgres role the entry applies to. Empty when it applies to all roles.
    schema string
    The Postgres schema the entry applies to. Empty when it applies to all schemas.
    actor GetPostgresIpRestrictionsDataActor
    cidrs Sequence[str]
    The IPv4 ranges allowed to connect, in CIDR notation.
    description str
    A description of the entry.
    id str
    The ID of the IP restriction entry
    role str
    The Postgres role the entry applies to. Empty when it applies to all roles.
    schema str
    The Postgres schema the entry applies to. Empty when it applies to all schemas.
    actor Property Map
    cidrs List<String>
    The IPv4 ranges allowed to connect, in CIDR notation.
    description String
    A description of the entry.
    id String
    The ID of the IP restriction entry
    role String
    The Postgres role the entry applies to. Empty when it applies to all roles.
    schema String
    The Postgres schema the entry applies to. Empty when it applies to all schemas.

    GetPostgresIpRestrictionsDataActor

    Id string
    The ID of the actor
    Id string
    The ID of the actor
    id string
    The ID of the actor
    id String
    The ID of the actor
    id string
    The ID of the actor
    id str
    The ID of the actor
    id String
    The ID of the actor

    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