pulumi-gcp-kotlin/com.pulumi.gcp.gkebackup.kotlin/BackupChannel

BackupChannel

class BackupChannel : KotlinCustomResource

A BackupChannel imposes constraints on where clusters can be backed up. The BackupChannel should be in the same project and region as the cluster being backed up. The backup can be created only in destination_project. To get more information about BackupChannel, see:

API documentation
How-to Guides

Official Documentation

Example Usage

Gkebackup Backupchannel Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const basic = new gcp.gkebackup.BackupChannel("basic", {
    name: "basic-channel",
    location: "us-central1",
    description: "",
    destinationProject: "projects/24240755850",
    labels: {
        key: "some-value",
    },
});

import pulumi
import pulumi_gcp as gcp
basic = gcp.gkebackup.BackupChannel("basic",
    name="basic-channel",
    location="us-central1",
    description="",
    destination_project="projects/24240755850",
    labels={
        "key": "some-value",
    })

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
    var basic = new Gcp.GkeBackup.BackupChannel("basic", new()
    {
        Name = "basic-channel",
        Location = "us-central1",
        Description = "",
        DestinationProject = "projects/24240755850",
        Labels =
        {
            { "key", "some-value" },
        },
    });
});

package main
import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/gkebackup"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := gkebackup.NewBackupChannel(ctx, "basic", &gkebackup.BackupChannelArgs{
			Name:               pulumi.String("basic-channel"),
			Location:           pulumi.String("us-central1"),
			Description:        pulumi.String(""),
			DestinationProject: pulumi.String("projects/24240755850"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("some-value"),
			},
		})
		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.gcp.gkebackup.BackupChannel;
import com.pulumi.gcp.gkebackup.BackupChannelArgs;
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) {
        var basic = new BackupChannel("basic", BackupChannelArgs.builder()
            .name("basic-channel")
            .location("us-central1")
            .description("")
            .destinationProject("projects/24240755850")
            .labels(Map.of("key", "some-value"))
            .build());
    }
}

resources:
  basic:
    type: gcp:gkebackup:BackupChannel
    properties:
      name: basic-channel
      location: us-central1
      description: ""
      destinationProject: projects/24240755850
      labels:
        key: some-value

Import

BackupChannel can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/backupChannels/{{name}}
{{project}}/{{location}}/{{name}}
{{location}}/{{name}} When using the pulumi import command, BackupChannel can be imported using one of the formats above. For example:

$ pulumi import gcp:gkebackup/backupChannel:BackupChannel default projects/{{project}}/locations/{{location}}/backupChannels/{{name}}

$ pulumi import gcp:gkebackup/backupChannel:BackupChannel default {{project}}/{{location}}/{{name}}

$ pulumi import gcp:gkebackup/backupChannel:BackupChannel default {{location}}/{{name}}

Properties

description

val description: Output<String>?

User specified descriptive string for this BackupChannel.

destinationProject

val destinationProject: Output<String>

The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.

destinationProjectId

val destinationProjectId: Output<String>

The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".

effectiveLabels

val effectiveLabels: Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

etag

val etag: Output<String>

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup channel from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupChannel updates in order to avoid race conditions: An etag is returned in the response to backupChannels.get, and systems are expected to put that etag in the request to backupChannels.patch or backupChannels.delete to ensure that their change will be applied to the same version of the resource.

val id: Output<String>

labels

val labels: Output<Map<String, String>>?

Description: A set of custom labels supplied by the user. A list of key->value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }. Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effective_labels for all of the labels present on the resource.

location

val location: Output<String>

The region of the Backup Channel.

name

val name: Output<String>

The full name of the BackupChannel Resource.

project

val project: Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiLabels