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.PostgresDedicatedReadReplica instead.
Using getPostgresReadOnlyReplica
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 getPostgresReadOnlyReplica(args: GetPostgresReadOnlyReplicaArgs, opts?: InvokeOptions): Promise<GetPostgresReadOnlyReplicaResult>
function getPostgresReadOnlyReplicaOutput(args: GetPostgresReadOnlyReplicaOutputArgs, opts?: InvokeOutputOptions): Output<GetPostgresReadOnlyReplicaResult>def get_postgres_read_only_replica(branch: Optional[str] = None,
database: Optional[str] = None,
name: Optional[str] = None,
organization: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPostgresReadOnlyReplicaResult
def get_postgres_read_only_replica_output(branch: pulumi.Input[Optional[str]] = None,
database: pulumi.Input[Optional[str]] = None,
name: pulumi.Input[Optional[str]] = None,
organization: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetPostgresReadOnlyReplicaResult]func LookupPostgresReadOnlyReplica(ctx *Context, args *LookupPostgresReadOnlyReplicaArgs, opts ...InvokeOption) (*LookupPostgresReadOnlyReplicaResult, error)
func LookupPostgresReadOnlyReplicaOutput(ctx *Context, args *LookupPostgresReadOnlyReplicaOutputArgs, opts ...InvokeOption) LookupPostgresReadOnlyReplicaResultOutput> Note: This function is named LookupPostgresReadOnlyReplica in the Go SDK.
public static class GetPostgresReadOnlyReplica
{
public static Task<GetPostgresReadOnlyReplicaResult> InvokeAsync(GetPostgresReadOnlyReplicaArgs args, InvokeOptions? opts = null)
public static Output<GetPostgresReadOnlyReplicaResult> Invoke(GetPostgresReadOnlyReplicaInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetPostgresReadOnlyReplicaResult> Invoke(GetPostgresReadOnlyReplicaInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetPostgresReadOnlyReplicaResult> getPostgresReadOnlyReplica(GetPostgresReadOnlyReplicaArgs args, InvokeOptions options)
public static Output<GetPostgresReadOnlyReplicaResult> getPostgresReadOnlyReplica(GetPostgresReadOnlyReplicaArgs args, InvokeOptions options)
public static Output<GetPostgresReadOnlyReplicaResult> getPostgresReadOnlyReplica(GetPostgresReadOnlyReplicaArgs args, InvokeOutputOptions options)
fn::invoke:
function: planetscale:index/getPostgresReadOnlyReplica:getPostgresReadOnlyReplica
arguments:
# arguments dictionarydata "planetscale_get_postgres_read_only_replica" "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. - Name string
- The name of the dedicated read replica.
- 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. - Name string
- The name of the dedicated read replica.
- 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. - name string
- The name of the dedicated read replica.
- 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. - name String
- The name of the dedicated read replica.
- 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. - name string
- The name of the dedicated read replica.
- 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. - name str
- The name of the dedicated read replica.
- 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. - name String
- The name of the dedicated read replica.
- organization String
- Organization name slug from
list_organizations. Example:acme.
getPostgresReadOnlyReplica Result
The following output properties are available:
- Access
Host stringUrl - The database connection host for the dedicated read replica.
- Branch string
- Branch name from
list_branches. Example:main. - Cluster
Size string - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - Database string
- Database name slug from
list_databases. Example:app-db. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the dedicated read replica.
- Organization string
- Organization name slug from
list_organizations. Example:acme. - 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.
- Region string
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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.
- Branch string
- Branch name from
list_branches. Example:main. - Cluster
Size string - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - Database string
- Database name slug from
list_databases. Example:app-db. - Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the dedicated read replica.
- Organization string
- Organization name slug from
list_organizations. Example:acme. - 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.
- Region string
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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.
- branch string
- Branch name from
list_branches. Example:main. - cluster_
size string - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - database string
- Database name slug from
list_databases. Example:app-db. - id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the dedicated read replica.
- organization string
- Organization name slug from
list_organizations. Example:acme. - 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.
- region string
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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.
- branch String
- Branch name from
list_branches. Example:main. - cluster
Size String - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - database String
- Database name slug from
list_databases. Example:app-db. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the dedicated read replica.
- organization String
- Organization name slug from
list_organizations. Example:acme. - 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.
- region String
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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.
- branch string
- Branch name from
list_branches. Example:main. - cluster
Size string - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - database string
- Database name slug from
list_databases. Example:app-db. - id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the dedicated read replica.
- organization string
- Organization name slug from
list_organizations. Example:acme. - 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.
- region string
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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.
- branch str
- Branch name from
list_branches. Example:main. - cluster_
size str - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - database str
- Database name slug from
list_databases. Example:app-db. - id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the dedicated read replica.
- organization str
- Organization name slug from
list_organizations. Example:acme. - 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.
- region str
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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.
- branch String
- Branch name from
list_branches. Example:main. - cluster
Size String - The cluster size SKU, e.g.
PS_10_AWS_ARM. Defaults to the primary's cluster size. - database String
- Database name slug from
list_databases. Example:app-db. - id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the dedicated read replica.
- organization String
- Organization name slug from
list_organizations. Example:acme. - 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.
- region String
- The region slug for the dedicated read replica, e.g.
us-east. The dedicated read replica can run in a different region than the primary. - 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