1. Packages
  2. Linode
  3. API Docs
  4. getInstanceBackups
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

linode.getInstanceBackups

Explore with Pulumi AI

linode logo
Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi

    Provides details about the backups of an Instance.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const my-backups = linode.getInstanceBackups({
        linodeId: 123,
    });
    
    import pulumi
    import pulumi_linode as linode
    
    my_backups = linode.get_instance_backups(linode_id=123)
    
    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.GetInstanceBackups(ctx, &linode.GetInstanceBackupsArgs{
    			LinodeId: 123,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var my_backups = Linode.GetInstanceBackups.Invoke(new()
        {
            LinodeId = 123,
        });
    
    });
    
    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.GetInstanceBackupsArgs;
    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 my-backups = LinodeFunctions.getInstanceBackups(GetInstanceBackupsArgs.builder()
                .linodeId(123)
                .build());
    
        }
    }
    
    variables:
      my-backups:
        fn::invoke:
          Function: linode:getInstanceBackups
          Arguments:
            linodeId: 123
    

    Using getInstanceBackups

    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 getInstanceBackups(args: GetInstanceBackupsArgs, opts?: InvokeOptions): Promise<GetInstanceBackupsResult>
    function getInstanceBackupsOutput(args: GetInstanceBackupsOutputArgs, opts?: InvokeOptions): Output<GetInstanceBackupsResult>
    def get_instance_backups(linode_id: Optional[int] = None,
                             opts: Optional[InvokeOptions] = None) -> GetInstanceBackupsResult
    def get_instance_backups_output(linode_id: Optional[pulumi.Input[int]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetInstanceBackupsResult]
    func GetInstanceBackups(ctx *Context, args *GetInstanceBackupsArgs, opts ...InvokeOption) (*GetInstanceBackupsResult, error)
    func GetInstanceBackupsOutput(ctx *Context, args *GetInstanceBackupsOutputArgs, opts ...InvokeOption) GetInstanceBackupsResultOutput

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

    public static class GetInstanceBackups 
    {
        public static Task<GetInstanceBackupsResult> InvokeAsync(GetInstanceBackupsArgs args, InvokeOptions? opts = null)
        public static Output<GetInstanceBackupsResult> Invoke(GetInstanceBackupsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetInstanceBackupsResult> getInstanceBackups(GetInstanceBackupsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: linode:index/getInstanceBackups:getInstanceBackups
      arguments:
        # arguments dictionary

    The following arguments are supported:

    LinodeId int
    The Linode instance's ID.
    LinodeId int
    The Linode instance's ID.
    linodeId Integer
    The Linode instance's ID.
    linodeId number
    The Linode instance's ID.
    linode_id int
    The Linode instance's ID.
    linodeId Number
    The Linode instance's ID.

    getInstanceBackups Result

    The following output properties are available:

    Supporting Types

    GetInstanceBackupsAutomatic

    Available bool
    Configs List<string>
    A list of the labels of the Configuration profiles that are part of the Backup.
    Created string
    The date the Backup was taken.
    Disks List<GetInstanceBackupsAutomaticDisk>
    Finished string
    The date the Backup completed.
    Id int
    The unique ID of this Backup.
    Label string
    The label of this disk.
    Status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    Type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    Updated string
    The date the Backup was most recently updated.
    Available bool
    Configs []string
    A list of the labels of the Configuration profiles that are part of the Backup.
    Created string
    The date the Backup was taken.
    Disks []GetInstanceBackupsAutomaticDisk
    Finished string
    The date the Backup completed.
    Id int
    The unique ID of this Backup.
    Label string
    The label of this disk.
    Status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    Type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    Updated string
    The date the Backup was most recently updated.
    available Boolean
    configs List<String>
    A list of the labels of the Configuration profiles that are part of the Backup.
    created String
    The date the Backup was taken.
    disks List<GetInstanceBackupsAutomaticDisk>
    finished String
    The date the Backup completed.
    id Integer
    The unique ID of this Backup.
    label String
    The label of this disk.
    status String
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type String
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated String
    The date the Backup was most recently updated.
    available boolean
    configs string[]
    A list of the labels of the Configuration profiles that are part of the Backup.
    created string
    The date the Backup was taken.
    disks GetInstanceBackupsAutomaticDisk[]
    finished string
    The date the Backup completed.
    id number
    The unique ID of this Backup.
    label string
    The label of this disk.
    status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated string
    The date the Backup was most recently updated.
    available bool
    configs Sequence[str]
    A list of the labels of the Configuration profiles that are part of the Backup.
    created str
    The date the Backup was taken.
    disks Sequence[GetInstanceBackupsAutomaticDisk]
    finished str
    The date the Backup completed.
    id int
    The unique ID of this Backup.
    label str
    The label of this disk.
    status str
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type str
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated str
    The date the Backup was most recently updated.
    available Boolean
    configs List<String>
    A list of the labels of the Configuration profiles that are part of the Backup.
    created String
    The date the Backup was taken.
    disks List<Property Map>
    finished String
    The date the Backup completed.
    id Number
    The unique ID of this Backup.
    label String
    The label of this disk.
    status String
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type String
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated String
    The date the Backup was most recently updated.

    GetInstanceBackupsAutomaticDisk

    Filesystem string
    The filesystem of this disk.
    Label string
    The label of this disk.
    Size int
    The size of this disk.
    Filesystem string
    The filesystem of this disk.
    Label string
    The label of this disk.
    Size int
    The size of this disk.
    filesystem String
    The filesystem of this disk.
    label String
    The label of this disk.
    size Integer
    The size of this disk.
    filesystem string
    The filesystem of this disk.
    label string
    The label of this disk.
    size number
    The size of this disk.
    filesystem str
    The filesystem of this disk.
    label str
    The label of this disk.
    size int
    The size of this disk.
    filesystem String
    The filesystem of this disk.
    label String
    The label of this disk.
    size Number
    The size of this disk.

    GetInstanceBackupsCurrent

    Available bool
    Configs List<string>
    A list of the labels of the Configuration profiles that are part of the Backup.
    Created string
    The date the Backup was taken.
    Disks List<GetInstanceBackupsCurrentDisk>
    Finished string
    The date the Backup completed.
    Id int
    The unique ID of this Backup.
    Label string
    The label of this disk.
    Status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    Type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    Updated string
    The date the Backup was most recently updated.
    Available bool
    Configs []string
    A list of the labels of the Configuration profiles that are part of the Backup.
    Created string
    The date the Backup was taken.
    Disks []GetInstanceBackupsCurrentDisk
    Finished string
    The date the Backup completed.
    Id int
    The unique ID of this Backup.
    Label string
    The label of this disk.
    Status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    Type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    Updated string
    The date the Backup was most recently updated.
    available Boolean
    configs List<String>
    A list of the labels of the Configuration profiles that are part of the Backup.
    created String
    The date the Backup was taken.
    disks List<GetInstanceBackupsCurrentDisk>
    finished String
    The date the Backup completed.
    id Integer
    The unique ID of this Backup.
    label String
    The label of this disk.
    status String
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type String
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated String
    The date the Backup was most recently updated.
    available boolean
    configs string[]
    A list of the labels of the Configuration profiles that are part of the Backup.
    created string
    The date the Backup was taken.
    disks GetInstanceBackupsCurrentDisk[]
    finished string
    The date the Backup completed.
    id number
    The unique ID of this Backup.
    label string
    The label of this disk.
    status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated string
    The date the Backup was most recently updated.
    available bool
    configs Sequence[str]
    A list of the labels of the Configuration profiles that are part of the Backup.
    created str
    The date the Backup was taken.
    disks Sequence[GetInstanceBackupsCurrentDisk]
    finished str
    The date the Backup completed.
    id int
    The unique ID of this Backup.
    label str
    The label of this disk.
    status str
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type str
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated str
    The date the Backup was most recently updated.
    available Boolean
    configs List<String>
    A list of the labels of the Configuration profiles that are part of the Backup.
    created String
    The date the Backup was taken.
    disks List<Property Map>
    finished String
    The date the Backup completed.
    id Number
    The unique ID of this Backup.
    label String
    The label of this disk.
    status String
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type String
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated String
    The date the Backup was most recently updated.

    GetInstanceBackupsCurrentDisk

    Filesystem string
    The filesystem of this disk.
    Label string
    The label of this disk.
    Size int
    The size of this disk.
    Filesystem string
    The filesystem of this disk.
    Label string
    The label of this disk.
    Size int
    The size of this disk.
    filesystem String
    The filesystem of this disk.
    label String
    The label of this disk.
    size Integer
    The size of this disk.
    filesystem string
    The filesystem of this disk.
    label string
    The label of this disk.
    size number
    The size of this disk.
    filesystem str
    The filesystem of this disk.
    label str
    The label of this disk.
    size int
    The size of this disk.
    filesystem String
    The filesystem of this disk.
    label String
    The label of this disk.
    size Number
    The size of this disk.

    GetInstanceBackupsInProgress

    Available bool
    Configs List<string>
    A list of the labels of the Configuration profiles that are part of the Backup.
    Created string
    The date the Backup was taken.
    Disks List<GetInstanceBackupsInProgressDisk>
    Finished string
    The date the Backup completed.
    Id int
    The unique ID of this Backup.
    Label string
    The label of this disk.
    Status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    Type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    Updated string
    The date the Backup was most recently updated.
    Available bool
    Configs []string
    A list of the labels of the Configuration profiles that are part of the Backup.
    Created string
    The date the Backup was taken.
    Disks []GetInstanceBackupsInProgressDisk
    Finished string
    The date the Backup completed.
    Id int
    The unique ID of this Backup.
    Label string
    The label of this disk.
    Status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    Type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    Updated string
    The date the Backup was most recently updated.
    available Boolean
    configs List<String>
    A list of the labels of the Configuration profiles that are part of the Backup.
    created String
    The date the Backup was taken.
    disks List<GetInstanceBackupsInProgressDisk>
    finished String
    The date the Backup completed.
    id Integer
    The unique ID of this Backup.
    label String
    The label of this disk.
    status String
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type String
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated String
    The date the Backup was most recently updated.
    available boolean
    configs string[]
    A list of the labels of the Configuration profiles that are part of the Backup.
    created string
    The date the Backup was taken.
    disks GetInstanceBackupsInProgressDisk[]
    finished string
    The date the Backup completed.
    id number
    The unique ID of this Backup.
    label string
    The label of this disk.
    status string
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type string
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated string
    The date the Backup was most recently updated.
    available bool
    configs Sequence[str]
    A list of the labels of the Configuration profiles that are part of the Backup.
    created str
    The date the Backup was taken.
    disks Sequence[GetInstanceBackupsInProgressDisk]
    finished str
    The date the Backup completed.
    id int
    The unique ID of this Backup.
    label str
    The label of this disk.
    status str
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type str
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated str
    The date the Backup was most recently updated.
    available Boolean
    configs List<String>
    A list of the labels of the Configuration profiles that are part of the Backup.
    created String
    The date the Backup was taken.
    disks List<Property Map>
    finished String
    The date the Backup completed.
    id Number
    The unique ID of this Backup.
    label String
    The label of this disk.
    status String
    The current state of a specific Backup. (paused, pending, running, needsPostProcessing, successful, failed, userAborted)
    type String
    This indicates whether the Backup is an automatic Backup or manual snapshot taken by the User at a specific point in time. (auto, snapshot)
    updated String
    The date the Backup was most recently updated.

    GetInstanceBackupsInProgressDisk

    Filesystem string
    The filesystem of this disk.
    Label string
    The label of this disk.
    Size int
    The size of this disk.
    Filesystem string
    The filesystem of this disk.
    Label string
    The label of this disk.
    Size int
    The size of this disk.
    filesystem String
    The filesystem of this disk.
    label String
    The label of this disk.
    size Integer
    The size of this disk.
    filesystem string
    The filesystem of this disk.
    label string
    The label of this disk.
    size number
    The size of this disk.
    filesystem str
    The filesystem of this disk.
    label str
    The label of this disk.
    size int
    The size of this disk.
    filesystem String
    The filesystem of this disk.
    label String
    The label of this disk.
    size Number
    The size of this disk.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo
    Linode v4.22.1 published on Wednesday, Jul 3, 2024 by Pulumi