Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
published on Thursday, Nov 12, 2026 by planetscale
planetscale
Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
published on Thursday, Nov 12, 2026 by planetscale
PostgresDedicatedReadReplicas DataSource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as planetscale from "@pulumi/planetscale";
const myPostgresdedicatedreadreplicas = planetscale.getPostgresDedicatedReadReplicas({
branch: "...my_branch...",
database: "...my_database...",
organization: "...my_organization...",
});
import pulumi
import pulumi_planetscale as planetscale
my_postgresdedicatedreadreplicas = planetscale.get_postgres_dedicated_read_replicas(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.GetPostgresDedicatedReadReplicas(ctx, &planetscale.GetPostgresDedicatedReadReplicasArgs{
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 myPostgresdedicatedreadreplicas = Planetscale.GetPostgresDedicatedReadReplicas.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.GetPostgresDedicatedReadReplicasArgs;
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 myPostgresdedicatedreadreplicas = PlanetscaleFunctions.getPostgresDedicatedReadReplicas(GetPostgresDedicatedReadReplicasArgs.builder()
.branch("...my_branch...")
.database("...my_database...")
.organization("...my_organization...")
.build());
}
}
variables:
myPostgresdedicatedreadreplicas:
fn::invoke:
function: planetscale:getPostgresDedicatedReadReplicas
arguments:
branch: '...my_branch...'
database: '...my_database...'
organization: '...my_organization...'
Example coming soon!
Using getPostgresDedicatedReadReplicas
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 getPostgresDedicatedReadReplicas(args: GetPostgresDedicatedReadReplicasArgs, opts?: InvokeOptions): Promise<GetPostgresDedicatedReadReplicasResult>
function getPostgresDedicatedReadReplicasOutput(args: GetPostgresDedicatedReadReplicasOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresDedicatedReadReplicasResult>def get_postgres_dedicated_read_replicas(branch: Optional[str] = None,
database: Optional[str] = None,
organization: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPostgresDedicatedReadReplicasResult
def get_postgres_dedicated_read_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[GetPostgresDedicatedReadReplicasResult]func GetPostgresDedicatedReadReplicas(ctx *Context, args *GetPostgresDedicatedReadReplicasArgs, opts ...InvokeOption) (*GetPostgresDedicatedReadReplicasResult, error)
func GetPostgresDedicatedReadReplicasOutput(ctx *Context, args *GetPostgresDedicatedReadReplicasOutputArgs, opts ...InvokeOption) GetPostgresDedicatedReadReplicasResultOutput> Note: This function is named GetPostgresDedicatedReadReplicas in the Go SDK.
public static class GetPostgresDedicatedReadReplicas
{
public static Task<GetPostgresDedicatedReadReplicasResult> InvokeAsync(GetPostgresDedicatedReadReplicasArgs args, InvokeOptions? opts = null)
public static Output<GetPostgresDedicatedReadReplicasResult> Invoke(GetPostgresDedicatedReadReplicasInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetPostgresDedicatedReadReplicasResult> Invoke(GetPostgresDedicatedReadReplicasInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetPostgresDedicatedReadReplicasResult> getPostgresDedicatedReadReplicas(GetPostgresDedicatedReadReplicasArgs args, InvokeOptions options)
public static Output<GetPostgresDedicatedReadReplicasResult> getPostgresDedicatedReadReplicas(GetPostgresDedicatedReadReplicasArgs args, InvokeOptions options)
public static Output<GetPostgresDedicatedReadReplicasResult> getPostgresDedicatedReadReplicas(GetPostgresDedicatedReadReplicasArgs args, InvokeOutputOptions options)
fn::invoke:
function: planetscale:index/getPostgresDedicatedReadReplicas:getPostgresDedicatedReadReplicas
arguments:
# arguments dictionarydata "planetscale_get_postgres_dedicated_read_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.
getPostgresDedicatedReadReplicas 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<Get
Postgres Dedicated Read Replicas Data> - 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
[]Get
Postgres Dedicated Read Replicas Data - 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<Get
Postgres Dedicated Read Replicas Data> - 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
Get
Postgres Dedicated Read Replicas Data[] - 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[Get
Postgres Dedicated Read Replicas Data] - 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
GetPostgresDedicatedReadReplicasData
- Access
Host stringUrl - 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 stringHost Url - The private database connection host for the dedicated read replica.
- Private
Connection stringService Name - 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.
- Access
Host stringUrl - 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 stringHost Url - The private database connection host for the dedicated read replica.
- Private
Connection stringService Name - 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_ stringurl - 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_ stringhost_ url - The private database connection host for the dedicated read replica.
- private_
connection_ stringservice_ name - 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 StringUrl - 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 StringHost Url - The private database connection host for the dedicated read replica.
- private
Connection StringService Name - 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.
- access
Host stringUrl - 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 stringHost Url - The private database connection host for the dedicated read replica.
- private
Connection stringService Name - 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_ strurl - 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_ strhost_ url - The private database connection host for the dedicated read replica.
- private_
connection_ strservice_ name - 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.
- access
Host StringUrl - 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 StringHost Url - The private database connection host for the dedicated read replica.
- private
Connection StringService Name - 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
planetscaleTerraform Provider.
planetscale
Viewing docs for planetscale 1.20.0
published on Thursday, Nov 12, 2026 by planetscale
published on Thursday, Nov 12, 2026 by planetscale