Rancher 2 v4.0.0, Apr 20 23

rancher2.getEtcdBackup

Explore with Pulumi AI

Use this data source to retrieve information about a Rancher v2 etcd backup.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var foo = Rancher2.GetEtcdBackup.Invoke(new()
    {
        ClusterId = "<CLUSTER_ID>",
        Name = "foo",
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := rancher2.LookupEtcdBackup(ctx, &rancher2.LookupEtcdBackupArgs{
			ClusterId: "<CLUSTER_ID>",
			Name:      "foo",
		}, 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.rancher2.Rancher2Functions;
import com.pulumi.rancher2.inputs.GetEtcdBackupArgs;
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 foo = Rancher2Functions.getEtcdBackup(GetEtcdBackupArgs.builder()
            .clusterId("<CLUSTER_ID>")
            .name("foo")
            .build());

    }
}

import pulumi
import pulumi_rancher2 as rancher2

foo = rancher2.get_etcd_backup(cluster_id="<CLUSTER_ID>",
    name="foo")

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

const foo = rancher2.getEtcdBackup({
    clusterId: "<CLUSTER_ID>",
    name: "foo",
});

variables:
  foo:
    fn::invoke:
      Function: rancher2:getEtcdBackup
      Arguments:
        clusterId: <CLUSTER_ID>
        name: foo

Using getEtcdBackup

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 getEtcdBackup(args: GetEtcdBackupArgs, opts?: InvokeOptions): Promise<GetEtcdBackupResult>
function getEtcdBackupOutput(args: GetEtcdBackupOutputArgs, opts?: InvokeOptions): Output<GetEtcdBackupResult>

def get_etcd_backup(cluster_id: Optional[str] = None,
                    name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetEtcdBackupResult
def get_etcd_backup_output(cluster_id: Optional[pulumi.Input[str]] = None,
                    name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetEtcdBackupResult]

func LookupEtcdBackup(ctx *Context, args *LookupEtcdBackupArgs, opts ...InvokeOption) (*LookupEtcdBackupResult, error)
func LookupEtcdBackupOutput(ctx *Context, args *LookupEtcdBackupOutputArgs, opts ...InvokeOption) LookupEtcdBackupResultOutput

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

public static class GetEtcdBackup 
{
    public static Task<GetEtcdBackupResult> InvokeAsync(GetEtcdBackupArgs args, InvokeOptions? opts = null)
    public static Output<GetEtcdBackupResult> Invoke(GetEtcdBackupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEtcdBackupResult> getEtcdBackup(GetEtcdBackupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: rancher2:index/getEtcdBackup:getEtcdBackup
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterId string: Cluster ID to config Etcd Backup (string)
Name string: The name of the Etcd Backup (string)

ClusterId string: Cluster ID to config Etcd Backup (string)
Name string: The name of the Etcd Backup (string)

clusterId String: Cluster ID to config Etcd Backup (string)
name String: The name of the Etcd Backup (string)

clusterId string: Cluster ID to config Etcd Backup (string)
name string: The name of the Etcd Backup (string)

cluster_id str: Cluster ID to config Etcd Backup (string)
name str: The name of the Etcd Backup (string)

clusterId String: Cluster ID to config Etcd Backup (string)
name String: The name of the Etcd Backup (string)

getEtcdBackup Result

The following output properties are available:

Annotations Dictionary<string, object>: (Computed) Annotations for Etcd Backup object (map)
BackupConfig GetEtcdBackupBackupConfig: (Computed) Backup config for etcd backup (list maxitems:1)
ClusterId string
Filename string: (Computed) Filename of the Etcd Backup (string)
Id string: The provider-assigned unique ID for this managed resource.
Labels Dictionary<string, object>: (Computed) Labels for Etcd Backup object (map)
Manual bool: (Computed) Manual execution of the Etcd Backup. Default false (bool)
Name string
NamespaceId string: (Computed) Description for the Etcd Backup (string)

Annotations map[string]interface{}: (Computed) Annotations for Etcd Backup object (map)
BackupConfig GetEtcdBackupBackupConfig: (Computed) Backup config for etcd backup (list maxitems:1)
ClusterId string
Filename string: (Computed) Filename of the Etcd Backup (string)
Id string: The provider-assigned unique ID for this managed resource.
Labels map[string]interface{}: (Computed) Labels for Etcd Backup object (map)
Manual bool: (Computed) Manual execution of the Etcd Backup. Default false (bool)
Name string
NamespaceId string: (Computed) Description for the Etcd Backup (string)

annotations Map<String,Object>: (Computed) Annotations for Etcd Backup object (map)
backupConfig GetEtcdBackupBackupConfig: (Computed) Backup config for etcd backup (list maxitems:1)
clusterId String
filename String: (Computed) Filename of the Etcd Backup (string)
id String: The provider-assigned unique ID for this managed resource.
labels Map<String,Object>: (Computed) Labels for Etcd Backup object (map)
manual Boolean: (Computed) Manual execution of the Etcd Backup. Default false (bool)
name String
namespaceId String: (Computed) Description for the Etcd Backup (string)

annotations {[key: string]: any}: (Computed) Annotations for Etcd Backup object (map)
backupConfig GetEtcdBackupBackupConfig: (Computed) Backup config for etcd backup (list maxitems:1)
clusterId string
filename string: (Computed) Filename of the Etcd Backup (string)
id string: The provider-assigned unique ID for this managed resource.
labels {[key: string]: any}: (Computed) Labels for Etcd Backup object (map)
manual boolean: (Computed) Manual execution of the Etcd Backup. Default false (bool)
name string
namespaceId string: (Computed) Description for the Etcd Backup (string)

annotations Mapping[str, Any]: (Computed) Annotations for Etcd Backup object (map)
backup_config GetEtcdBackupBackupConfig: (Computed) Backup config for etcd backup (list maxitems:1)
cluster_id str
filename str: (Computed) Filename of the Etcd Backup (string)
id str: The provider-assigned unique ID for this managed resource.
labels Mapping[str, Any]: (Computed) Labels for Etcd Backup object (map)
manual bool: (Computed) Manual execution of the Etcd Backup. Default false (bool)
name str
namespace_id str: (Computed) Description for the Etcd Backup (string)

annotations Map<Any>: (Computed) Annotations for Etcd Backup object (map)
backupConfig Property Map: (Computed) Backup config for etcd backup (list maxitems:1)
clusterId String
filename String: (Computed) Filename of the Etcd Backup (string)
id String: The provider-assigned unique ID for this managed resource.
labels Map<Any>: (Computed) Labels for Etcd Backup object (map)
manual Boolean: (Computed) Manual execution of the Etcd Backup. Default false (bool)
name String
namespaceId String: (Computed) Description for the Etcd Backup (string)