1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. getEtcdBackup
Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi

rancher2.getEtcdBackup

Explore with Pulumi AI

Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi

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

Example Usage

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

const foo = rancher2.getEtcdBackup({
    clusterId: "<CLUSTER_ID>",
    name: "foo",
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

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

import (
	"github.com/pulumi/pulumi-rancher2/sdk/v9/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
	})
}
Copy
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",
    });

});
Copy
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());

    }
}
Copy
variables:
  foo:
    fn::invoke:
      function: rancher2:getEtcdBackup
      arguments:
        clusterId: <CLUSTER_ID>
        name: foo
Copy

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>
Copy
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]
Copy
func LookupEtcdBackup(ctx *Context, args *LookupEtcdBackupArgs, opts ...InvokeOption) (*LookupEtcdBackupResult, error)
func LookupEtcdBackupOutput(ctx *Context, args *LookupEtcdBackupOutputArgs, opts ...InvokeOption) LookupEtcdBackupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetEtcdBackupResult> getEtcdBackup(GetEtcdBackupArgs args, InvokeOptions options)
public static Output<GetEtcdBackupResult> getEtcdBackup(GetEtcdBackupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: rancher2:index/getEtcdBackup:getEtcdBackup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ClusterId This property is required. string
Cluster ID to config Etcd Backup (string)
Name This property is required. string
The name of the Etcd Backup (string)
ClusterId This property is required. string
Cluster ID to config Etcd Backup (string)
Name This property is required. string
The name of the Etcd Backup (string)
clusterId This property is required. String
Cluster ID to config Etcd Backup (string)
name This property is required. String
The name of the Etcd Backup (string)
clusterId This property is required. string
Cluster ID to config Etcd Backup (string)
name This property is required. string
The name of the Etcd Backup (string)
cluster_id This property is required. str
Cluster ID to config Etcd Backup (string)
name This property is required. str
The name of the Etcd Backup (string)
clusterId This property is required. String
Cluster ID to config Etcd Backup (string)
name This property is required. String
The name of the Etcd Backup (string)

getEtcdBackup Result

The following output properties are available:

Annotations Dictionary<string, string>
(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, string>
(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]string
(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]string
(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,String>
(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,String>
(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]: string}
(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]: string}
(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, str]
(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, str]
(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<String>
(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<String>
(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)

Supporting Types

GetEtcdBackupBackupConfig

timeout This property is required. Integer
enabled Boolean
intervalHours Integer
retention Integer
s3BackupConfig GetEtcdBackupBackupConfigS3BackupConfig
safeTimestamp Boolean
timeout This property is required. Number
enabled Boolean
intervalHours Number
retention Number
s3BackupConfig Property Map
safeTimestamp Boolean

GetEtcdBackupBackupConfigS3BackupConfig

BucketName This property is required. string
Endpoint This property is required. string
AccessKey string
CustomCa string
Folder string
Region string
SecretKey string
BucketName This property is required. string
Endpoint This property is required. string
AccessKey string
CustomCa string
Folder string
Region string
SecretKey string
bucketName This property is required. String
endpoint This property is required. String
accessKey String
customCa String
folder String
region String
secretKey String
bucketName This property is required. string
endpoint This property is required. string
accessKey string
customCa string
folder string
region string
secretKey string
bucket_name This property is required. str
endpoint This property is required. str
access_key str
custom_ca str
folder str
region str
secret_key str
bucketName This property is required. String
endpoint This property is required. String
accessKey String
customCa String
folder String
region String
secretKey String

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.
Rancher 2 v9.0.0 published on Wednesday, Apr 16, 2025 by Pulumi