UNPKG

@pulumi/linode

Version:

A Pulumi package for creating and managing linode cloud resources.

111 lines (110 loc) 3.56 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "./types/input"; import * as outputs from "./types/output"; /** * Provides information about Linode Managed Databases that match a set of filters. * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-databases-instances). * * ## Example Usage * * Get information about all Linode Managed Databases: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as linode from "@pulumi/linode"; * * const all = linode.getDatabases({}); * export const databaseIds = all.then(all => all.databases.map(__item => __item.id)); * ``` * * Get information about all Linode MySQL Databases: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as linode from "@pulumi/linode"; * * const mysql = linode.getDatabases({ * filters: [{ * name: "engine", * values: ["mysql"], * }], * }); * export const databaseIds = mysql.then(mysql => mysql.databases.map(__item => __item.id)); * ``` */ export declare function getDatabases(args?: GetDatabasesArgs, opts?: pulumi.InvokeOptions): Promise<GetDatabasesResult>; /** * A collection of arguments for invoking getDatabases. */ export interface GetDatabasesArgs { databases?: inputs.GetDatabasesDatabase[]; filters?: inputs.GetDatabasesFilter[]; /** * The order in which results should be returned. (`asc`, `desc`; default `asc`) */ order?: string; /** * The attribute to order the results by. (`version`) */ orderBy?: string; } /** * A collection of values returned by getDatabases. */ export interface GetDatabasesResult { readonly databases?: outputs.GetDatabasesDatabase[]; readonly filters?: outputs.GetDatabasesFilter[]; /** * The ID of the Managed Database. */ readonly id: string; readonly order?: string; readonly orderBy?: string; } /** * Provides information about Linode Managed Databases that match a set of filters. * For more information, see the [Linode APIv4 docs](https://techdocs.akamai.com/linode-api/reference/get-databases-instances). * * ## Example Usage * * Get information about all Linode Managed Databases: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as linode from "@pulumi/linode"; * * const all = linode.getDatabases({}); * export const databaseIds = all.then(all => all.databases.map(__item => __item.id)); * ``` * * Get information about all Linode MySQL Databases: * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as linode from "@pulumi/linode"; * * const mysql = linode.getDatabases({ * filters: [{ * name: "engine", * values: ["mysql"], * }], * }); * export const databaseIds = mysql.then(mysql => mysql.databases.map(__item => __item.id)); * ``` */ export declare function getDatabasesOutput(args?: GetDatabasesOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDatabasesResult>; /** * A collection of arguments for invoking getDatabases. */ export interface GetDatabasesOutputArgs { databases?: pulumi.Input<pulumi.Input<inputs.GetDatabasesDatabaseArgs>[]>; filters?: pulumi.Input<pulumi.Input<inputs.GetDatabasesFilterArgs>[]>; /** * The order in which results should be returned. (`asc`, `desc`; default `asc`) */ order?: pulumi.Input<string>; /** * The attribute to order the results by. (`version`) */ orderBy?: pulumi.Input<string>; }