@pulumi/linode
Version:
A Pulumi package for creating and managing linode cloud resources.
193 lines (192 loc) • 6.63 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "./types/output";
/**
* > **DEPRECATION NOTICE:** This data source has been deprecated. Please use linode.DatabasePostgresqlV2 for all future implementations.
*
* Provides information about a Linode PostgreSQL Database.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-backups).
*
* ## Example Usage
*
* Get information about a PostgreSQL database:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_db = linode.getDatabasePostgresql({
* id: 12345,
* });
* ```
*
* ## updates
*
* The following arguments are exported by the `updates` specification block:
*
* * `dayOfWeek` - The day to perform maintenance. (`monday`, `tuesday`, ...)
*
* * `duration` - The maximum maintenance window time in hours. (`1`..`3`)
*
* * `frequency` - Whether maintenance occurs on a weekly or monthly basis. (`weekly`, `monthly`)
*
* * `hourOfDay` - The hour to begin maintenance based in UTC time. (`0`..`23`)
*
* * `weekOfMonth` - The week of the month to perform monthly frequency updates. Required for `monthly` frequency updates. (`1`..`4`)
*/
export declare function getDatabasePostgresql(args?: GetDatabasePostgresqlArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabasePostgresqlResult>;
/**
* A collection of arguments for invoking getDatabasePostgresql.
*/
export interface GetDatabasePostgresqlArgs {
/**
* The ID of the PostgreSQL database. Deprecated: Use id instead.
*
* @deprecated Configure `id` instead. This attribute will be removed in the next major version of the provider.
*/
databaseId?: number;
/**
* The ID of the PostgreSQL database. Mutually exclusive with `databaseId`.
*/
id?: number;
}
/**
* A collection of values returned by getDatabasePostgresql.
*/
export interface GetDatabasePostgresqlResult {
/**
* A list of IP addresses that can access the Managed Database. Each item can be a single IP address or a range in CIDR format.
*/
readonly allowLists: string[];
/**
* The base64-encoded SSL CA certificate for the Managed Database instance.
*/
readonly caCert: string;
/**
* The number of Linode Instance nodes deployed to the Managed Database.
*/
readonly clusterSize: number;
/**
* When this Managed Database was created.
*/
readonly created: string;
/**
* @deprecated Configure `id` instead. This attribute will be removed in the next major version of the provider.
*/
readonly databaseId?: number;
/**
* Whether the Managed Databases is encrypted.
*/
readonly encrypted: boolean;
/**
* The Managed Database engine. (e.g. `postgresql`)
*/
readonly engine: string;
/**
* The Managed Database engine in engine/version format. (e.g. `postgresql/13.2`)
*/
readonly engineId: string;
/**
* The primary host for the Managed Database.
*/
readonly hostPrimary: string;
/**
* The secondary/private network host for the Managed Database.
*/
readonly hostSecondary: string;
readonly id?: number;
/**
* A unique, user-defined string referring to the Managed Database.
*/
readonly label: string;
readonly port: number;
/**
* The region that hosts this Linode Managed Database.
*/
readonly region: string;
/**
* (Optional) The synchronization level of the replicating server. (`on`, `local`, `remoteWrite`, `remoteApply`, `off`)
*/
readonly replicationCommitType: string;
/**
* The replication method used for the Managed Database. (`none`, `asynch`, `semiSynch`)
*/
readonly replicationType: string;
/**
* The randomly-generated root password for the Managed Database instance.
*/
readonly rootPassword: string;
/**
* The root username for the Managed Database instance.
*/
readonly rootUsername: string;
/**
* Whether to require SSL credentials to establish a connection to the Managed Database.
*/
readonly sslConnection: boolean;
/**
* The operating status of the Managed Database.
*/
readonly status: string;
/**
* The Linode Instance type used for the nodes of the Managed Database instance.
*/
readonly type: string;
/**
* When this Managed Database was last updated.
*/
readonly updated: string;
readonly updates: outputs.GetDatabasePostgresqlUpdate[];
/**
* The Managed Database engine version. (e.g. `v8.0.26`)
*/
readonly version: string;
}
/**
* > **DEPRECATION NOTICE:** This data source has been deprecated. Please use linode.DatabasePostgresqlV2 for all future implementations.
*
* Provides information about a Linode PostgreSQL Database.
* For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-databases-postgre-sql-instance-backups).
*
* ## Example Usage
*
* Get information about a PostgreSQL database:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as linode from "@pulumi/linode";
*
* const my_db = linode.getDatabasePostgresql({
* id: 12345,
* });
* ```
*
* ## updates
*
* The following arguments are exported by the `updates` specification block:
*
* * `dayOfWeek` - The day to perform maintenance. (`monday`, `tuesday`, ...)
*
* * `duration` - The maximum maintenance window time in hours. (`1`..`3`)
*
* * `frequency` - Whether maintenance occurs on a weekly or monthly basis. (`weekly`, `monthly`)
*
* * `hourOfDay` - The hour to begin maintenance based in UTC time. (`0`..`23`)
*
* * `weekOfMonth` - The week of the month to perform monthly frequency updates. Required for `monthly` frequency updates. (`1`..`4`)
*/
export declare function getDatabasePostgresqlOutput(args?: GetDatabasePostgresqlOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatabasePostgresqlResult>;
/**
* A collection of arguments for invoking getDatabasePostgresql.
*/
export interface GetDatabasePostgresqlOutputArgs {
/**
* The ID of the PostgreSQL database. Deprecated: Use id instead.
*
* @deprecated Configure `id` instead. This attribute will be removed in the next major version of the provider.
*/
databaseId?: pulumi.Input<number>;
/**
* The ID of the PostgreSQL database. Mutually exclusive with `databaseId`.
*/
id?: pulumi.Input<number>;
}