Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Rancher2 Provider
  3. API Docs
  4. EtcdBackup
Rancher 2 v8.1.4 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-rancher2

rancher2.EtcdBackup

Explore with Pulumi AI

Rancher 2 v8.1.4 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-rancher2

Provides a Rancher v2 Etcd Backup resource. This can be used to create an Etcd Backup for Rancher v2.2.x and above, and to retrieve their information.

The rancher2.EtcdBackup resource is used to define extra etcd backups for a rancher2.Cluster, which will be created as a local or S3 backup in accordance with the etcd backup config for the cluster. The main etcd backup config for the cluster should be set on the cluster config

Example Usage

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

// Create a new rancher2 Etcd Backup
const foo = new rancher2.EtcdBackup("foo", {
    backupConfig: {
        enabled: true,
        intervalHours: 20,
        retention: 10,
        s3BackupConfig: {
            accessKey: "access_key",
            bucketName: "bucket_name",
            endpoint: "endpoint",
            folder: "/folder",
            region: "region",
            secretKey: "secret_key",
        },
    },
    clusterId: "<CLUSTER_ID>",
    name: "foo",
    filename: "<FILENAME>",
});
Copy
import pulumi
import pulumi_rancher2 as rancher2

# Create a new rancher2 Etcd Backup
foo = rancher2.EtcdBackup("foo",
    backup_config={
        "enabled": True,
        "interval_hours": 20,
        "retention": 10,
        "s3_backup_config": {
            "access_key": "access_key",
            "bucket_name": "bucket_name",
            "endpoint": "endpoint",
            "folder": "/folder",
            "region": "region",
            "secret_key": "secret_key",
        },
    },
    cluster_id="<CLUSTER_ID>",
    name="foo",
    filename="<FILENAME>")
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		// Create a new rancher2 Etcd Backup
		_, err := rancher2.NewEtcdBackup(ctx, "foo", &rancher2.EtcdBackupArgs{
			BackupConfig: &rancher2.EtcdBackupBackupConfigArgs{
				Enabled:       pulumi.Bool(true),
				IntervalHours: pulumi.Int(20),
				Retention:     pulumi.Int(10),
				S3BackupConfig: &rancher2.EtcdBackupBackupConfigS3BackupConfigArgs{
					AccessKey:  pulumi.String("access_key"),
					BucketName: pulumi.String("bucket_name"),
					Endpoint:   pulumi.String("endpoint"),
					Folder:     pulumi.String("/folder"),
					Region:     pulumi.String("region"),
					SecretKey:  pulumi.String("secret_key"),
				},
			},
			ClusterId: pulumi.String("<CLUSTER_ID>"),
			Name:      pulumi.String("foo"),
			Filename:  pulumi.String("<FILENAME>"),
		})
		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(() => 
{
    // Create a new rancher2 Etcd Backup
    var foo = new Rancher2.EtcdBackup("foo", new()
    {
        BackupConfig = new Rancher2.Inputs.EtcdBackupBackupConfigArgs
        {
            Enabled = true,
            IntervalHours = 20,
            Retention = 10,
            S3BackupConfig = new Rancher2.Inputs.EtcdBackupBackupConfigS3BackupConfigArgs
            {
                AccessKey = "access_key",
                BucketName = "bucket_name",
                Endpoint = "endpoint",
                Folder = "/folder",
                Region = "region",
                SecretKey = "secret_key",
            },
        },
        ClusterId = "<CLUSTER_ID>",
        Name = "foo",
        Filename = "<FILENAME>",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.rancher2.EtcdBackup;
import com.pulumi.rancher2.EtcdBackupArgs;
import com.pulumi.rancher2.inputs.EtcdBackupBackupConfigArgs;
import com.pulumi.rancher2.inputs.EtcdBackupBackupConfigS3BackupConfigArgs;
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) {
        // Create a new rancher2 Etcd Backup
        var foo = new EtcdBackup("foo", EtcdBackupArgs.builder()
            .backupConfig(EtcdBackupBackupConfigArgs.builder()
                .enabled(true)
                .intervalHours(20)
                .retention(10)
                .s3BackupConfig(EtcdBackupBackupConfigS3BackupConfigArgs.builder()
                    .accessKey("access_key")
                    .bucketName("bucket_name")
                    .endpoint("endpoint")
                    .folder("/folder")
                    .region("region")
                    .secretKey("secret_key")
                    .build())
                .build())
            .clusterId("<CLUSTER_ID>")
            .name("foo")
            .filename("<FILENAME>")
            .build());

    }
}
Copy
resources:
  # Create a new rancher2 Etcd Backup
  foo:
    type: rancher2:EtcdBackup
    properties:
      backupConfig:
        enabled: true
        intervalHours: 20
        retention: 10
        s3BackupConfig:
          accessKey: access_key
          bucketName: bucket_name
          endpoint: endpoint
          folder: /folder
          region: region
          secretKey: secret_key
      clusterId: <CLUSTER_ID>
      name: foo
      filename: <FILENAME>
Copy

Create EtcdBackup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EtcdBackup(name: string, args: EtcdBackupArgs, opts?: CustomResourceOptions);
@overload
def EtcdBackup(resource_name: str,
               args: EtcdBackupArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def EtcdBackup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               cluster_id: Optional[str] = None,
               annotations: Optional[Mapping[str, str]] = None,
               backup_config: Optional[EtcdBackupBackupConfigArgs] = None,
               filename: Optional[str] = None,
               labels: Optional[Mapping[str, str]] = None,
               manual: Optional[bool] = None,
               name: Optional[str] = None,
               namespace_id: Optional[str] = None)
func NewEtcdBackup(ctx *Context, name string, args EtcdBackupArgs, opts ...ResourceOption) (*EtcdBackup, error)
public EtcdBackup(string name, EtcdBackupArgs args, CustomResourceOptions? opts = null)
public EtcdBackup(String name, EtcdBackupArgs args)
public EtcdBackup(String name, EtcdBackupArgs args, CustomResourceOptions options)

type: rancher2:EtcdBackup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EtcdBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EtcdBackupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EtcdBackupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EtcdBackupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EtcdBackupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var etcdBackupResource = new Rancher2.EtcdBackup("etcdBackupResource", new()
{
    ClusterId = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    BackupConfig = new Rancher2.Inputs.EtcdBackupBackupConfigArgs
    {
        Enabled = false,
        IntervalHours = 0,
        Retention = 0,
        S3BackupConfig = new Rancher2.Inputs.EtcdBackupBackupConfigS3BackupConfigArgs
        {
            BucketName = "string",
            Endpoint = "string",
            AccessKey = "string",
            CustomCa = "string",
            Folder = "string",
            Region = "string",
            SecretKey = "string",
        },
        SafeTimestamp = false,
        Timeout = 0,
    },
    Filename = "string",
    Labels = 
    {
        { "string", "string" },
    },
    Manual = false,
    Name = "string",
    NamespaceId = "string",
});
Copy
example, err := rancher2.NewEtcdBackup(ctx, "etcdBackupResource", &rancher2.EtcdBackupArgs{
	ClusterId: pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	BackupConfig: &rancher2.EtcdBackupBackupConfigArgs{
		Enabled:       pulumi.Bool(false),
		IntervalHours: pulumi.Int(0),
		Retention:     pulumi.Int(0),
		S3BackupConfig: &rancher2.EtcdBackupBackupConfigS3BackupConfigArgs{
			BucketName: pulumi.String("string"),
			Endpoint:   pulumi.String("string"),
			AccessKey:  pulumi.String("string"),
			CustomCa:   pulumi.String("string"),
			Folder:     pulumi.String("string"),
			Region:     pulumi.String("string"),
			SecretKey:  pulumi.String("string"),
		},
		SafeTimestamp: pulumi.Bool(false),
		Timeout:       pulumi.Int(0),
	},
	Filename: pulumi.String("string"),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Manual:      pulumi.Bool(false),
	Name:        pulumi.String("string"),
	NamespaceId: pulumi.String("string"),
})
Copy
var etcdBackupResource = new EtcdBackup("etcdBackupResource", EtcdBackupArgs.builder()
    .clusterId("string")
    .annotations(Map.of("string", "string"))
    .backupConfig(EtcdBackupBackupConfigArgs.builder()
        .enabled(false)
        .intervalHours(0)
        .retention(0)
        .s3BackupConfig(EtcdBackupBackupConfigS3BackupConfigArgs.builder()
            .bucketName("string")
            .endpoint("string")
            .accessKey("string")
            .customCa("string")
            .folder("string")
            .region("string")
            .secretKey("string")
            .build())
        .safeTimestamp(false)
        .timeout(0)
        .build())
    .filename("string")
    .labels(Map.of("string", "string"))
    .manual(false)
    .name("string")
    .namespaceId("string")
    .build());
Copy
etcd_backup_resource = rancher2.EtcdBackup("etcdBackupResource",
    cluster_id="string",
    annotations={
        "string": "string",
    },
    backup_config={
        "enabled": False,
        "interval_hours": 0,
        "retention": 0,
        "s3_backup_config": {
            "bucket_name": "string",
            "endpoint": "string",
            "access_key": "string",
            "custom_ca": "string",
            "folder": "string",
            "region": "string",
            "secret_key": "string",
        },
        "safe_timestamp": False,
        "timeout": 0,
    },
    filename="string",
    labels={
        "string": "string",
    },
    manual=False,
    name="string",
    namespace_id="string")
Copy
const etcdBackupResource = new rancher2.EtcdBackup("etcdBackupResource", {
    clusterId: "string",
    annotations: {
        string: "string",
    },
    backupConfig: {
        enabled: false,
        intervalHours: 0,
        retention: 0,
        s3BackupConfig: {
            bucketName: "string",
            endpoint: "string",
            accessKey: "string",
            customCa: "string",
            folder: "string",
            region: "string",
            secretKey: "string",
        },
        safeTimestamp: false,
        timeout: 0,
    },
    filename: "string",
    labels: {
        string: "string",
    },
    manual: false,
    name: "string",
    namespaceId: "string",
});
Copy
type: rancher2:EtcdBackup
properties:
    annotations:
        string: string
    backupConfig:
        enabled: false
        intervalHours: 0
        retention: 0
        s3BackupConfig:
            accessKey: string
            bucketName: string
            customCa: string
            endpoint: string
            folder: string
            region: string
            secretKey: string
        safeTimestamp: false
        timeout: 0
    clusterId: string
    filename: string
    labels:
        string: string
    manual: false
    name: string
    namespaceId: string
Copy

EtcdBackup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EtcdBackup resource accepts the following input properties:

ClusterId
This property is required.
Changes to this property will trigger replacement.
string
Cluster ID to config Etcd Backup (string)
Annotations Dictionary<string, string>
Annotations for Etcd Backup object (map)
BackupConfig EtcdBackupBackupConfig
Backup config for etcd backup (list maxitems:1)
Filename string
Filename of the Etcd Backup (string)
Labels Dictionary<string, string>
Labels for Etcd Backup object (map)
Manual bool
Manual execution of the Etcd Backup. Default false (bool)
Name Changes to this property will trigger replacement. string
The name of the Etcd Backup (string)
NamespaceId Changes to this property will trigger replacement. string
Description for the Etcd Backup (string)
ClusterId
This property is required.
Changes to this property will trigger replacement.
string
Cluster ID to config Etcd Backup (string)
Annotations map[string]string
Annotations for Etcd Backup object (map)
BackupConfig EtcdBackupBackupConfigArgs
Backup config for etcd backup (list maxitems:1)
Filename string
Filename of the Etcd Backup (string)
Labels map[string]string
Labels for Etcd Backup object (map)
Manual bool
Manual execution of the Etcd Backup. Default false (bool)
Name Changes to this property will trigger replacement. string
The name of the Etcd Backup (string)
NamespaceId Changes to this property will trigger replacement. string
Description for the Etcd Backup (string)
clusterId
This property is required.
Changes to this property will trigger replacement.
String
Cluster ID to config Etcd Backup (string)
annotations Map<String,String>
Annotations for Etcd Backup object (map)
backupConfig EtcdBackupBackupConfig
Backup config for etcd backup (list maxitems:1)
filename String
Filename of the Etcd Backup (string)
labels Map<String,String>
Labels for Etcd Backup object (map)
manual Boolean
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. String
The name of the Etcd Backup (string)
namespaceId Changes to this property will trigger replacement. String
Description for the Etcd Backup (string)
clusterId
This property is required.
Changes to this property will trigger replacement.
string
Cluster ID to config Etcd Backup (string)
annotations {[key: string]: string}
Annotations for Etcd Backup object (map)
backupConfig EtcdBackupBackupConfig
Backup config for etcd backup (list maxitems:1)
filename string
Filename of the Etcd Backup (string)
labels {[key: string]: string}
Labels for Etcd Backup object (map)
manual boolean
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. string
The name of the Etcd Backup (string)
namespaceId Changes to this property will trigger replacement. string
Description for the Etcd Backup (string)
cluster_id
This property is required.
Changes to this property will trigger replacement.
str
Cluster ID to config Etcd Backup (string)
annotations Mapping[str, str]
Annotations for Etcd Backup object (map)
backup_config EtcdBackupBackupConfigArgs
Backup config for etcd backup (list maxitems:1)
filename str
Filename of the Etcd Backup (string)
labels Mapping[str, str]
Labels for Etcd Backup object (map)
manual bool
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. str
The name of the Etcd Backup (string)
namespace_id Changes to this property will trigger replacement. str
Description for the Etcd Backup (string)
clusterId
This property is required.
Changes to this property will trigger replacement.
String
Cluster ID to config Etcd Backup (string)
annotations Map<String>
Annotations for Etcd Backup object (map)
backupConfig Property Map
Backup config for etcd backup (list maxitems:1)
filename String
Filename of the Etcd Backup (string)
labels Map<String>
Labels for Etcd Backup object (map)
manual Boolean
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. String
The name of the Etcd Backup (string)
namespaceId Changes to this property will trigger replacement. String
Description for the Etcd Backup (string)

Outputs

All input properties are implicitly available as output properties. Additionally, the EtcdBackup resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing EtcdBackup Resource

Get an existing EtcdBackup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EtcdBackupState, opts?: CustomResourceOptions): EtcdBackup
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        backup_config: Optional[EtcdBackupBackupConfigArgs] = None,
        cluster_id: Optional[str] = None,
        filename: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        manual: Optional[bool] = None,
        name: Optional[str] = None,
        namespace_id: Optional[str] = None) -> EtcdBackup
func GetEtcdBackup(ctx *Context, name string, id IDInput, state *EtcdBackupState, opts ...ResourceOption) (*EtcdBackup, error)
public static EtcdBackup Get(string name, Input<string> id, EtcdBackupState? state, CustomResourceOptions? opts = null)
public static EtcdBackup get(String name, Output<String> id, EtcdBackupState state, CustomResourceOptions options)
resources:  _:    type: rancher2:EtcdBackup    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Annotations Dictionary<string, string>
Annotations for Etcd Backup object (map)
BackupConfig EtcdBackupBackupConfig
Backup config for etcd backup (list maxitems:1)
ClusterId Changes to this property will trigger replacement. string
Cluster ID to config Etcd Backup (string)
Filename string
Filename of the Etcd Backup (string)
Labels Dictionary<string, string>
Labels for Etcd Backup object (map)
Manual bool
Manual execution of the Etcd Backup. Default false (bool)
Name Changes to this property will trigger replacement. string
The name of the Etcd Backup (string)
NamespaceId Changes to this property will trigger replacement. string
Description for the Etcd Backup (string)
Annotations map[string]string
Annotations for Etcd Backup object (map)
BackupConfig EtcdBackupBackupConfigArgs
Backup config for etcd backup (list maxitems:1)
ClusterId Changes to this property will trigger replacement. string
Cluster ID to config Etcd Backup (string)
Filename string
Filename of the Etcd Backup (string)
Labels map[string]string
Labels for Etcd Backup object (map)
Manual bool
Manual execution of the Etcd Backup. Default false (bool)
Name Changes to this property will trigger replacement. string
The name of the Etcd Backup (string)
NamespaceId Changes to this property will trigger replacement. string
Description for the Etcd Backup (string)
annotations Map<String,String>
Annotations for Etcd Backup object (map)
backupConfig EtcdBackupBackupConfig
Backup config for etcd backup (list maxitems:1)
clusterId Changes to this property will trigger replacement. String
Cluster ID to config Etcd Backup (string)
filename String
Filename of the Etcd Backup (string)
labels Map<String,String>
Labels for Etcd Backup object (map)
manual Boolean
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. String
The name of the Etcd Backup (string)
namespaceId Changes to this property will trigger replacement. String
Description for the Etcd Backup (string)
annotations {[key: string]: string}
Annotations for Etcd Backup object (map)
backupConfig EtcdBackupBackupConfig
Backup config for etcd backup (list maxitems:1)
clusterId Changes to this property will trigger replacement. string
Cluster ID to config Etcd Backup (string)
filename string
Filename of the Etcd Backup (string)
labels {[key: string]: string}
Labels for Etcd Backup object (map)
manual boolean
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. string
The name of the Etcd Backup (string)
namespaceId Changes to this property will trigger replacement. string
Description for the Etcd Backup (string)
annotations Mapping[str, str]
Annotations for Etcd Backup object (map)
backup_config EtcdBackupBackupConfigArgs
Backup config for etcd backup (list maxitems:1)
cluster_id Changes to this property will trigger replacement. str
Cluster ID to config Etcd Backup (string)
filename str
Filename of the Etcd Backup (string)
labels Mapping[str, str]
Labels for Etcd Backup object (map)
manual bool
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. str
The name of the Etcd Backup (string)
namespace_id Changes to this property will trigger replacement. str
Description for the Etcd Backup (string)
annotations Map<String>
Annotations for Etcd Backup object (map)
backupConfig Property Map
Backup config for etcd backup (list maxitems:1)
clusterId Changes to this property will trigger replacement. String
Cluster ID to config Etcd Backup (string)
filename String
Filename of the Etcd Backup (string)
labels Map<String>
Labels for Etcd Backup object (map)
manual Boolean
Manual execution of the Etcd Backup. Default false (bool)
name Changes to this property will trigger replacement. String
The name of the Etcd Backup (string)
namespaceId Changes to this property will trigger replacement. String
Description for the Etcd Backup (string)

Supporting Types

EtcdBackupBackupConfig
, EtcdBackupBackupConfigArgs

Enabled bool
Enable etcd backup (bool)
IntervalHours int
Interval hours for etcd backup. Default 12 (int)
Retention int
Retention for etcd backup. Default 6 (int)
S3BackupConfig EtcdBackupBackupConfigS3BackupConfig
S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)
SafeTimestamp bool
Timeout int
Enabled bool
Enable etcd backup (bool)
IntervalHours int
Interval hours for etcd backup. Default 12 (int)
Retention int
Retention for etcd backup. Default 6 (int)
S3BackupConfig EtcdBackupBackupConfigS3BackupConfig
S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)
SafeTimestamp bool
Timeout int
enabled Boolean
Enable etcd backup (bool)
intervalHours Integer
Interval hours for etcd backup. Default 12 (int)
retention Integer
Retention for etcd backup. Default 6 (int)
s3BackupConfig EtcdBackupBackupConfigS3BackupConfig
S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)
safeTimestamp Boolean
timeout Integer
enabled boolean
Enable etcd backup (bool)
intervalHours number
Interval hours for etcd backup. Default 12 (int)
retention number
Retention for etcd backup. Default 6 (int)
s3BackupConfig EtcdBackupBackupConfigS3BackupConfig
S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)
safeTimestamp boolean
timeout number
enabled bool
Enable etcd backup (bool)
interval_hours int
Interval hours for etcd backup. Default 12 (int)
retention int
Retention for etcd backup. Default 6 (int)
s3_backup_config EtcdBackupBackupConfigS3BackupConfig
S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)
safe_timestamp bool
timeout int
enabled Boolean
Enable etcd backup (bool)
intervalHours Number
Interval hours for etcd backup. Default 12 (int)
retention Number
Retention for etcd backup. Default 6 (int)
s3BackupConfig Property Map
S3 config options for etcd backup. Valid for imported and rke clusters. (list maxitems:1)
safeTimestamp Boolean
timeout Number

EtcdBackupBackupConfigS3BackupConfig
, EtcdBackupBackupConfigS3BackupConfigArgs

BucketName This property is required. string
Bucket name for S3 service (string)
Endpoint This property is required. string
Endpoint for S3 service (string)
AccessKey string
Access key for S3 service (string)
CustomCa string
Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
Folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
Region string
Region for S3 service (string)
SecretKey string
Secret key for S3 service (string)
BucketName This property is required. string
Bucket name for S3 service (string)
Endpoint This property is required. string
Endpoint for S3 service (string)
AccessKey string
Access key for S3 service (string)
CustomCa string
Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
Folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
Region string
Region for S3 service (string)
SecretKey string
Secret key for S3 service (string)
bucketName This property is required. String
Bucket name for S3 service (string)
endpoint This property is required. String
Endpoint for S3 service (string)
accessKey String
Access key for S3 service (string)
customCa String
Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
folder String
Folder for S3 service. Available from Rancher v2.2.7 (string)
region String
Region for S3 service (string)
secretKey String
Secret key for S3 service (string)
bucketName This property is required. string
Bucket name for S3 service (string)
endpoint This property is required. string
Endpoint for S3 service (string)
accessKey string
Access key for S3 service (string)
customCa string
Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
folder string
Folder for S3 service. Available from Rancher v2.2.7 (string)
region string
Region for S3 service (string)
secretKey string
Secret key for S3 service (string)
bucket_name This property is required. str
Bucket name for S3 service (string)
endpoint This property is required. str
Endpoint for S3 service (string)
access_key str
Access key for S3 service (string)
custom_ca str
Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
folder str
Folder for S3 service. Available from Rancher v2.2.7 (string)
region str
Region for S3 service (string)
secret_key str
Secret key for S3 service (string)
bucketName This property is required. String
Bucket name for S3 service (string)
endpoint This property is required. String
Endpoint for S3 service (string)
accessKey String
Access key for S3 service (string)
customCa String
Base64 encoded custom CA for S3 service. Use filebase64() for encoding file. Available from Rancher v2.2.5 (string)
folder String
Folder for S3 service. Available from Rancher v2.2.7 (string)
region String
Region for S3 service (string)
secretKey String
Secret key for S3 service (string)

Import

Etcd Backup can be imported using the Rancher etcd backup ID

$ pulumi import rancher2:index/etcdBackup:EtcdBackup foo &lt;ETCD_BACKUP_ID&gt;
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Rancher2 pulumi/pulumi-rancher2
License
Apache-2.0
Notes
This Pulumi package is based on the rancher2 Terraform Provider.
Rancher 2 v8.1.4 published on Friday, Mar 28, 2025 by Pulumi
pulumi/pulumi-rancher2