Docs Packages
  1. Pulumi Registry
  2. Linode
  3. API Docs
  4. getDatabases
linode logo
Linode v4.2.0, May 26 23

linode.getDatabases

Explore with Pulumi AI

Provides information about Linode Managed Databases that match a set of filters.

Example Usage

Get information about all Linode Managed Databases

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var all = Linode.GetDatabases.Invoke();

    return new Dictionary<string, object?>
    {
        ["databaseIds"] = all.Apply(getDatabasesResult => getDatabasesResult.Databases).Select(__item => __item.Id).ToList(),
    };
});

package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		all, err := linode.GetDatabases(ctx, nil, nil)
		if err != nil {
			return err
		}
		var splat0 []*int
		for _, val0 := range all.Databases {
			splat0 = append(splat0, val0.Id)
		}
		ctx.Export("databaseIds", splat0)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetDatabasesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var all = LinodeFunctions.getDatabases();

        ctx.export("databaseIds", all.applyValue(getDatabasesResult -> getDatabasesResult.databases()).stream().map(element -> element.id()).collect(toList()));
    }
}

import pulumi
import pulumi_linode as linode

all = linode.get_databases()
pulumi.export("databaseIds", [__item.id for __item in all.databases])

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));

Coming soon!

Get information about all Linode MySQL Databases

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var mysql = Linode.GetDatabases.Invoke(new()
    {
        Filters = new[]
        {
            new Linode.Inputs.GetDatabasesFilterInputArgs
            {
                Name = "engine",
                Values = new[]
                {
                    "mysql",
                },
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["databaseIds"] = mysql.Apply(getDatabasesResult => getDatabasesResult.Databases).Select(__item => __item.Id).ToList(),
    };
});

package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v4/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		mysql, err := linode.GetDatabases(ctx, &linode.GetDatabasesArgs{
			Filters: []linode.GetDatabasesFilter{
				{
					Name: "engine",
					Values: []string{
						"mysql",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		var splat0 []*int
		for _, val0 := range mysql.Databases {
			splat0 = append(splat0, val0.Id)
		}
		ctx.Export("databaseIds", splat0)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetDatabasesArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var mysql = LinodeFunctions.getDatabases(GetDatabasesArgs.builder()
            .filters(GetDatabasesFilterArgs.builder()
                .name("engine")
                .values("mysql")
                .build())
            .build());

        ctx.export("databaseIds", mysql.applyValue(getDatabasesResult -> getDatabasesResult.databases()).stream().map(element -> element.id()).collect(toList()));
    }
}

import pulumi
import pulumi_linode as linode

mysql = linode.get_databases(filters=[linode.GetDatabasesFilterArgs(
    name="engine",
    values=["mysql"],
)])
pulumi.export("databaseIds", [__item.id for __item in mysql.databases])

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));

Coming soon!

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(args: GetDatabasesArgs, opts?: InvokeOptions): Promise<GetDatabasesResult>
function getDatabasesOutput(args: GetDatabasesOutputArgs, opts?: InvokeOptions): Output<GetDatabasesResult>
def get_databases(filters: Optional[Sequence[GetDatabasesFilter]] = None,
                  latest: Optional[bool] = None,
                  order: Optional[str] = None,
                  order_by: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetDatabasesResult
def get_databases_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDatabasesFilterArgs]]]] = None,
                  latest: Optional[pulumi.Input[bool]] = None,
                  order: Optional[pulumi.Input[str]] = None,
                  order_by: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetDatabasesResult]
func GetDatabases(ctx *Context, args *GetDatabasesArgs, opts ...InvokeOption) (*GetDatabasesResult, error)
func GetDatabasesOutput(ctx *Context, args *GetDatabasesOutputArgs, opts ...InvokeOption) GetDatabasesResultOutput

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

public static class GetDatabases 
{
    public static Task<GetDatabasesResult> InvokeAsync(GetDatabasesArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabasesResult> Invoke(GetDatabasesInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatabasesResult> getDatabases(GetDatabasesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: linode:index/getDatabases:getDatabases
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetDatabasesFilter>
Latest bool

If true, only the latest create database will be returned.

  • filter - (Optional) A set of filters used to select databases that meet certain requirements.
Order string

The order in which results should be returned. (asc, desc; default asc)

OrderBy string

The attribute to order the results by. (version)

Filters []GetDatabasesFilter
Latest bool

If true, only the latest create database will be returned.

  • filter - (Optional) A set of filters used to select databases that meet certain requirements.
Order string

The order in which results should be returned. (asc, desc; default asc)

OrderBy string

The attribute to order the results by. (version)

filters List<GetDatabasesFilter>
latest Boolean

If true, only the latest create database will be returned.

  • filter - (Optional) A set of filters used to select databases that meet certain requirements.
order String

The order in which results should be returned. (asc, desc; default asc)

orderBy String

The attribute to order the results by. (version)

filters GetDatabasesFilter[]
latest boolean

If true, only the latest create database will be returned.

  • filter - (Optional) A set of filters used to select databases that meet certain requirements.
order string

The order in which results should be returned. (asc, desc; default asc)

orderBy string

The attribute to order the results by. (version)

filters Sequence[GetDatabasesFilter]
latest bool

If true, only the latest create database will be returned.

  • filter - (Optional) A set of filters used to select databases that meet certain requirements.
order str

The order in which results should be returned. (asc, desc; default asc)

order_by str

The attribute to order the results by. (version)

filters List<Property Map>
latest Boolean

If true, only the latest create database will be returned.

  • filter - (Optional) A set of filters used to select databases that meet certain requirements.
order String

The order in which results should be returned. (asc, desc; default asc)

orderBy String

The attribute to order the results by. (version)

getDatabases Result

The following output properties are available:

Databases List<GetDatabasesDatabase>
Id string

The provider-assigned unique ID for this managed resource.

Filters List<GetDatabasesFilter>
Latest bool
Order string
OrderBy string
Databases []GetDatabasesDatabase
Id string

The provider-assigned unique ID for this managed resource.

Filters []GetDatabasesFilter
Latest bool
Order string
OrderBy string
databases List<GetDatabasesDatabase>
id String

The provider-assigned unique ID for this managed resource.

filters List<GetDatabasesFilter>
latest Boolean
order String
orderBy String
databases GetDatabasesDatabase[]
id string

The provider-assigned unique ID for this managed resource.

filters GetDatabasesFilter[]
latest boolean
order string
orderBy string
databases Sequence[GetDatabasesDatabase]
id str

The provider-assigned unique ID for this managed resource.

filters Sequence[GetDatabasesFilter]
latest bool
order str
order_by str
databases List<Property Map>
id String

The provider-assigned unique ID for this managed resource.

filters List<Property Map>
latest Boolean
order String
orderBy String

Supporting Types

GetDatabasesDatabase

AllowLists List<string>

A list of IP addresses that can access the Managed Database.

ClusterSize int

The number of Linode Instance nodes deployed to the Managed Database.

Created string

When this Managed Database was created.

Encrypted bool

Whether the Managed Databases is encrypted.

Engine string

The Managed Database engine.

HostPrimary string

The primary host for the Managed Database.

HostSecondary string

The secondary/private network host for the Managed Database.

Id int

The ID of the Managed Database.

InstanceUri string
Label string

A unique, user-defined string referring to the Managed Database.

Region string

The region to use for the Managed Database.

ReplicationType string

The replication method used for the Managed Database.

SslConnection bool

Whether to require SSL credentials to establish a connection to the Managed Database.

Status string

The operating status of the Managed Database.

Type string

The Linode Instance type used for the nodes of the Managed Database instance.

Updated string

When this Managed Database was last updated.

Version string

The Managed Database engine version.

AllowLists []string

A list of IP addresses that can access the Managed Database.

ClusterSize int

The number of Linode Instance nodes deployed to the Managed Database.

Created string

When this Managed Database was created.

Encrypted bool

Whether the Managed Databases is encrypted.

Engine string

The Managed Database engine.

HostPrimary string

The primary host for the Managed Database.

HostSecondary string

The secondary/private network host for the Managed Database.

Id int

The ID of the Managed Database.

InstanceUri string
Label string

A unique, user-defined string referring to the Managed Database.

Region string

The region to use for the Managed Database.

ReplicationType string

The replication method used for the Managed Database.

SslConnection bool

Whether to require SSL credentials to establish a connection to the Managed Database.

Status string

The operating status of the Managed Database.

Type string

The Linode Instance type used for the nodes of the Managed Database instance.

Updated string

When this Managed Database was last updated.

Version string

The Managed Database engine version.

allowLists List<String>

A list of IP addresses that can access the Managed Database.

clusterSize Integer

The number of Linode Instance nodes deployed to the Managed Database.

created String

When this Managed Database was created.

encrypted Boolean

Whether the Managed Databases is encrypted.

engine String

The Managed Database engine.

hostPrimary String

The primary host for the Managed Database.

hostSecondary String

The secondary/private network host for the Managed Database.

id Integer

The ID of the Managed Database.

instanceUri String
label String

A unique, user-defined string referring to the Managed Database.

region String

The region to use for the Managed Database.

replicationType String

The replication method used for the Managed Database.

sslConnection Boolean

Whether to require SSL credentials to establish a connection to the Managed Database.

status String

The operating status of the Managed Database.

type String

The Linode Instance type used for the nodes of the Managed Database instance.

updated String

When this Managed Database was last updated.

version String

The Managed Database engine version.

allowLists string[]

A list of IP addresses that can access the Managed Database.

clusterSize number

The number of Linode Instance nodes deployed to the Managed Database.

created string

When this Managed Database was created.

encrypted boolean

Whether the Managed Databases is encrypted.

engine string

The Managed Database engine.

hostPrimary string

The primary host for the Managed Database.

hostSecondary string

The secondary/private network host for the Managed Database.

id number

The ID of the Managed Database.

instanceUri string
label string

A unique, user-defined string referring to the Managed Database.

region string

The region to use for the Managed Database.

replicationType string

The replication method used for the Managed Database.

sslConnection boolean

Whether to require SSL credentials to establish a connection to the Managed Database.

status string

The operating status of the Managed Database.

type string

The Linode Instance type used for the nodes of the Managed Database instance.

updated string

When this Managed Database was last updated.

version string

The Managed Database engine version.

allow_lists Sequence[str]

A list of IP addresses that can access the Managed Database.

cluster_size int

The number of Linode Instance nodes deployed to the Managed Database.

created str

When this Managed Database was created.

encrypted bool

Whether the Managed Databases is encrypted.

engine str

The Managed Database engine.

host_primary str

The primary host for the Managed Database.

host_secondary str

The secondary/private network host for the Managed Database.

id int

The ID of the Managed Database.

instance_uri str
label str

A unique, user-defined string referring to the Managed Database.

region str

The region to use for the Managed Database.

replication_type str

The replication method used for the Managed Database.

ssl_connection bool

Whether to require SSL credentials to establish a connection to the Managed Database.

status str

The operating status of the Managed Database.

type str

The Linode Instance type used for the nodes of the Managed Database instance.

updated str

When this Managed Database was last updated.

version str

The Managed Database engine version.

allowLists List<String>

A list of IP addresses that can access the Managed Database.

clusterSize Number

The number of Linode Instance nodes deployed to the Managed Database.

created String

When this Managed Database was created.

encrypted Boolean

Whether the Managed Databases is encrypted.

engine String

The Managed Database engine.

hostPrimary String

The primary host for the Managed Database.

hostSecondary String

The secondary/private network host for the Managed Database.

id Number

The ID of the Managed Database.

instanceUri String
label String

A unique, user-defined string referring to the Managed Database.

region String

The region to use for the Managed Database.

replicationType String

The replication method used for the Managed Database.

sslConnection Boolean

Whether to require SSL credentials to establish a connection to the Managed Database.

status String

The operating status of the Managed Database.

type String

The Linode Instance type used for the nodes of the Managed Database instance.

updated String

When this Managed Database was last updated.

version String

The Managed Database engine version.

GetDatabasesFilter

Name string

The name of the field to filter by.

Values List<string>

A list of values for the filter to allow. These values should all be in string form.

MatchBy string

The method to match the field by. (exact, regex, substring; default exact)

Name string

The name of the field to filter by.

Values []string

A list of values for the filter to allow. These values should all be in string form.

MatchBy string

The method to match the field by. (exact, regex, substring; default exact)

name String

The name of the field to filter by.

values List<String>

A list of values for the filter to allow. These values should all be in string form.

matchBy String

The method to match the field by. (exact, regex, substring; default exact)

name string

The name of the field to filter by.

values string[]

A list of values for the filter to allow. These values should all be in string form.

matchBy string

The method to match the field by. (exact, regex, substring; default exact)

name str

The name of the field to filter by.

values Sequence[str]

A list of values for the filter to allow. These values should all be in string form.

match_by str

The method to match the field by. (exact, regex, substring; default exact)

name String

The name of the field to filter by.

values List<String>

A list of values for the filter to allow. These values should all be in string form.

matchBy String

The method to match the field by. (exact, regex, substring; default exact)

Package Details

Repository
Linode pulumi/pulumi-linode
License
Apache-2.0
Notes

This Pulumi package is based on the linode Terraform Provider.