BackupChannel class

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: "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="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 = "Description",
        DestinationProject = "projects/24240755850",
        Labels =
        {
            { "key", "some-value" },
        },
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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("Description"),
			DestinationProject: pulumi.String("projects/24240755850"),
			Labels: pulumi.StringMap{
				"key": pulumi.String("some-value"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_gkebackup_backupchannel" "basic" {
  name                = "basic-channel"
  location            = "us-central1"
  description         = "Description"
  destination_project = "projects/24240755850"
  labels = {
    "key" = "some-value"
  }
}

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.ArrayList;
import java.util.Arrays;
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("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: 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}}

Constructors

BackupChannel(String name, {BackupChannelArgs? args, CustomResourceOptions? options})

Creates a new BackupChannel. name The Pulumi resource name. args Arguments used to configure this BackupChannel. The set of arguments for BackupChannel. options Resource options controlling this resource's behavior.

BackupChannel.reference(String urn)

Creates a typed reference to an existing BackupChannel resource.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

User specified descriptive string for this BackupChannel.

late, final

destinationProject ↔ Output<String>

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

late, final

destinationProjectId ↔ Output<String>

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

late, final

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.

late, final

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.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

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" }.

late, final

location ↔ Output<String>

The region of the Backup Channel.

late, final

name ↔ Output<String>

The full name of the BackupChannel Resource.

late, final

project ↔ Output<String>

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

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

uid ↔ Output<String>

Server generated, unique identifier of UUID format.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {BackupChannelState? state, CustomResourceOptions? options}) → BackupChannel

Gets an existing BackupChannel resource's state with the given name and id.