1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. gkebackup
  5. BackupChannel
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

gcp.gkebackup.BackupChannel

Explore with Pulumi AI

gcp logo
Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi

    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:

    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",
        })
    
    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
    	})
    }
    
    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 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
    

    Create BackupChannel Resource

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

    Constructor syntax

    new BackupChannel(name: string, args: BackupChannelArgs, opts?: CustomResourceOptions);
    @overload
    def BackupChannel(resource_name: str,
                      args: BackupChannelArgs,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def BackupChannel(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      destination_project: Optional[str] = None,
                      location: Optional[str] = None,
                      description: Optional[str] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      name: Optional[str] = None,
                      project: Optional[str] = None)
    func NewBackupChannel(ctx *Context, name string, args BackupChannelArgs, opts ...ResourceOption) (*BackupChannel, error)
    public BackupChannel(string name, BackupChannelArgs args, CustomResourceOptions? opts = null)
    public BackupChannel(String name, BackupChannelArgs args)
    public BackupChannel(String name, BackupChannelArgs args, CustomResourceOptions options)
    
    type: gcp:gkebackup:BackupChannel
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args BackupChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args BackupChannelArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args BackupChannelArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args BackupChannelArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args BackupChannelArgs
    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 backupChannelResource = new Gcp.GkeBackup.BackupChannel("backupChannelResource", new()
    {
        DestinationProject = "string",
        Location = "string",
        Description = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Project = "string",
    });
    
    example, err := gkebackup.NewBackupChannel(ctx, "backupChannelResource", &gkebackup.BackupChannelArgs{
    	DestinationProject: pulumi.String("string"),
    	Location:           pulumi.String("string"),
    	Description:        pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name:    pulumi.String("string"),
    	Project: pulumi.String("string"),
    })
    
    var backupChannelResource = new BackupChannel("backupChannelResource", BackupChannelArgs.builder()
        .destinationProject("string")
        .location("string")
        .description("string")
        .labels(Map.of("string", "string"))
        .name("string")
        .project("string")
        .build());
    
    backup_channel_resource = gcp.gkebackup.BackupChannel("backupChannelResource",
        destination_project="string",
        location="string",
        description="string",
        labels={
            "string": "string",
        },
        name="string",
        project="string")
    
    const backupChannelResource = new gcp.gkebackup.BackupChannel("backupChannelResource", {
        destinationProject: "string",
        location: "string",
        description: "string",
        labels: {
            string: "string",
        },
        name: "string",
        project: "string",
    });
    
    type: gcp:gkebackup:BackupChannel
    properties:
        description: string
        destinationProject: string
        labels:
            string: string
        location: string
        name: string
        project: string
    

    BackupChannel 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 BackupChannel resource accepts the following input properties:

    DestinationProject string
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    Location string
    The region of the Backup Channel.


    Description string
    User specified descriptive string for this BackupChannel.
    Labels Dictionary<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.

    Name string
    The full name of the BackupChannel Resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    DestinationProject string
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    Location string
    The region of the Backup Channel.


    Description string
    User specified descriptive string for this BackupChannel.
    Labels 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.

    Name string
    The full name of the BackupChannel Resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    destinationProject String
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    location String
    The region of the Backup Channel.


    description String
    User specified descriptive string for this BackupChannel.
    labels 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.

    name String
    The full name of the BackupChannel Resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    destinationProject string
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    location string
    The region of the Backup Channel.


    description string
    User specified descriptive string for this BackupChannel.
    labels {[key: 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.

    name string
    The full name of the BackupChannel Resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    destination_project str
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    location str
    The region of the Backup Channel.


    description str
    User specified descriptive string for this BackupChannel.
    labels Mapping[str, str]

    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.

    name str
    The full name of the BackupChannel Resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    destinationProject String
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    location String
    The region of the Backup Channel.


    description String
    User specified descriptive string for this BackupChannel.
    labels Map<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.

    name String
    The full name of the BackupChannel Resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

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

    DestinationProjectId string
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    EffectiveLabels Dictionary<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 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server generated, unique identifier of UUID format.
    DestinationProjectId string
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    EffectiveLabels 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 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server generated, unique identifier of UUID format.
    destinationProjectId String
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effectiveLabels 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 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.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server generated, unique identifier of UUID format.
    destinationProjectId string
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effectiveLabels {[key: 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 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.
    id string
    The provider-assigned unique ID for this managed resource.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid string
    Server generated, unique identifier of UUID format.
    destination_project_id str
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid str
    Server generated, unique identifier of UUID format.
    destinationProjectId String
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag 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.
    id String
    The provider-assigned unique ID for this managed resource.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server generated, unique identifier of UUID format.

    Look up Existing BackupChannel Resource

    Get an existing BackupChannel 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?: BackupChannelState, opts?: CustomResourceOptions): BackupChannel
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            description: Optional[str] = None,
            destination_project: Optional[str] = None,
            destination_project_id: Optional[str] = None,
            effective_labels: Optional[Mapping[str, str]] = None,
            etag: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            project: Optional[str] = None,
            pulumi_labels: Optional[Mapping[str, str]] = None,
            uid: Optional[str] = None) -> BackupChannel
    func GetBackupChannel(ctx *Context, name string, id IDInput, state *BackupChannelState, opts ...ResourceOption) (*BackupChannel, error)
    public static BackupChannel Get(string name, Input<string> id, BackupChannelState? state, CustomResourceOptions? opts = null)
    public static BackupChannel get(String name, Output<String> id, BackupChannelState state, CustomResourceOptions options)
    resources:  _:    type: gcp:gkebackup:BackupChannel    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    Description string
    User specified descriptive string for this BackupChannel.
    DestinationProject string
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    DestinationProjectId string
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    EffectiveLabels Dictionary<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 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.
    Labels Dictionary<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 string
    The region of the Backup Channel.


    Name string
    The full name of the BackupChannel Resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server generated, unique identifier of UUID format.
    Description string
    User specified descriptive string for this BackupChannel.
    DestinationProject string
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    DestinationProjectId string
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    EffectiveLabels 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 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.
    Labels 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 string
    The region of the Backup Channel.


    Name string
    The full name of the BackupChannel Resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    Uid string
    Server generated, unique identifier of UUID format.
    description String
    User specified descriptive string for this BackupChannel.
    destinationProject String
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    destinationProjectId String
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effectiveLabels 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 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.
    labels 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 String
    The region of the Backup Channel.


    name String
    The full name of the BackupChannel Resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server generated, unique identifier of UUID format.
    description string
    User specified descriptive string for this BackupChannel.
    destinationProject string
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    destinationProjectId string
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effectiveLabels {[key: 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 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.
    labels {[key: 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 string
    The region of the Backup Channel.


    name string
    The full name of the BackupChannel Resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid string
    Server generated, unique identifier of UUID format.
    description str
    User specified descriptive string for this BackupChannel.
    destination_project str
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    destination_project_id str
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag str
    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.
    labels Mapping[str, str]

    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 str
    The region of the Backup Channel.


    name str
    The full name of the BackupChannel Resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid str
    Server generated, unique identifier of UUID format.
    description String
    User specified descriptive string for this BackupChannel.
    destinationProject String
    The project where Backups are allowed to be stored. The format is projects/{project}. {project} can only be a project number.
    destinationProjectId String
    The project_id where Backups are allowed to be stored. Example Project ID: "my-project-id".
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    etag 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.
    labels Map<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 String
    The region of the Backup Channel.


    name String
    The full name of the BackupChannel Resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    uid String
    Server generated, unique identifier of UUID format.

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

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

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.29.0 published on Thursday, May 1, 2025 by Pulumi