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
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 dictionarydata "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<Get
Postgres Read Only 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 Read Only 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 Read Only 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 Read Only 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 Read Only 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
GetPostgresReadOnlyReplicasData
- 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