1. Packages
  2. pgEdge
  3. API Docs
  4. getDatabases
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge

pgedge.getDatabases

Explore with Pulumi AI

pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge

Data source for pgEdge databases

Using getDatabases

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 getDatabases(opts?: InvokeOptions): Promise<GetDatabasesResult>
function getDatabasesOutput(opts?: InvokeOptions): Output<GetDatabasesResult>
Copy
def get_databases(opts: Optional[InvokeOptions] = None) -> GetDatabasesResult
def get_databases_output(opts: Optional[InvokeOptions] = None) -> Output[GetDatabasesResult]
Copy
func GetDatabases(ctx *Context, opts ...InvokeOption) (*GetDatabasesResult, error)
func GetDatabasesOutput(ctx *Context, opts ...InvokeOption) GetDatabasesResultOutput
Copy

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

public static class GetDatabases 
{
    public static Task<GetDatabasesResult> InvokeAsync(InvokeOptions? opts = null)
    public static Output<GetDatabasesResult> Invoke(InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDatabasesResult> getDatabases(InvokeOptions options)
public static Output<GetDatabasesResult> getDatabases(InvokeOptions options)
Copy
fn::invoke:
  function: pgedge:index/getDatabases:getDatabases
  arguments:
    # arguments dictionary
Copy

getDatabases Result

The following output properties are available:

Databases List<Pgedge.Pgedge.Outputs.GetDatabasesDatabase>
Id string
The provider-assigned unique ID for this managed resource.
Databases []GetDatabasesDatabase
Id string
The provider-assigned unique ID for this managed resource.
databases List<GetDatabasesDatabase>
id String
The provider-assigned unique ID for this managed resource.
databases GetDatabasesDatabase[]
id string
The provider-assigned unique ID for this managed resource.
databases Sequence[GetDatabasesDatabase]
id str
The provider-assigned unique ID for this managed resource.
databases List<Property Map>
id String
The provider-assigned unique ID for this managed resource.

Supporting Types

GetDatabasesDatabase

Backups This property is required. Pgedge.Pgedge.Inputs.GetDatabasesDatabaseBackups
Backup configuration for the database
ClusterId This property is required. string
ID of the cluster this database belongs to
Components This property is required. List<Pgedge.Pgedge.Inputs.GetDatabasesDatabaseComponent>
Components of the database
ConfigVersion This property is required. string
Configuration version of the database
CreatedAt This property is required. string
Creation timestamp of the database
DisplayName This property is required. string
Display name for the database. Maximum length is 25 characters.
Domain This property is required. string
Domain of the database
Extensions This property is required. Pgedge.Pgedge.Inputs.GetDatabasesDatabaseExtensions
Extensions configuration for the database
Id This property is required. string
ID of the database
Name This property is required. string
Name of the database
Nodes This property is required. Dictionary<string, Pgedge.Pgedge.Inputs.GetDatabasesDatabaseNodes>
Map of nodes in the database
Options This property is required. List<string>
Options for the database
PgVersion This property is required. string
PostgreSQL version of the database
Roles This property is required. List<Pgedge.Pgedge.Inputs.GetDatabasesDatabaseRole>
Roles in the database
Status This property is required. string
Status of the database
Backups This property is required. GetDatabasesDatabaseBackups
Backup configuration for the database
ClusterId This property is required. string
ID of the cluster this database belongs to
Components This property is required. []GetDatabasesDatabaseComponent
Components of the database
ConfigVersion This property is required. string
Configuration version of the database
CreatedAt This property is required. string
Creation timestamp of the database
DisplayName This property is required. string
Display name for the database. Maximum length is 25 characters.
Domain This property is required. string
Domain of the database
Extensions This property is required. GetDatabasesDatabaseExtensions
Extensions configuration for the database
Id This property is required. string
ID of the database
Name This property is required. string
Name of the database
Nodes This property is required. map[string]GetDatabasesDatabaseNodes
Map of nodes in the database
Options This property is required. []string
Options for the database
PgVersion This property is required. string
PostgreSQL version of the database
Roles This property is required. []GetDatabasesDatabaseRole
Roles in the database
Status This property is required. string
Status of the database
backups This property is required. GetDatabasesDatabaseBackups
Backup configuration for the database
clusterId This property is required. String
ID of the cluster this database belongs to
components This property is required. List<GetDatabasesDatabaseComponent>
Components of the database
configVersion This property is required. String
Configuration version of the database
createdAt This property is required. String
Creation timestamp of the database
displayName This property is required. String
Display name for the database. Maximum length is 25 characters.
domain This property is required. String
Domain of the database
extensions This property is required. GetDatabasesDatabaseExtensions
Extensions configuration for the database
id This property is required. String
ID of the database
name This property is required. String
Name of the database
nodes This property is required. Map<String,GetDatabasesDatabaseNodes>
Map of nodes in the database
options This property is required. List<String>
Options for the database
pgVersion This property is required. String
PostgreSQL version of the database
roles This property is required. List<GetDatabasesDatabaseRole>
Roles in the database
status This property is required. String
Status of the database
backups This property is required. GetDatabasesDatabaseBackups
Backup configuration for the database
clusterId This property is required. string
ID of the cluster this database belongs to
components This property is required. GetDatabasesDatabaseComponent[]
Components of the database
configVersion This property is required. string
Configuration version of the database
createdAt This property is required. string
Creation timestamp of the database
displayName This property is required. string
Display name for the database. Maximum length is 25 characters.
domain This property is required. string
Domain of the database
extensions This property is required. GetDatabasesDatabaseExtensions
Extensions configuration for the database
id This property is required. string
ID of the database
name This property is required. string
Name of the database
nodes This property is required. {[key: string]: GetDatabasesDatabaseNodes}
Map of nodes in the database
options This property is required. string[]
Options for the database
pgVersion This property is required. string
PostgreSQL version of the database
roles This property is required. GetDatabasesDatabaseRole[]
Roles in the database
status This property is required. string
Status of the database
backups This property is required. GetDatabasesDatabaseBackups
Backup configuration for the database
cluster_id This property is required. str
ID of the cluster this database belongs to
components This property is required. Sequence[GetDatabasesDatabaseComponent]
Components of the database
config_version This property is required. str
Configuration version of the database
created_at This property is required. str
Creation timestamp of the database
display_name This property is required. str
Display name for the database. Maximum length is 25 characters.
domain This property is required. str
Domain of the database
extensions This property is required. GetDatabasesDatabaseExtensions
Extensions configuration for the database
id This property is required. str
ID of the database
name This property is required. str
Name of the database
nodes This property is required. Mapping[str, GetDatabasesDatabaseNodes]
Map of nodes in the database
options This property is required. Sequence[str]
Options for the database
pg_version This property is required. str
PostgreSQL version of the database
roles This property is required. Sequence[GetDatabasesDatabaseRole]
Roles in the database
status This property is required. str
Status of the database
backups This property is required. Property Map
Backup configuration for the database
clusterId This property is required. String
ID of the cluster this database belongs to
components This property is required. List<Property Map>
Components of the database
configVersion This property is required. String
Configuration version of the database
createdAt This property is required. String
Creation timestamp of the database
displayName This property is required. String
Display name for the database. Maximum length is 25 characters.
domain This property is required. String
Domain of the database
extensions This property is required. Property Map
Extensions configuration for the database
id This property is required. String
ID of the database
name This property is required. String
Name of the database
nodes This property is required. Map<Property Map>
Map of nodes in the database
options This property is required. List<String>
Options for the database
pgVersion This property is required. String
PostgreSQL version of the database
roles This property is required. List<Property Map>
Roles in the database
status This property is required. String
Status of the database

GetDatabasesDatabaseBackups

Configs This property is required. List<Pgedge.Pgedge.Inputs.GetDatabasesDatabaseBackupsConfig>
Backup configurations
Provider This property is required. string
Backup provider
Configs This property is required. []GetDatabasesDatabaseBackupsConfig
Backup configurations
Provider This property is required. string
Backup provider
configs This property is required. List<GetDatabasesDatabaseBackupsConfig>
Backup configurations
provider This property is required. String
Backup provider
configs This property is required. GetDatabasesDatabaseBackupsConfig[]
Backup configurations
provider This property is required. string
Backup provider
configs This property is required. Sequence[GetDatabasesDatabaseBackupsConfig]
Backup configurations
provider This property is required. str
Backup provider
configs This property is required. List<Property Map>
Backup configurations
provider This property is required. String
Backup provider

GetDatabasesDatabaseBackupsConfig

Id This property is required. string
Backup configuration ID
NodeName This property is required. string
Node name
Repositories This property is required. List<Pgedge.Pgedge.Inputs.GetDatabasesDatabaseBackupsConfigRepository>
Backup repositories
Schedules This property is required. List<Pgedge.Pgedge.Inputs.GetDatabasesDatabaseBackupsConfigSchedule>
Backup schedules
Id This property is required. string
Backup configuration ID
NodeName This property is required. string
Node name
Repositories This property is required. []GetDatabasesDatabaseBackupsConfigRepository
Backup repositories
Schedules This property is required. []GetDatabasesDatabaseBackupsConfigSchedule
Backup schedules
id This property is required. String
Backup configuration ID
nodeName This property is required. String
Node name
repositories This property is required. List<GetDatabasesDatabaseBackupsConfigRepository>
Backup repositories
schedules This property is required. List<GetDatabasesDatabaseBackupsConfigSchedule>
Backup schedules
id This property is required. string
Backup configuration ID
nodeName This property is required. string
Node name
repositories This property is required. GetDatabasesDatabaseBackupsConfigRepository[]
Backup repositories
schedules This property is required. GetDatabasesDatabaseBackupsConfigSchedule[]
Backup schedules
id This property is required. str
Backup configuration ID
node_name This property is required. str
Node name
repositories This property is required. Sequence[GetDatabasesDatabaseBackupsConfigRepository]
Backup repositories
schedules This property is required. Sequence[GetDatabasesDatabaseBackupsConfigSchedule]
Backup schedules
id This property is required. String
Backup configuration ID
nodeName This property is required. String
Node name
repositories This property is required. List<Property Map>
Backup repositories
schedules This property is required. List<Property Map>
Backup schedules

GetDatabasesDatabaseBackupsConfigRepository

AzureAccount This property is required. string
AzureContainer This property is required. string
AzureEndpoint This property is required. string
BackupStoreId This property is required. string
BasePath This property is required. string
GcsBucket This property is required. string
GcsEndpoint This property is required. string
Id This property is required. string
Backup configuration ID
RetentionFull This property is required. int
RetentionFullType This property is required. string
S3Bucket This property is required. string
S3Endpoint This property is required. string
S3Region This property is required. string
Type This property is required. string
AzureAccount This property is required. string
AzureContainer This property is required. string
AzureEndpoint This property is required. string
BackupStoreId This property is required. string
BasePath This property is required. string
GcsBucket This property is required. string
GcsEndpoint This property is required. string
Id This property is required. string
Backup configuration ID
RetentionFull This property is required. int
RetentionFullType This property is required. string
S3Bucket This property is required. string
S3Endpoint This property is required. string
S3Region This property is required. string
Type This property is required. string
azureAccount This property is required. String
azureContainer This property is required. String
azureEndpoint This property is required. String
backupStoreId This property is required. String
basePath This property is required. String
gcsBucket This property is required. String
gcsEndpoint This property is required. String
id This property is required. String
Backup configuration ID
retentionFull This property is required. Integer
retentionFullType This property is required. String
s3Bucket This property is required. String
s3Endpoint This property is required. String
s3Region This property is required. String
type This property is required. String
azureAccount This property is required. string
azureContainer This property is required. string
azureEndpoint This property is required. string
backupStoreId This property is required. string
basePath This property is required. string
gcsBucket This property is required. string
gcsEndpoint This property is required. string
id This property is required. string
Backup configuration ID
retentionFull This property is required. number
retentionFullType This property is required. string
s3Bucket This property is required. string
s3Endpoint This property is required. string
s3Region This property is required. string
type This property is required. string
azure_account This property is required. str
azure_container This property is required. str
azure_endpoint This property is required. str
backup_store_id This property is required. str
base_path This property is required. str
gcs_bucket This property is required. str
gcs_endpoint This property is required. str
id This property is required. str
Backup configuration ID
retention_full This property is required. int
retention_full_type This property is required. str
s3_bucket This property is required. str
s3_endpoint This property is required. str
s3_region This property is required. str
type This property is required. str
azureAccount This property is required. String
azureContainer This property is required. String
azureEndpoint This property is required. String
backupStoreId This property is required. String
basePath This property is required. String
gcsBucket This property is required. String
gcsEndpoint This property is required. String
id This property is required. String
Backup configuration ID
retentionFull This property is required. Number
retentionFullType This property is required. String
s3Bucket This property is required. String
s3Endpoint This property is required. String
s3Region This property is required. String
type This property is required. String

GetDatabasesDatabaseBackupsConfigSchedule

CronExpression This property is required. string
Id This property is required. string
Backup configuration ID
Type This property is required. string
CronExpression This property is required. string
Id This property is required. string
Backup configuration ID
Type This property is required. string
cronExpression This property is required. String
id This property is required. String
Backup configuration ID
type This property is required. String
cronExpression This property is required. string
id This property is required. string
Backup configuration ID
type This property is required. string
cron_expression This property is required. str
id This property is required. str
Backup configuration ID
type This property is required. str
cronExpression This property is required. String
id This property is required. String
Backup configuration ID
type This property is required. String

GetDatabasesDatabaseComponent

Id This property is required. string
Backup configuration ID
Name This property is required. string
Component name
ReleaseDate This property is required. string
Component release date
Status This property is required. string
Component status
Version This property is required. string
Component version
Id This property is required. string
Backup configuration ID
Name This property is required. string
Component name
ReleaseDate This property is required. string
Component release date
Status This property is required. string
Component status
Version This property is required. string
Component version
id This property is required. String
Backup configuration ID
name This property is required. String
Component name
releaseDate This property is required. String
Component release date
status This property is required. String
Component status
version This property is required. String
Component version
id This property is required. string
Backup configuration ID
name This property is required. string
Component name
releaseDate This property is required. string
Component release date
status This property is required. string
Component status
version This property is required. string
Component version
id This property is required. str
Backup configuration ID
name This property is required. str
Component name
release_date This property is required. str
Component release date
status This property is required. str
Component status
version This property is required. str
Component version
id This property is required. String
Backup configuration ID
name This property is required. String
Component name
releaseDate This property is required. String
Component release date
status This property is required. String
Component status
version This property is required. String
Component version

GetDatabasesDatabaseExtensions

AutoManage This property is required. bool
Auto-manage extensions
Availables This property is required. List<string>
Available extensions
Requesteds This property is required. List<string>
Requested extensions
AutoManage This property is required. bool
Auto-manage extensions
Availables This property is required. []string
Available extensions
Requesteds This property is required. []string
Requested extensions
autoManage This property is required. Boolean
Auto-manage extensions
availables This property is required. List<String>
Available extensions
requesteds This property is required. List<String>
Requested extensions
autoManage This property is required. boolean
Auto-manage extensions
availables This property is required. string[]
Available extensions
requesteds This property is required. string[]
Requested extensions
auto_manage This property is required. bool
Auto-manage extensions
availables This property is required. Sequence[str]
Available extensions
requesteds This property is required. Sequence[str]
Requested extensions
autoManage This property is required. Boolean
Auto-manage extensions
availables This property is required. List<String>
Available extensions
requesteds This property is required. List<String>
Requested extensions

GetDatabasesDatabaseNodes

Connection This property is required. Pgedge.Pgedge.Inputs.GetDatabasesDatabaseNodesConnection
Node connection details
Extensions This property is required. Pgedge.Pgedge.Inputs.GetDatabasesDatabaseNodesExtensions
Extensions configuration for the database
Location This property is required. Pgedge.Pgedge.Inputs.GetDatabasesDatabaseNodesLocation
Node location
Name This property is required. string
Component name
Region This property is required. Pgedge.Pgedge.Inputs.GetDatabasesDatabaseNodesRegion
Node region
Connection This property is required. GetDatabasesDatabaseNodesConnection
Node connection details
Extensions This property is required. GetDatabasesDatabaseNodesExtensions
Extensions configuration for the database
Location This property is required. GetDatabasesDatabaseNodesLocation
Node location
Name This property is required. string
Component name
Region This property is required. GetDatabasesDatabaseNodesRegion
Node region
connection This property is required. GetDatabasesDatabaseNodesConnection
Node connection details
extensions This property is required. GetDatabasesDatabaseNodesExtensions
Extensions configuration for the database
location This property is required. GetDatabasesDatabaseNodesLocation
Node location
name This property is required. String
Component name
region This property is required. GetDatabasesDatabaseNodesRegion
Node region
connection This property is required. GetDatabasesDatabaseNodesConnection
Node connection details
extensions This property is required. GetDatabasesDatabaseNodesExtensions
Extensions configuration for the database
location This property is required. GetDatabasesDatabaseNodesLocation
Node location
name This property is required. string
Component name
region This property is required. GetDatabasesDatabaseNodesRegion
Node region
connection This property is required. GetDatabasesDatabaseNodesConnection
Node connection details
extensions This property is required. GetDatabasesDatabaseNodesExtensions
Extensions configuration for the database
location This property is required. GetDatabasesDatabaseNodesLocation
Node location
name This property is required. str
Component name
region This property is required. GetDatabasesDatabaseNodesRegion
Node region
connection This property is required. Property Map
Node connection details
extensions This property is required. Property Map
Extensions configuration for the database
location This property is required. Property Map
Node location
name This property is required. String
Component name
region This property is required. Property Map
Node region

GetDatabasesDatabaseNodesConnection

Database This property is required. string
ExternalIpAddress This property is required. string
Host This property is required. string
InternalHost This property is required. string
InternalIpAddress This property is required. string
Password This property is required. string
Port This property is required. int
Username This property is required. string
Database This property is required. string
ExternalIpAddress This property is required. string
Host This property is required. string
InternalHost This property is required. string
InternalIpAddress This property is required. string
Password This property is required. string
Port This property is required. int
Username This property is required. string
database This property is required. String
externalIpAddress This property is required. String
host This property is required. String
internalHost This property is required. String
internalIpAddress This property is required. String
password This property is required. String
port This property is required. Integer
username This property is required. String
database This property is required. string
externalIpAddress This property is required. string
host This property is required. string
internalHost This property is required. string
internalIpAddress This property is required. string
password This property is required. string
port This property is required. number
username This property is required. string
database This property is required. str
external_ip_address This property is required. str
host This property is required. str
internal_host This property is required. str
internal_ip_address This property is required. str
password This property is required. str
port This property is required. int
username This property is required. str
database This property is required. String
externalIpAddress This property is required. String
host This property is required. String
internalHost This property is required. String
internalIpAddress This property is required. String
password This property is required. String
port This property is required. Number
username This property is required. String

GetDatabasesDatabaseNodesExtensions

Errors This property is required. Dictionary<string, string>
Installeds This property is required. List<string>
Errors This property is required. map[string]string
Installeds This property is required. []string
errors This property is required. Map<String,String>
installeds This property is required. List<String>
errors This property is required. {[key: string]: string}
installeds This property is required. string[]
errors This property is required. Mapping[str, str]
installeds This property is required. Sequence[str]
errors This property is required. Map<String>
installeds This property is required. List<String>

GetDatabasesDatabaseNodesLocation

City This property is required. string
Code This property is required. string
Country This property is required. string
Latitude This property is required. double
Longitude This property is required. double
MetroCode This property is required. string
Name This property is required. string
Component name
PostalCode This property is required. string
Region This property is required. string
RegionCode This property is required. string
Timezone This property is required. string
City This property is required. string
Code This property is required. string
Country This property is required. string
Latitude This property is required. float64
Longitude This property is required. float64
MetroCode This property is required. string
Name This property is required. string
Component name
PostalCode This property is required. string
Region This property is required. string
RegionCode This property is required. string
Timezone This property is required. string
city This property is required. String
code This property is required. String
country This property is required. String
latitude This property is required. Double
longitude This property is required. Double
metroCode This property is required. String
name This property is required. String
Component name
postalCode This property is required. String
region This property is required. String
regionCode This property is required. String
timezone This property is required. String
city This property is required. string
code This property is required. string
country This property is required. string
latitude This property is required. number
longitude This property is required. number
metroCode This property is required. string
name This property is required. string
Component name
postalCode This property is required. string
region This property is required. string
regionCode This property is required. string
timezone This property is required. string
city This property is required. str
code This property is required. str
country This property is required. str
latitude This property is required. float
longitude This property is required. float
metro_code This property is required. str
name This property is required. str
Component name
postal_code This property is required. str
region This property is required. str
region_code This property is required. str
timezone This property is required. str
city This property is required. String
code This property is required. String
country This property is required. String
latitude This property is required. Number
longitude This property is required. Number
metroCode This property is required. String
name This property is required. String
Component name
postalCode This property is required. String
region This property is required. String
regionCode This property is required. String
timezone This property is required. String

GetDatabasesDatabaseNodesRegion

Active This property is required. bool
AvailabilityZones This property is required. List<string>
Cloud This property is required. string
Code This property is required. string
Name This property is required. string
Component name
Parent This property is required. string
Active This property is required. bool
AvailabilityZones This property is required. []string
Cloud This property is required. string
Code This property is required. string
Name This property is required. string
Component name
Parent This property is required. string
active This property is required. Boolean
availabilityZones This property is required. List<String>
cloud This property is required. String
code This property is required. String
name This property is required. String
Component name
parent This property is required. String
active This property is required. boolean
availabilityZones This property is required. string[]
cloud This property is required. string
code This property is required. string
name This property is required. string
Component name
parent This property is required. string
active This property is required. bool
availability_zones This property is required. Sequence[str]
cloud This property is required. str
code This property is required. str
name This property is required. str
Component name
parent This property is required. str
active This property is required. Boolean
availabilityZones This property is required. List<String>
cloud This property is required. String
code This property is required. String
name This property is required. String
Component name
parent This property is required. String

GetDatabasesDatabaseRole

BypassRls This property is required. bool
ConnectionLimit This property is required. int
CreateDb This property is required. bool
CreateRole This property is required. bool
Inherit This property is required. bool
Login This property is required. bool
Name This property is required. string
Component name
Replication This property is required. bool
Superuser This property is required. bool
BypassRls This property is required. bool
ConnectionLimit This property is required. int
CreateDb This property is required. bool
CreateRole This property is required. bool
Inherit This property is required. bool
Login This property is required. bool
Name This property is required. string
Component name
Replication This property is required. bool
Superuser This property is required. bool
bypassRls This property is required. Boolean
connectionLimit This property is required. Integer
createDb This property is required. Boolean
createRole This property is required. Boolean
inherit This property is required. Boolean
login This property is required. Boolean
name This property is required. String
Component name
replication This property is required. Boolean
superuser This property is required. Boolean
bypassRls This property is required. boolean
connectionLimit This property is required. number
createDb This property is required. boolean
createRole This property is required. boolean
inherit This property is required. boolean
login This property is required. boolean
name This property is required. string
Component name
replication This property is required. boolean
superuser This property is required. boolean
bypass_rls This property is required. bool
connection_limit This property is required. int
create_db This property is required. bool
create_role This property is required. bool
inherit This property is required. bool
login This property is required. bool
name This property is required. str
Component name
replication This property is required. bool
superuser This property is required. bool
bypassRls This property is required. Boolean
connectionLimit This property is required. Number
createDb This property is required. Boolean
createRole This property is required. Boolean
inherit This property is required. Boolean
login This property is required. Boolean
name This property is required. String
Component name
replication This property is required. Boolean
superuser This property is required. Boolean

Package Details

Repository
pgedge pgEdge/pulumi-pgedge
License
Apache-2.0
Notes
This Pulumi package is based on the pgedge Terraform Provider.
pgEdge v0.0.40 published on Friday, Jan 10, 2025 by pgEdge