Google Cloud v8.32.0, May 21 25

Google Cloud v8.32.0 published on Wednesday, May 21, 2025 by Pulumi

gcp.alloydb.Backup

Explore with Pulumi AI

Google Cloud v8.32.0 published on Wednesday, May 21, 2025 by Pulumi

pulumi/pulumi-gcp

Example Usage

Alloydb Backup Basic

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

const defaultNetwork = new gcp.compute.Network("default", {name: "alloydb-network"});
const defaultCluster = new gcp.alloydb.Cluster("default", {
    clusterId: "alloydb-cluster",
    location: "us-central1",
    networkConfig: {
        network: defaultNetwork.id,
    },
});
const privateIpAlloc = new gcp.compute.GlobalAddress("private_ip_alloc", {
    name: "alloydb-cluster",
    addressType: "INTERNAL",
    purpose: "VPC_PEERING",
    prefixLength: 16,
    network: defaultNetwork.id,
});
const vpcConnection = new gcp.servicenetworking.Connection("vpc_connection", {
    network: defaultNetwork.id,
    service: "servicenetworking.googleapis.com",
    reservedPeeringRanges: [privateIpAlloc.name],
});
const defaultInstance = new gcp.alloydb.Instance("default", {
    cluster: defaultCluster.name,
    instanceId: "alloydb-instance",
    instanceType: "PRIMARY",
}, {
    dependsOn: [vpcConnection],
});
const _default = new gcp.alloydb.Backup("default", {
    location: "us-central1",
    backupId: "alloydb-backup",
    clusterName: defaultCluster.name,
}, {
    dependsOn: [defaultInstance],
});

import pulumi
import pulumi_gcp as gcp

default_network = gcp.compute.Network("default", name="alloydb-network")
default_cluster = gcp.alloydb.Cluster("default",
    cluster_id="alloydb-cluster",
    location="us-central1",
    network_config={
        "network": default_network.id,
    })
private_ip_alloc = gcp.compute.GlobalAddress("private_ip_alloc",
    name="alloydb-cluster",
    address_type="INTERNAL",
    purpose="VPC_PEERING",
    prefix_length=16,
    network=default_network.id)
vpc_connection = gcp.servicenetworking.Connection("vpc_connection",
    network=default_network.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[private_ip_alloc.name])
default_instance = gcp.alloydb.Instance("default",
    cluster=default_cluster.name,
    instance_id="alloydb-instance",
    instance_type="PRIMARY",
    opts = pulumi.ResourceOptions(depends_on=[vpc_connection]))
default = gcp.alloydb.Backup("default",
    location="us-central1",
    backup_id="alloydb-backup",
    cluster_name=default_cluster.name,
    opts = pulumi.ResourceOptions(depends_on=[default_instance]))

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("alloydb-network"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := alloydb.NewCluster(ctx, "default", &alloydb.ClusterArgs{
			ClusterId: pulumi.String("alloydb-cluster"),
			Location:  pulumi.String("us-central1"),
			NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
				Network: defaultNetwork.ID(),
			},
		})
		if err != nil {
			return err
		}
		privateIpAlloc, err := compute.NewGlobalAddress(ctx, "private_ip_alloc", &compute.GlobalAddressArgs{
			Name:         pulumi.String("alloydb-cluster"),
			AddressType:  pulumi.String("INTERNAL"),
			Purpose:      pulumi.String("VPC_PEERING"),
			PrefixLength: pulumi.Int(16),
			Network:      defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		vpcConnection, err := servicenetworking.NewConnection(ctx, "vpc_connection", &servicenetworking.ConnectionArgs{
			Network: defaultNetwork.ID(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				privateIpAlloc.Name,
			},
		})
		if err != nil {
			return err
		}
		defaultInstance, err := alloydb.NewInstance(ctx, "default", &alloydb.InstanceArgs{
			Cluster:      defaultCluster.Name,
			InstanceId:   pulumi.String("alloydb-instance"),
			InstanceType: pulumi.String("PRIMARY"),
		}, pulumi.DependsOn([]pulumi.Resource{
			vpcConnection,
		}))
		if err != nil {
			return err
		}
		_, err = alloydb.NewBackup(ctx, "default", &alloydb.BackupArgs{
			Location:    pulumi.String("us-central1"),
			BackupId:    pulumi.String("alloydb-backup"),
			ClusterName: defaultCluster.Name,
		}, pulumi.DependsOn([]pulumi.Resource{
			defaultInstance,
		}))
		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 defaultNetwork = new Gcp.Compute.Network("default", new()
    {
        Name = "alloydb-network",
    });

    var defaultCluster = new Gcp.Alloydb.Cluster("default", new()
    {
        ClusterId = "alloydb-cluster",
        Location = "us-central1",
        NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
        {
            Network = defaultNetwork.Id,
        },
    });

    var privateIpAlloc = new Gcp.Compute.GlobalAddress("private_ip_alloc", new()
    {
        Name = "alloydb-cluster",
        AddressType = "INTERNAL",
        Purpose = "VPC_PEERING",
        PrefixLength = 16,
        Network = defaultNetwork.Id,
    });

    var vpcConnection = new Gcp.ServiceNetworking.Connection("vpc_connection", new()
    {
        Network = defaultNetwork.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            privateIpAlloc.Name,
        },
    });

    var defaultInstance = new Gcp.Alloydb.Instance("default", new()
    {
        Cluster = defaultCluster.Name,
        InstanceId = "alloydb-instance",
        InstanceType = "PRIMARY",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vpcConnection,
        },
    });

    var @default = new Gcp.Alloydb.Backup("default", new()
    {
        Location = "us-central1",
        BackupId = "alloydb-backup",
        ClusterName = defaultCluster.Name,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            defaultInstance,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterNetworkConfigArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.alloydb.Instance;
import com.pulumi.gcp.alloydb.InstanceArgs;
import com.pulumi.gcp.alloydb.Backup;
import com.pulumi.gcp.alloydb.BackupArgs;
import com.pulumi.resources.CustomResourceOptions;
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 defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .name("alloydb-network")
            .build());

        var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
            .clusterId("alloydb-cluster")
            .location("us-central1")
            .networkConfig(ClusterNetworkConfigArgs.builder()
                .network(defaultNetwork.id())
                .build())
            .build());

        var privateIpAlloc = new GlobalAddress("privateIpAlloc", GlobalAddressArgs.builder()
            .name("alloydb-cluster")
            .addressType("INTERNAL")
            .purpose("VPC_PEERING")
            .prefixLength(16)
            .network(defaultNetwork.id())
            .build());

        var vpcConnection = new Connection("vpcConnection", ConnectionArgs.builder()
            .network(defaultNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(privateIpAlloc.name())
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .cluster(defaultCluster.name())
            .instanceId("alloydb-instance")
            .instanceType("PRIMARY")
            .build(), CustomResourceOptions.builder()
                .dependsOn(vpcConnection)
                .build());

        var default_ = new Backup("default", BackupArgs.builder()
            .location("us-central1")
            .backupId("alloydb-backup")
            .clusterName(defaultCluster.name())
            .build(), CustomResourceOptions.builder()
                .dependsOn(defaultInstance)
                .build());

    }
}

resources:
  default:
    type: gcp:alloydb:Backup
    properties:
      location: us-central1
      backupId: alloydb-backup
      clusterName: ${defaultCluster.name}
    options:
      dependsOn:
        - ${defaultInstance}
  defaultCluster:
    type: gcp:alloydb:Cluster
    name: default
    properties:
      clusterId: alloydb-cluster
      location: us-central1
      networkConfig:
        network: ${defaultNetwork.id}
  defaultInstance:
    type: gcp:alloydb:Instance
    name: default
    properties:
      cluster: ${defaultCluster.name}
      instanceId: alloydb-instance
      instanceType: PRIMARY
    options:
      dependsOn:
        - ${vpcConnection}
  privateIpAlloc:
    type: gcp:compute:GlobalAddress
    name: private_ip_alloc
    properties:
      name: alloydb-cluster
      addressType: INTERNAL
      purpose: VPC_PEERING
      prefixLength: 16
      network: ${defaultNetwork.id}
  vpcConnection:
    type: gcp:servicenetworking:Connection
    name: vpc_connection
    properties:
      network: ${defaultNetwork.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${privateIpAlloc.name}
  defaultNetwork:
    type: gcp:compute:Network
    name: default
    properties:
      name: alloydb-network

Alloydb Backup Full

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

const defaultNetwork = new gcp.compute.Network("default", {name: "alloydb-network"});
const defaultCluster = new gcp.alloydb.Cluster("default", {
    clusterId: "alloydb-cluster",
    location: "us-central1",
    networkConfig: {
        network: defaultNetwork.id,
    },
});
const privateIpAlloc = new gcp.compute.GlobalAddress("private_ip_alloc", {
    name: "alloydb-cluster",
    addressType: "INTERNAL",
    purpose: "VPC_PEERING",
    prefixLength: 16,
    network: defaultNetwork.id,
});
const vpcConnection = new gcp.servicenetworking.Connection("vpc_connection", {
    network: defaultNetwork.id,
    service: "servicenetworking.googleapis.com",
    reservedPeeringRanges: [privateIpAlloc.name],
});
const defaultInstance = new gcp.alloydb.Instance("default", {
    cluster: defaultCluster.name,
    instanceId: "alloydb-instance",
    instanceType: "PRIMARY",
}, {
    dependsOn: [vpcConnection],
});
const _default = new gcp.alloydb.Backup("default", {
    location: "us-central1",
    backupId: "alloydb-backup",
    clusterName: defaultCluster.name,
    description: "example description",
    type: "ON_DEMAND",
    labels: {
        label: "key",
    },
}, {
    dependsOn: [defaultInstance],
});

import pulumi
import pulumi_gcp as gcp

default_network = gcp.compute.Network("default", name="alloydb-network")
default_cluster = gcp.alloydb.Cluster("default",
    cluster_id="alloydb-cluster",
    location="us-central1",
    network_config={
        "network": default_network.id,
    })
private_ip_alloc = gcp.compute.GlobalAddress("private_ip_alloc",
    name="alloydb-cluster",
    address_type="INTERNAL",
    purpose="VPC_PEERING",
    prefix_length=16,
    network=default_network.id)
vpc_connection = gcp.servicenetworking.Connection("vpc_connection",
    network=default_network.id,
    service="servicenetworking.googleapis.com",
    reserved_peering_ranges=[private_ip_alloc.name])
default_instance = gcp.alloydb.Instance("default",
    cluster=default_cluster.name,
    instance_id="alloydb-instance",
    instance_type="PRIMARY",
    opts = pulumi.ResourceOptions(depends_on=[vpc_connection]))
default = gcp.alloydb.Backup("default",
    location="us-central1",
    backup_id="alloydb-backup",
    cluster_name=default_cluster.name,
    description="example description",
    type="ON_DEMAND",
    labels={
        "label": "key",
    },
    opts = pulumi.ResourceOptions(depends_on=[default_instance]))

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/alloydb"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/compute"
	"github.com/pulumi/pulumi-gcp/sdk/v8/go/gcp/servicenetworking"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		defaultNetwork, err := compute.NewNetwork(ctx, "default", &compute.NetworkArgs{
			Name: pulumi.String("alloydb-network"),
		})
		if err != nil {
			return err
		}
		defaultCluster, err := alloydb.NewCluster(ctx, "default", &alloydb.ClusterArgs{
			ClusterId: pulumi.String("alloydb-cluster"),
			Location:  pulumi.String("us-central1"),
			NetworkConfig: &alloydb.ClusterNetworkConfigArgs{
				Network: defaultNetwork.ID(),
			},
		})
		if err != nil {
			return err
		}
		privateIpAlloc, err := compute.NewGlobalAddress(ctx, "private_ip_alloc", &compute.GlobalAddressArgs{
			Name:         pulumi.String("alloydb-cluster"),
			AddressType:  pulumi.String("INTERNAL"),
			Purpose:      pulumi.String("VPC_PEERING"),
			PrefixLength: pulumi.Int(16),
			Network:      defaultNetwork.ID(),
		})
		if err != nil {
			return err
		}
		vpcConnection, err := servicenetworking.NewConnection(ctx, "vpc_connection", &servicenetworking.ConnectionArgs{
			Network: defaultNetwork.ID(),
			Service: pulumi.String("servicenetworking.googleapis.com"),
			ReservedPeeringRanges: pulumi.StringArray{
				privateIpAlloc.Name,
			},
		})
		if err != nil {
			return err
		}
		defaultInstance, err := alloydb.NewInstance(ctx, "default", &alloydb.InstanceArgs{
			Cluster:      defaultCluster.Name,
			InstanceId:   pulumi.String("alloydb-instance"),
			InstanceType: pulumi.String("PRIMARY"),
		}, pulumi.DependsOn([]pulumi.Resource{
			vpcConnection,
		}))
		if err != nil {
			return err
		}
		_, err = alloydb.NewBackup(ctx, "default", &alloydb.BackupArgs{
			Location:    pulumi.String("us-central1"),
			BackupId:    pulumi.String("alloydb-backup"),
			ClusterName: defaultCluster.Name,
			Description: pulumi.String("example description"),
			Type:        pulumi.String("ON_DEMAND"),
			Labels: pulumi.StringMap{
				"label": pulumi.String("key"),
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			defaultInstance,
		}))
		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 defaultNetwork = new Gcp.Compute.Network("default", new()
    {
        Name = "alloydb-network",
    });

    var defaultCluster = new Gcp.Alloydb.Cluster("default", new()
    {
        ClusterId = "alloydb-cluster",
        Location = "us-central1",
        NetworkConfig = new Gcp.Alloydb.Inputs.ClusterNetworkConfigArgs
        {
            Network = defaultNetwork.Id,
        },
    });

    var privateIpAlloc = new Gcp.Compute.GlobalAddress("private_ip_alloc", new()
    {
        Name = "alloydb-cluster",
        AddressType = "INTERNAL",
        Purpose = "VPC_PEERING",
        PrefixLength = 16,
        Network = defaultNetwork.Id,
    });

    var vpcConnection = new Gcp.ServiceNetworking.Connection("vpc_connection", new()
    {
        Network = defaultNetwork.Id,
        Service = "servicenetworking.googleapis.com",
        ReservedPeeringRanges = new[]
        {
            privateIpAlloc.Name,
        },
    });

    var defaultInstance = new Gcp.Alloydb.Instance("default", new()
    {
        Cluster = defaultCluster.Name,
        InstanceId = "alloydb-instance",
        InstanceType = "PRIMARY",
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vpcConnection,
        },
    });

    var @default = new Gcp.Alloydb.Backup("default", new()
    {
        Location = "us-central1",
        BackupId = "alloydb-backup",
        ClusterName = defaultCluster.Name,
        Description = "example description",
        Type = "ON_DEMAND",
        Labels = 
        {
            { "label", "key" },
        },
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            defaultInstance,
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.alloydb.Cluster;
import com.pulumi.gcp.alloydb.ClusterArgs;
import com.pulumi.gcp.alloydb.inputs.ClusterNetworkConfigArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.alloydb.Instance;
import com.pulumi.gcp.alloydb.InstanceArgs;
import com.pulumi.gcp.alloydb.Backup;
import com.pulumi.gcp.alloydb.BackupArgs;
import com.pulumi.resources.CustomResourceOptions;
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 defaultNetwork = new Network("defaultNetwork", NetworkArgs.builder()
            .name("alloydb-network")
            .build());

        var defaultCluster = new Cluster("defaultCluster", ClusterArgs.builder()
            .clusterId("alloydb-cluster")
            .location("us-central1")
            .networkConfig(ClusterNetworkConfigArgs.builder()
                .network(defaultNetwork.id())
                .build())
            .build());

        var privateIpAlloc = new GlobalAddress("privateIpAlloc", GlobalAddressArgs.builder()
            .name("alloydb-cluster")
            .addressType("INTERNAL")
            .purpose("VPC_PEERING")
            .prefixLength(16)
            .network(defaultNetwork.id())
            .build());

        var vpcConnection = new Connection("vpcConnection", ConnectionArgs.builder()
            .network(defaultNetwork.id())
            .service("servicenetworking.googleapis.com")
            .reservedPeeringRanges(privateIpAlloc.name())
            .build());

        var defaultInstance = new Instance("defaultInstance", InstanceArgs.builder()
            .cluster(defaultCluster.name())
            .instanceId("alloydb-instance")
            .instanceType("PRIMARY")
            .build(), CustomResourceOptions.builder()
                .dependsOn(vpcConnection)
                .build());

        var default_ = new Backup("default", BackupArgs.builder()
            .location("us-central1")
            .backupId("alloydb-backup")
            .clusterName(defaultCluster.name())
            .description("example description")
            .type("ON_DEMAND")
            .labels(Map.of("label", "key"))
            .build(), CustomResourceOptions.builder()
                .dependsOn(defaultInstance)
                .build());

    }
}

resources:
  default:
    type: gcp:alloydb:Backup
    properties:
      location: us-central1
      backupId: alloydb-backup
      clusterName: ${defaultCluster.name}
      description: example description
      type: ON_DEMAND
      labels:
        label: key
    options:
      dependsOn:
        - ${defaultInstance}
  defaultCluster:
    type: gcp:alloydb:Cluster
    name: default
    properties:
      clusterId: alloydb-cluster
      location: us-central1
      networkConfig:
        network: ${defaultNetwork.id}
  defaultInstance:
    type: gcp:alloydb:Instance
    name: default
    properties:
      cluster: ${defaultCluster.name}
      instanceId: alloydb-instance
      instanceType: PRIMARY
    options:
      dependsOn:
        - ${vpcConnection}
  privateIpAlloc:
    type: gcp:compute:GlobalAddress
    name: private_ip_alloc
    properties:
      name: alloydb-cluster
      addressType: INTERNAL
      purpose: VPC_PEERING
      prefixLength: 16
      network: ${defaultNetwork.id}
  vpcConnection:
    type: gcp:servicenetworking:Connection
    name: vpc_connection
    properties:
      network: ${defaultNetwork.id}
      service: servicenetworking.googleapis.com
      reservedPeeringRanges:
        - ${privateIpAlloc.name}
  defaultNetwork:
    type: gcp:compute:Network
    name: default
    properties:
      name: alloydb-network

Create Backup Resource

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

Constructor syntax

new Backup(name: string, args: BackupArgs, opts?: CustomResourceOptions);

@overload
def Backup(resource_name: str,
           args: BackupArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Backup(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           backup_id: Optional[str] = None,
           cluster_name: Optional[str] = None,
           location: Optional[str] = None,
           annotations: Optional[Mapping[str, str]] = None,
           description: Optional[str] = None,
           display_name: Optional[str] = None,
           encryption_config: Optional[BackupEncryptionConfigArgs] = None,
           labels: Optional[Mapping[str, str]] = None,
           project: Optional[str] = None,
           type: Optional[str] = None)

func NewBackup(ctx *Context, name string, args BackupArgs, opts ...ResourceOption) (*Backup, error)

public Backup(string name, BackupArgs args, CustomResourceOptions? opts = null)

public Backup(String name, BackupArgs args)
public Backup(String name, BackupArgs args, CustomResourceOptions options)

type: gcp:alloydb:Backup
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 BackupArgs: 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 BackupArgs: 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 BackupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args BackupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args BackupArgs: 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 backupResource = new Gcp.Alloydb.Backup("backupResource", new()
{
    BackupId = "string",
    ClusterName = "string",
    Location = "string",
    Annotations = 
    {
        { "string", "string" },
    },
    Description = "string",
    DisplayName = "string",
    EncryptionConfig = new Gcp.Alloydb.Inputs.BackupEncryptionConfigArgs
    {
        KmsKeyName = "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
    Type = "string",
});

example, err := alloydb.NewBackup(ctx, "backupResource", &alloydb.BackupArgs{
	BackupId:    pulumi.String("string"),
	ClusterName: pulumi.String("string"),
	Location:    pulumi.String("string"),
	Annotations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	DisplayName: pulumi.String("string"),
	EncryptionConfig: &alloydb.BackupEncryptionConfigArgs{
		KmsKeyName: pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
	Type:    pulumi.String("string"),
})

var backupResource = new com.pulumi.gcp.alloydb.Backup("backupResource", com.pulumi.gcp.alloydb.BackupArgs.builder()
    .backupId("string")
    .clusterName("string")
    .location("string")
    .annotations(Map.of("string", "string"))
    .description("string")
    .displayName("string")
    .encryptionConfig(BackupEncryptionConfigArgs.builder()
        .kmsKeyName("string")
        .build())
    .labels(Map.of("string", "string"))
    .project("string")
    .type("string")
    .build());

backup_resource = gcp.alloydb.Backup("backupResource",
    backup_id="string",
    cluster_name="string",
    location="string",
    annotations={
        "string": "string",
    },
    description="string",
    display_name="string",
    encryption_config={
        "kms_key_name": "string",
    },
    labels={
        "string": "string",
    },
    project="string",
    type="string")

const backupResource = new gcp.alloydb.Backup("backupResource", {
    backupId: "string",
    clusterName: "string",
    location: "string",
    annotations: {
        string: "string",
    },
    description: "string",
    displayName: "string",
    encryptionConfig: {
        kmsKeyName: "string",
    },
    labels: {
        string: "string",
    },
    project: "string",
    type: "string",
});

type: gcp:alloydb:Backup
properties:
    annotations:
        string: string
    backupId: string
    clusterName: string
    description: string
    displayName: string
    encryptionConfig:
        kmsKeyName: string
    labels:
        string: string
    location: string
    project: string
    type: string

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

BackupId string

The ID of the alloydb backup.

ClusterName string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

Location string

The location where the alloydb backup should reside.

Annotations Dictionary<string, string>

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 An object containing 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 annotations present in your configuration. Please refer to the field effective_annotations for all of the annotations present on the resource.

Description string

User-provided description of the backup.

DisplayName string

User-settable and human-readable display name for the Backup.

EncryptionConfig BackupEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

Labels Dictionary<string, string>

User-defined labels for the alloydb backup. An object containing 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.

Project string

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

Type string

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

BackupId string

The ID of the alloydb backup.

ClusterName string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

Location string

The location where the alloydb backup should reside.

Annotations map[string]string

Description string

User-provided description of the backup.

DisplayName string

User-settable and human-readable display name for the Backup.

EncryptionConfig BackupEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

Labels map[string]string

User-defined labels for the alloydb backup. An object containing 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.

Project string

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

Type string

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

backupId String

The ID of the alloydb backup.

clusterName String

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

location String

The location where the alloydb backup should reside.

annotations Map<String,String>

description String

User-provided description of the backup.

displayName String

User-settable and human-readable display name for the Backup.

encryptionConfig BackupEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels Map<String,String>

User-defined labels for the alloydb backup. An object containing 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.

project String

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

type String

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

backupId string

The ID of the alloydb backup.

clusterName string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

location string

The location where the alloydb backup should reside.

annotations {[key: string]: string}

description string

User-provided description of the backup.

displayName string

User-settable and human-readable display name for the Backup.

encryptionConfig BackupEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels {[key: string]: string}

User-defined labels for the alloydb backup. An object containing 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.

project string

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

type string

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

backup_id str

The ID of the alloydb backup.

cluster_name str

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

location str

The location where the alloydb backup should reside.

annotations Mapping[str, str]

description str

User-provided description of the backup.

display_name str

User-settable and human-readable display name for the Backup.

encryption_config BackupEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels Mapping[str, str]

User-defined labels for the alloydb backup. An object containing 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.

project str

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

type str

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

backupId String

The ID of the alloydb backup.

clusterName String

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

location String

The location where the alloydb backup should reside.

annotations Map<String>

description String

User-provided description of the backup.

displayName String

User-settable and human-readable display name for the Backup.

encryptionConfig Property Map

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

labels Map<String>

User-defined labels for the alloydb backup. An object containing 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.

project String

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

type String

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

Outputs

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

ClusterUid string: Output only. The system-generated UID of the cluster which was used to create this resource.
CreateTime string: Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
DeleteTime string: Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
EffectiveAnnotations Dictionary<string, string>
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.
EncryptionInfos List<BackupEncryptionInfo>: EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
Etag string: For Resource freshness validation (https://google.aip.dev/154)
ExpiryQuantities List<BackupExpiryQuantity>: Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
ExpiryTime string: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
PulumiLabels Dictionary<string, string>: The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling bool: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
SizeBytes string: Output only. The size of the backup in bytes.
State string: Output only. The current state of the backup.
Uid string: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
UpdateTime string: Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

ClusterUid string: Output only. The system-generated UID of the cluster which was used to create this resource.
CreateTime string: Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
DeleteTime string: Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
EffectiveAnnotations map[string]string
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.
EncryptionInfos []BackupEncryptionInfo: EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
Etag string: For Resource freshness validation (https://google.aip.dev/154)
ExpiryQuantities []BackupExpiryQuantity: Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
ExpiryTime string: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.
Id string: The provider-assigned unique ID for this managed resource.
Name string: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
PulumiLabels map[string]string: The combination of labels configured directly on the resource and default labels configured on the provider.
Reconciling bool: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
SizeBytes string: Output only. The size of the backup in bytes.
State string: Output only. The current state of the backup.
Uid string: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
UpdateTime string: Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

clusterUid String: Output only. The system-generated UID of the cluster which was used to create this resource.
createTime String: Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleteTime String: Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
effectiveAnnotations Map<String,String>
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.
encryptionInfos List<BackupEncryptionInfo>: EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
etag String: For Resource freshness validation (https://google.aip.dev/154)
expiryQuantities List<BackupExpiryQuantity>: Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
expiryTime String: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.
id String: The provider-assigned unique ID for this managed resource.
name String: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
pulumiLabels Map<String,String>: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
sizeBytes String: Output only. The size of the backup in bytes.
state String: Output only. The current state of the backup.
uid String: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime String: Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

clusterUid string: Output only. The system-generated UID of the cluster which was used to create this resource.
createTime string: Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleteTime string: Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
effectiveAnnotations {[key: string]: string}
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.
encryptionInfos BackupEncryptionInfo[]: EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
etag string: For Resource freshness validation (https://google.aip.dev/154)
expiryQuantities BackupExpiryQuantity[]: Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
expiryTime string: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.
id string: The provider-assigned unique ID for this managed resource.
name string: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
pulumiLabels {[key: string]: string}: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling boolean: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
sizeBytes string: Output only. The size of the backup in bytes.
state string: Output only. The current state of the backup.
uid string: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime string: Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

cluster_uid str: Output only. The system-generated UID of the cluster which was used to create this resource.
create_time str: Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
delete_time str: Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
effective_annotations Mapping[str, str]
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.
encryption_infos Sequence[BackupEncryptionInfo]: EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
etag str: For Resource freshness validation (https://google.aip.dev/154)
expiry_quantities Sequence[BackupExpiryQuantity]: Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
expiry_time str: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.
id str: The provider-assigned unique ID for this managed resource.
name str: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
pulumi_labels Mapping[str, str]: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling bool: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
size_bytes str: Output only. The size of the backup in bytes.
state str: Output only. The current state of the backup.
uid str: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
update_time str: Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

clusterUid String: Output only. The system-generated UID of the cluster which was used to create this resource.
createTime String: Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
deleteTime String: Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
effectiveAnnotations Map<String>
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.
encryptionInfos List<Property Map>: EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.
etag String: For Resource freshness validation (https://google.aip.dev/154)
expiryQuantities List<Property Map>: Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.
expiryTime String: Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.
id String: The provider-assigned unique ID for this managed resource.
name String: Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}
pulumiLabels Map<String>: The combination of labels configured directly on the resource and default labels configured on the provider.
reconciling Boolean: Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.
sizeBytes String: Output only. The size of the backup in bytes.
state String: Output only. The current state of the backup.
uid String: Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.
updateTime String: Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Look up Existing Backup Resource

Get an existing Backup 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?: BackupState, opts?: CustomResourceOptions): Backup

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        annotations: Optional[Mapping[str, str]] = None,
        backup_id: Optional[str] = None,
        cluster_name: Optional[str] = None,
        cluster_uid: Optional[str] = None,
        create_time: Optional[str] = None,
        delete_time: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        effective_annotations: Optional[Mapping[str, str]] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        encryption_config: Optional[BackupEncryptionConfigArgs] = None,
        encryption_infos: Optional[Sequence[BackupEncryptionInfoArgs]] = None,
        etag: Optional[str] = None,
        expiry_quantities: Optional[Sequence[BackupExpiryQuantityArgs]] = None,
        expiry_time: 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,
        reconciling: Optional[bool] = None,
        size_bytes: Optional[str] = None,
        state: Optional[str] = None,
        type: Optional[str] = None,
        uid: Optional[str] = None,
        update_time: Optional[str] = None) -> Backup

func GetBackup(ctx *Context, name string, id IDInput, state *BackupState, opts ...ResourceOption) (*Backup, error)

public static Backup Get(string name, Input<string> id, BackupState? state, CustomResourceOptions? opts = null)

public static Backup get(String name, Output<String> id, BackupState state, CustomResourceOptions options)

resources:  _:    type: gcp:alloydb:Backup    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:

Annotations Dictionary<string, string>

BackupId string

The ID of the alloydb backup.

ClusterName string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

ClusterUid string

Output only. The system-generated UID of the cluster which was used to create this resource.

CreateTime string

Output only. Create time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

DeleteTime string

Output only. Delete time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Description string

User-provided description of the backup.

DisplayName string

User-settable and human-readable display name for the Backup.

EffectiveAnnotations Dictionary<string, string>

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.

EncryptionConfig BackupEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

EncryptionInfos List<BackupEncryptionInfo>

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

Etag string

For Resource freshness validation (https://google.aip.dev/154)

ExpiryQuantities List<BackupExpiryQuantity>

Output only. The QuantityBasedExpiry of the backup, specified by the backup's retention policy. Once the expiry quantity is over retention, the backup is eligible to be garbage collected. Structure is documented below.

ExpiryTime string

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.

Labels Dictionary<string, string>

User-defined labels for the alloydb backup. An object containing 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 location where the alloydb backup should reside.

Name string

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}

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.

Reconciling bool

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

SizeBytes string

Output only. The size of the backup in bytes.

State string

Output only. The current state of the backup.

Type string

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

Uid string

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

UpdateTime string

Output only. Update time stamp. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Annotations map[string]string

BackupId string

The ID of the alloydb backup.

ClusterName string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

ClusterUid string

Output only. The system-generated UID of the cluster which was used to create this resource.

CreateTime string

DeleteTime string

Description string

User-provided description of the backup.

DisplayName string

User-settable and human-readable display name for the Backup.

EffectiveAnnotations map[string]string

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.

EncryptionConfig BackupEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

EncryptionInfos []BackupEncryptionInfoArgs

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

Etag string

For Resource freshness validation (https://google.aip.dev/154)

ExpiryQuantities []BackupExpiryQuantityArgs

ExpiryTime string

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.

Labels map[string]string

User-defined labels for the alloydb backup. An object containing 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 location where the alloydb backup should reside.

Name string

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}

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.

Reconciling bool

SizeBytes string

Output only. The size of the backup in bytes.

State string

Output only. The current state of the backup.

Type string

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

Uid string

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

UpdateTime string

annotations Map<String,String>

backupId String

The ID of the alloydb backup.

clusterName String

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

clusterUid String

Output only. The system-generated UID of the cluster which was used to create this resource.

createTime String

deleteTime String

description String

User-provided description of the backup.

displayName String

User-settable and human-readable display name for the Backup.

effectiveAnnotations Map<String,String>

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.

encryptionConfig BackupEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryptionInfos List<BackupEncryptionInfo>

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

etag String

For Resource freshness validation (https://google.aip.dev/154)

expiryQuantities List<BackupExpiryQuantity>

expiryTime String

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.

labels Map<String,String>

User-defined labels for the alloydb backup. An object containing 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 location where the alloydb backup should reside.

name String

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}

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.

reconciling Boolean

sizeBytes String

Output only. The size of the backup in bytes.

state String

Output only. The current state of the backup.

type String

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

uid String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

updateTime String

annotations {[key: string]: string}

backupId string

The ID of the alloydb backup.

clusterName string

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

clusterUid string

Output only. The system-generated UID of the cluster which was used to create this resource.

createTime string

deleteTime string

description string

User-provided description of the backup.

displayName string

User-settable and human-readable display name for the Backup.

effectiveAnnotations {[key: string]: string}

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.

encryptionConfig BackupEncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryptionInfos BackupEncryptionInfo[]

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

etag string

For Resource freshness validation (https://google.aip.dev/154)

expiryQuantities BackupExpiryQuantity[]

expiryTime string

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.

labels {[key: string]: string}

User-defined labels for the alloydb backup. An object containing 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 location where the alloydb backup should reside.

name string

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}

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.

reconciling boolean

sizeBytes string

Output only. The size of the backup in bytes.

state string

Output only. The current state of the backup.

type string

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

uid string

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

updateTime string

annotations Mapping[str, str]

backup_id str

The ID of the alloydb backup.

cluster_name str

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

cluster_uid str

Output only. The system-generated UID of the cluster which was used to create this resource.

create_time str

delete_time str

description str

User-provided description of the backup.

display_name str

User-settable and human-readable display name for the Backup.

effective_annotations Mapping[str, str]

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.

encryption_config BackupEncryptionConfigArgs

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryption_infos Sequence[BackupEncryptionInfoArgs]

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

etag str

For Resource freshness validation (https://google.aip.dev/154)

expiry_quantities Sequence[BackupExpiryQuantityArgs]

expiry_time str

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.

labels Mapping[str, str]

User-defined labels for the alloydb backup. An object containing 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 location where the alloydb backup should reside.

name str

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}

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.

reconciling bool

size_bytes str

Output only. The size of the backup in bytes.

state str

Output only. The current state of the backup.

type str

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

uid str

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

update_time str

annotations Map<String>

backupId String

The ID of the alloydb backup.

clusterName String

The full resource name of the backup source cluster (e.g., projects/{project}/locations/{location}/clusters/{clusterId}).

clusterUid String

Output only. The system-generated UID of the cluster which was used to create this resource.

createTime String

deleteTime String

description String

User-provided description of the backup.

displayName String

User-settable and human-readable display name for the Backup.

effectiveAnnotations Map<String>

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.

encryptionConfig Property Map

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Structure is documented below.

encryptionInfos List<Property Map>

EncryptionInfo describes the encryption information of a cluster or a backup. Structure is documented below.

etag String

For Resource freshness validation (https://google.aip.dev/154)

expiryQuantities List<Property Map>

expiryTime String

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's createTime.

labels Map<String>

User-defined labels for the alloydb backup. An object containing 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 location where the alloydb backup should reside.

name String

Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backupId}

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.

reconciling Boolean

sizeBytes String

Output only. The size of the backup in bytes.

state String

Output only. The current state of the backup.

type String

The backup type, which suggests the trigger for the backup. Possible values are: TYPE_UNSPECIFIED, ON_DEMAND, AUTOMATED, CONTINUOUS.

uid String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

updateTime String

Supporting Types

BackupEncryptionConfig, BackupEncryptionConfigArgs

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

KmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName string: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kms_key_name str: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

kmsKeyName String: The fully-qualified resource name of the KMS key. Each Cloud KMS key is regionalized and has the following format: projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME].

BackupEncryptionInfo, BackupEncryptionInfoArgs

EncryptionType string: (Output) Output only. Type of encryption.
KmsKeyVersions List<string>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

EncryptionType string: (Output) Output only. Type of encryption.
KmsKeyVersions []string: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType String: (Output) Output only. Type of encryption.
kmsKeyVersions List<String>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType string: (Output) Output only. Type of encryption.
kmsKeyVersions string[]: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryption_type str: (Output) Output only. Type of encryption.
kms_key_versions Sequence[str]: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

encryptionType String: (Output) Output only. Type of encryption.
kmsKeyVersions List<String>: (Output) Output only. Cloud KMS key versions that are being used to protect the database or the backup.

BackupExpiryQuantity, BackupExpiryQuantityArgs

RetentionCount int: (Output) Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time (i.e. newest first).
TotalRetentionCount int: (Output) Output only. The length of the quantity-based queue, specified by the backup's retention policy.

RetentionCount int: (Output) Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time (i.e. newest first).
TotalRetentionCount int: (Output) Output only. The length of the quantity-based queue, specified by the backup's retention policy.

retentionCount Integer: (Output) Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time (i.e. newest first).
totalRetentionCount Integer: (Output) Output only. The length of the quantity-based queue, specified by the backup's retention policy.

retentionCount number: (Output) Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time (i.e. newest first).
totalRetentionCount number: (Output) Output only. The length of the quantity-based queue, specified by the backup's retention policy.

retention_count int: (Output) Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time (i.e. newest first).
total_retention_count int: (Output) Output only. The length of the quantity-based queue, specified by the backup's retention policy.

retentionCount Number: (Output) Output only. The backup's position among its backups with the same source cluster and type, by descending chronological order create time (i.e. newest first).
totalRetentionCount Number: (Output) Output only. The length of the quantity-based queue, specified by the backup's retention policy.

Import

Backup can be imported using any of these accepted formats:

projects/{{project}}/locations/{{location}}/backups/{{backup_id}}
{{project}}/{{location}}/{{backup_id}}
{{location}}/{{backup_id}}

When using the pulumi import command, Backup can be imported using one of the formats above. For example:

$ pulumi import gcp:alloydb/backup:Backup default projects/{{project}}/locations/{{location}}/backups/{{backup_id}}

$ pulumi import gcp:alloydb/backup:Backup default {{project}}/{{location}}/{{backup_id}}

$ pulumi import gcp:alloydb/backup:Backup default {{location}}/{{backup_id}}

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.

Google Cloud v8.32.0 published on Wednesday, May 21, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.alloydb.Backup

On this page

On this page

Example Usage

Alloydb Backup Basic

Alloydb Backup Full

Create Backup Resource

Constructor syntax

Parameters

Constructor example

Backup Resource Properties

Inputs

Outputs

Look up Existing Backup Resource

Supporting Types

BackupEncryptionConfig, BackupEncryptionConfigArgs

BackupEncryptionInfo, BackupEncryptionInfoArgs

BackupExpiryQuantity, BackupExpiryQuantityArgs

Import

Package Details

On this page

On this page