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

linode.getDatabaseBackups

Explore with Pulumi AI

Provides information about Linode Database Backups that match a set of filters.

Example Usage

Get information about all backups for a MySQL database

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

return await Deployment.RunAsync(() => 
{
    var all_backups = Linode.GetDatabaseBackups.Invoke(new()
    {
        DatabaseId = 12345,
        DatabaseType = "mysql",
    });

});

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 {
		_, err := linode.GetDatabaseBackups(ctx, &linode.GetDatabaseBackupsArgs{
			DatabaseId:   12345,
			DatabaseType: "mysql",
		}, nil)
		if err != nil {
			return err
		}
		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.GetDatabaseBackupsArgs;
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-backups = LinodeFunctions.getDatabaseBackups(GetDatabaseBackupsArgs.builder()
            .databaseId(12345)
            .databaseType("mysql")
            .build());

    }
}

import pulumi
import pulumi_linode as linode

all_backups = linode.get_database_backups(database_id=12345,
    database_type="mysql")

import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const all-backups = linode.getDatabaseBackups({
    databaseId: 12345,
    databaseType: "mysql",
});

variables:
  all-backups:
    fn::invoke:
      Function: linode:getDatabaseBackups
      Arguments:
        databaseId: 12345
        databaseType: mysql

Get information about all automatic PostgreSQL Database Backups

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

return await Deployment.RunAsync(() => 
{
    var auto_backups = Linode.GetDatabaseBackups.Invoke(new()
    {
        DatabaseId = 12345,
        DatabaseType = "postgresql",
        Filters = new[]
        {
            new Linode.Inputs.GetDatabaseBackupsFilterInputArgs
            {
                Name = "type",
                Values = new[]
                {
                    "auto",
                },
            },
        },
    });

});

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 {
		_, err := linode.GetDatabaseBackups(ctx, &linode.GetDatabaseBackupsArgs{
			DatabaseId:   12345,
			DatabaseType: "postgresql",
			Filters: []linode.GetDatabaseBackupsFilter{
				{
					Name: "type",
					Values: []string{
						"auto",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		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.GetDatabaseBackupsArgs;
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 auto-backups = LinodeFunctions.getDatabaseBackups(GetDatabaseBackupsArgs.builder()
            .databaseId(12345)
            .databaseType("postgresql")
            .filters(GetDatabaseBackupsFilterArgs.builder()
                .name("type")
                .values("auto")
                .build())
            .build());

    }
}

import pulumi
import pulumi_linode as linode

auto_backups = linode.get_database_backups(database_id=12345,
    database_type="postgresql",
    filters=[linode.GetDatabaseBackupsFilterArgs(
        name="type",
        values=["auto"],
    )])

import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const auto-backups = linode.getDatabaseBackups({
    databaseId: 12345,
    databaseType: "postgresql",
    filters: [{
        name: "type",
        values: ["auto"],
    }],
});

variables:
  auto-backups:
    fn::invoke:
      Function: linode:getDatabaseBackups
      Arguments:
        databaseId: 12345
        databaseType: postgresql
        filters:
          - name: type
            values:
              - auto

Using getDatabaseBackups

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 getDatabaseBackups(args: GetDatabaseBackupsArgs, opts?: InvokeOptions): Promise<GetDatabaseBackupsResult>
function getDatabaseBackupsOutput(args: GetDatabaseBackupsOutputArgs, opts?: InvokeOptions): Output<GetDatabaseBackupsResult>
def get_database_backups(database_id: Optional[int] = None,
                         database_type: Optional[str] = None,
                         filters: Optional[Sequence[GetDatabaseBackupsFilter]] = None,
                         latest: Optional[bool] = None,
                         order: Optional[str] = None,
                         order_by: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDatabaseBackupsResult
def get_database_backups_output(database_id: Optional[pulumi.Input[int]] = None,
                         database_type: Optional[pulumi.Input[str]] = None,
                         filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDatabaseBackupsFilterArgs]]]] = 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[GetDatabaseBackupsResult]
func GetDatabaseBackups(ctx *Context, args *GetDatabaseBackupsArgs, opts ...InvokeOption) (*GetDatabaseBackupsResult, error)
func GetDatabaseBackupsOutput(ctx *Context, args *GetDatabaseBackupsOutputArgs, opts ...InvokeOption) GetDatabaseBackupsResultOutput

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

public static class GetDatabaseBackups 
{
    public static Task<GetDatabaseBackupsResult> InvokeAsync(GetDatabaseBackupsArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseBackupsResult> Invoke(GetDatabaseBackupsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetDatabaseBackupsResult> getDatabaseBackups(GetDatabaseBackupsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

DatabaseId int

The ID of the database to retrieve backups for.

DatabaseType string

The type of the database to retrieve backups for. (mysql, postgresql)

Filters List<GetDatabaseBackupsFilter>
Latest bool

If true, only the latest backup will be returned.

  • filter - (Optional) A set of filters used to select database backups 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. (created)

DatabaseId int

The ID of the database to retrieve backups for.

DatabaseType string

The type of the database to retrieve backups for. (mysql, postgresql)

Filters []GetDatabaseBackupsFilter
Latest bool

If true, only the latest backup will be returned.

  • filter - (Optional) A set of filters used to select database backups 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. (created)

databaseId Integer

The ID of the database to retrieve backups for.

databaseType String

The type of the database to retrieve backups for. (mysql, postgresql)

filters List<GetDatabaseBackupsFilter>
latest Boolean

If true, only the latest backup will be returned.

  • filter - (Optional) A set of filters used to select database backups 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. (created)

databaseId number

The ID of the database to retrieve backups for.

databaseType string

The type of the database to retrieve backups for. (mysql, postgresql)

filters GetDatabaseBackupsFilter[]
latest boolean

If true, only the latest backup will be returned.

  • filter - (Optional) A set of filters used to select database backups 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. (created)

database_id int

The ID of the database to retrieve backups for.

database_type str

The type of the database to retrieve backups for. (mysql, postgresql)

filters Sequence[GetDatabaseBackupsFilter]
latest bool

If true, only the latest backup will be returned.

  • filter - (Optional) A set of filters used to select database backups 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. (created)

databaseId Number

The ID of the database to retrieve backups for.

databaseType String

The type of the database to retrieve backups for. (mysql, postgresql)

filters List<Property Map>
latest Boolean

If true, only the latest backup will be returned.

  • filter - (Optional) A set of filters used to select database backups 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. (created)

getDatabaseBackups Result

The following output properties are available:

Backups List<GetDatabaseBackupsBackup>
DatabaseId int
DatabaseType string
Id string

The provider-assigned unique ID for this managed resource.

Filters List<GetDatabaseBackupsFilter>
Latest bool
Order string
OrderBy string
Backups []GetDatabaseBackupsBackup
DatabaseId int
DatabaseType string
Id string

The provider-assigned unique ID for this managed resource.

Filters []GetDatabaseBackupsFilter
Latest bool
Order string
OrderBy string
backups List<GetDatabaseBackupsBackup>
databaseId Integer
databaseType String
id String

The provider-assigned unique ID for this managed resource.

filters List<GetDatabaseBackupsFilter>
latest Boolean
order String
orderBy String
backups GetDatabaseBackupsBackup[]
databaseId number
databaseType string
id string

The provider-assigned unique ID for this managed resource.

filters GetDatabaseBackupsFilter[]
latest boolean
order string
orderBy string
backups Sequence[GetDatabaseBackupsBackup]
database_id int
database_type str
id str

The provider-assigned unique ID for this managed resource.

filters Sequence[GetDatabaseBackupsFilter]
latest bool
order str
order_by str
backups List<Property Map>
databaseId Number
databaseType String
id String

The provider-assigned unique ID for this managed resource.

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

Supporting Types

GetDatabaseBackupsBackup

Created string

A time value given in a combined date and time format that represents when the database backup was created.

Id int

The ID of the database backup object.

Label string

The database backup’s label, for display purposes only.

Type string

The type of database backup, determined by how the backup was created.

Created string

A time value given in a combined date and time format that represents when the database backup was created.

Id int

The ID of the database backup object.

Label string

The database backup’s label, for display purposes only.

Type string

The type of database backup, determined by how the backup was created.

created String

A time value given in a combined date and time format that represents when the database backup was created.

id Integer

The ID of the database backup object.

label String

The database backup’s label, for display purposes only.

type String

The type of database backup, determined by how the backup was created.

created string

A time value given in a combined date and time format that represents when the database backup was created.

id number

The ID of the database backup object.

label string

The database backup’s label, for display purposes only.

type string

The type of database backup, determined by how the backup was created.

created str

A time value given in a combined date and time format that represents when the database backup was created.

id int

The ID of the database backup object.

label str

The database backup’s label, for display purposes only.

type str

The type of database backup, determined by how the backup was created.

created String

A time value given in a combined date and time format that represents when the database backup was created.

id Number

The ID of the database backup object.

label String

The database backup’s label, for display purposes only.

type String

The type of database backup, determined by how the backup was created.

GetDatabaseBackupsFilter

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.