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

    Deprecated. Use planetscale.getPostgresDedicatedReadReplicas instead.

    Using getPostgresReadOnlyReplicas

    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 getPostgresReadOnlyReplicas(args: GetPostgresReadOnlyReplicasArgs, opts?: InvokeOptions): Promise<GetPostgresReadOnlyReplicasResult>
    function getPostgresReadOnlyReplicasOutput(args: GetPostgresReadOnlyReplicasOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresReadOnlyReplicasResult>
    def get_postgres_read_only_replicas(branch: Optional[str] = None,
                                        database: Optional[str] = None,
                                        organization: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetPostgresReadOnlyReplicasResult
    def get_postgres_read_only_replicas_output(branch: pulumi.Input[Optional[str]] = None,
                                        database: pulumi.Input[Optional[str]] = None,
                                        organization: pulumi.Input[Optional[str]] = None,
                                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresReadOnlyReplicasResult]
    func GetPostgresReadOnlyReplicas(ctx *Context, args *GetPostgresReadOnlyReplicasArgs, opts ...InvokeOption) (*GetPostgresReadOnlyReplicasResult, error)
    func GetPostgresReadOnlyReplicasOutput(ctx *Context, args *GetPostgresReadOnlyReplicasOutputArgs, opts ...InvokeOption) GetPostgresReadOnlyReplicasResultOutput

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

    public static class GetPostgresReadOnlyReplicas 
    {
        public static Task<GetPostgresReadOnlyReplicasResult> InvokeAsync(GetPostgresReadOnlyReplicasArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresReadOnlyReplicasResult> Invoke(GetPostgresReadOnlyReplicasInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetPostgresReadOnlyReplicasResult> Invoke(GetPostgresReadOnlyReplicasInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetPostgresReadOnlyReplicasResult> getPostgresReadOnlyReplicas(GetPostgresReadOnlyReplicasArgs args, InvokeOptions options)
    public static Output<GetPostgresReadOnlyReplicasResult> getPostgresReadOnlyReplicas(GetPostgresReadOnlyReplicasArgs args, InvokeOptions options)
    public static Output<GetPostgresReadOnlyReplicasResult> getPostgresReadOnlyReplicas(GetPostgresReadOnlyReplicasArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: planetscale:index/getPostgresReadOnlyReplicas:getPostgresReadOnlyReplicas
      arguments:
        # arguments dictionary
    data "planetscale_get_postgres_read_only_replicas" "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.

    getPostgresReadOnlyReplicas 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.
    Datas List<GetPostgresReadOnlyReplicasData>
    Returns dedicated read replicas.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    Datas []GetPostgresReadOnlyReplicasData
    Returns dedicated read replicas.
    Id string
    The provider-assigned unique ID for this managed resource.
    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.
    datas list(object)
    Returns dedicated read replicas.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    datas List<GetPostgresReadOnlyReplicasData>
    Returns dedicated read replicas.
    id String
    The provider-assigned unique ID for this managed resource.
    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.
    datas GetPostgresReadOnlyReplicasData[]
    Returns dedicated read replicas.
    id string
    The provider-assigned unique ID for this managed resource.
    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.
    datas Sequence[GetPostgresReadOnlyReplicasData]
    Returns dedicated read replicas.
    id str
    The provider-assigned unique ID for this managed resource.
    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.
    datas List<Property Map>
    Returns dedicated read replicas.
    id String
    The provider-assigned unique ID for this managed resource.
    organization String
    Organization name slug from list_organizations. Example: acme.

    Supporting Types

    GetPostgresReadOnlyReplicasData

    AccessHostUrl string
    The database connection host for the dedicated read replica.
    ClusterSize string
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    Name string
    The name of the dedicated read replica.
    PrivateAccessHostUrl string
    The private database connection host for the dedicated read replica.
    PrivateConnectionServiceName string
    The service name to set up private connectivity for the dedicated read replica.
    Replicas double
    The number of instances serving reads in this dedicated read replica.
    AccessHostUrl string
    The database connection host for the dedicated read replica.
    ClusterSize string
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    Name string
    The name of the dedicated read replica.
    PrivateAccessHostUrl string
    The private database connection host for the dedicated read replica.
    PrivateConnectionServiceName string
    The service name to set up private connectivity for the dedicated read replica.
    Replicas float64
    The number of instances serving reads in this dedicated read replica.
    access_host_url string
    The database connection host for the dedicated read replica.
    cluster_size string
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    name string
    The name of the dedicated read replica.
    private_access_host_url string
    The private database connection host for the dedicated read replica.
    private_connection_service_name string
    The service name to set up private connectivity for the dedicated read replica.
    replicas number
    The number of instances serving reads in this dedicated read replica.
    accessHostUrl String
    The database connection host for the dedicated read replica.
    clusterSize String
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    name String
    The name of the dedicated read replica.
    privateAccessHostUrl String
    The private database connection host for the dedicated read replica.
    privateConnectionServiceName String
    The service name to set up private connectivity for the dedicated read replica.
    replicas Double
    The number of instances serving reads in this dedicated read replica.
    accessHostUrl string
    The database connection host for the dedicated read replica.
    clusterSize string
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    name string
    The name of the dedicated read replica.
    privateAccessHostUrl string
    The private database connection host for the dedicated read replica.
    privateConnectionServiceName string
    The service name to set up private connectivity for the dedicated read replica.
    replicas number
    The number of instances serving reads in this dedicated read replica.
    access_host_url str
    The database connection host for the dedicated read replica.
    cluster_size str
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    name str
    The name of the dedicated read replica.
    private_access_host_url str
    The private database connection host for the dedicated read replica.
    private_connection_service_name str
    The service name to set up private connectivity for the dedicated read replica.
    replicas float
    The number of instances serving reads in this dedicated read replica.
    accessHostUrl String
    The database connection host for the dedicated read replica.
    clusterSize String
    The cluster size SKU, e.g. PS_10_AWS_ARM. Defaults to the primary's cluster size.
    name String
    The name of the dedicated read replica.
    privateAccessHostUrl String
    The private database connection host for the dedicated read replica.
    privateConnectionServiceName String
    The service name to set up private connectivity for the dedicated read replica.
    replicas Number
    The number of instances serving reads in this dedicated read replica.

    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