Google Cloud v8.21.0, Mar 5 25

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

gcp.bigtable.Instance

Explore with Pulumi AI

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

pulumi/pulumi-gcp

+—

subcategory: “Cloud Bigtable” description: |- Creates a Google Bigtable instance.

gcp.bigtable.Instance

Creates a Google Bigtable instance. For more information see:

API documentation
How-to Guides
- Official Documentation

Example Usage

Simple Instance

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

const production_instance = new gcp.bigtable.Instance("production-instance", {
    name: "tf-instance",
    clusters: [{
        clusterId: "tf-instance-cluster",
        numNodes: 1,
        storageType: "HDD",
    }],
    labels: {
        "my-label": "prod-label",
    },
});

import pulumi
import pulumi_gcp as gcp

production_instance = gcp.bigtable.Instance("production-instance",
    name="tf-instance",
    clusters=[{
        "cluster_id": "tf-instance-cluster",
        "num_nodes": 1,
        "storage_type": "HDD",
    }],
    labels={
        "my-label": "prod-label",
    })

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigtable.NewInstance(ctx, "production-instance", &bigtable.InstanceArgs{
			Name: pulumi.String("tf-instance"),
			Clusters: bigtable.InstanceClusterArray{
				&bigtable.InstanceClusterArgs{
					ClusterId:   pulumi.String("tf-instance-cluster"),
					NumNodes:    pulumi.Int(1),
					StorageType: pulumi.String("HDD"),
				},
			},
			Labels: pulumi.StringMap{
				"my-label": pulumi.String("prod-label"),
			},
		})
		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 production_instance = new Gcp.BigTable.Instance("production-instance", new()
    {
        Name = "tf-instance",
        Clusters = new[]
        {
            new Gcp.BigTable.Inputs.InstanceClusterArgs
            {
                ClusterId = "tf-instance-cluster",
                NumNodes = 1,
                StorageType = "HDD",
            },
        },
        Labels = 
        {
            { "my-label", "prod-label" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigtable.Instance;
import com.pulumi.gcp.bigtable.InstanceArgs;
import com.pulumi.gcp.bigtable.inputs.InstanceClusterArgs;
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 production_instance = new Instance("production-instance", InstanceArgs.builder()
            .name("tf-instance")
            .clusters(InstanceClusterArgs.builder()
                .clusterId("tf-instance-cluster")
                .numNodes(1)
                .storageType("HDD")
                .build())
            .labels(Map.of("my-label", "prod-label"))
            .build());

    }
}

resources:
  production-instance:
    type: gcp:bigtable:Instance
    properties:
      name: tf-instance
      clusters:
        - clusterId: tf-instance-cluster
          numNodes: 1
          storageType: HDD
      labels:
        my-label: prod-label

Replicated Instance

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

const production_instance = new gcp.bigtable.Instance("production-instance", {
    name: "tf-instance",
    clusters: [
        {
            clusterId: "tf-instance-cluster1",
            numNodes: 1,
            storageType: "HDD",
            zone: "us-central1-c",
        },
        {
            clusterId: "tf-instance-cluster2",
            storageType: "HDD",
            zone: "us-central1-b",
            autoscalingConfig: {
                minNodes: 1,
                maxNodes: 3,
                cpuTarget: 50,
            },
        },
    ],
    labels: {
        "my-label": "prod-label",
    },
});

import pulumi
import pulumi_gcp as gcp

production_instance = gcp.bigtable.Instance("production-instance",
    name="tf-instance",
    clusters=[
        {
            "cluster_id": "tf-instance-cluster1",
            "num_nodes": 1,
            "storage_type": "HDD",
            "zone": "us-central1-c",
        },
        {
            "cluster_id": "tf-instance-cluster2",
            "storage_type": "HDD",
            "zone": "us-central1-b",
            "autoscaling_config": {
                "min_nodes": 1,
                "max_nodes": 3,
                "cpu_target": 50,
            },
        },
    ],
    labels={
        "my-label": "prod-label",
    })

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := bigtable.NewInstance(ctx, "production-instance", &bigtable.InstanceArgs{
			Name: pulumi.String("tf-instance"),
			Clusters: bigtable.InstanceClusterArray{
				&bigtable.InstanceClusterArgs{
					ClusterId:   pulumi.String("tf-instance-cluster1"),
					NumNodes:    pulumi.Int(1),
					StorageType: pulumi.String("HDD"),
					Zone:        pulumi.String("us-central1-c"),
				},
				&bigtable.InstanceClusterArgs{
					ClusterId:   pulumi.String("tf-instance-cluster2"),
					StorageType: pulumi.String("HDD"),
					Zone:        pulumi.String("us-central1-b"),
					AutoscalingConfig: &bigtable.InstanceClusterAutoscalingConfigArgs{
						MinNodes:  pulumi.Int(1),
						MaxNodes:  pulumi.Int(3),
						CpuTarget: pulumi.Int(50),
					},
				},
			},
			Labels: pulumi.StringMap{
				"my-label": pulumi.String("prod-label"),
			},
		})
		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 production_instance = new Gcp.BigTable.Instance("production-instance", new()
    {
        Name = "tf-instance",
        Clusters = new[]
        {
            new Gcp.BigTable.Inputs.InstanceClusterArgs
            {
                ClusterId = "tf-instance-cluster1",
                NumNodes = 1,
                StorageType = "HDD",
                Zone = "us-central1-c",
            },
            new Gcp.BigTable.Inputs.InstanceClusterArgs
            {
                ClusterId = "tf-instance-cluster2",
                StorageType = "HDD",
                Zone = "us-central1-b",
                AutoscalingConfig = new Gcp.BigTable.Inputs.InstanceClusterAutoscalingConfigArgs
                {
                    MinNodes = 1,
                    MaxNodes = 3,
                    CpuTarget = 50,
                },
            },
        },
        Labels = 
        {
            { "my-label", "prod-label" },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.bigtable.Instance;
import com.pulumi.gcp.bigtable.InstanceArgs;
import com.pulumi.gcp.bigtable.inputs.InstanceClusterArgs;
import com.pulumi.gcp.bigtable.inputs.InstanceClusterAutoscalingConfigArgs;
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 production_instance = new Instance("production-instance", InstanceArgs.builder()
            .name("tf-instance")
            .clusters(            
                InstanceClusterArgs.builder()
                    .clusterId("tf-instance-cluster1")
                    .numNodes(1)
                    .storageType("HDD")
                    .zone("us-central1-c")
                    .build(),
                InstanceClusterArgs.builder()
                    .clusterId("tf-instance-cluster2")
                    .storageType("HDD")
                    .zone("us-central1-b")
                    .autoscalingConfig(InstanceClusterAutoscalingConfigArgs.builder()
                        .minNodes(1)
                        .maxNodes(3)
                        .cpuTarget(50)
                        .build())
                    .build())
            .labels(Map.of("my-label", "prod-label"))
            .build());

    }
}

resources:
  production-instance:
    type: gcp:bigtable:Instance
    properties:
      name: tf-instance
      clusters:
        - clusterId: tf-instance-cluster1
          numNodes: 1
          storageType: HDD
          zone: us-central1-c
        - clusterId: tf-instance-cluster2
          storageType: HDD
          zone: us-central1-b
          autoscalingConfig:
            minNodes: 1
            maxNodes: 3
            cpuTarget: 50
      labels:
        my-label: prod-label

Create Instance Resource

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

Constructor syntax

new Instance(name: string, args?: InstanceArgs, opts?: CustomResourceOptions);

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

@overload
def Instance(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             clusters: Optional[Sequence[InstanceClusterArgs]] = None,
             deletion_protection: Optional[bool] = None,
             display_name: Optional[str] = None,
             force_destroy: Optional[bool] = None,
             instance_type: Optional[str] = None,
             labels: Optional[Mapping[str, str]] = None,
             name: Optional[str] = None,
             project: Optional[str] = None)

func NewInstance(ctx *Context, name string, args *InstanceArgs, opts ...ResourceOption) (*Instance, error)

public Instance(string name, InstanceArgs? args = null, CustomResourceOptions? opts = null)

public Instance(String name, InstanceArgs args)
public Instance(String name, InstanceArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args InstanceArgs: 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 exampleinstanceResourceResourceFromBigtableinstance = new Gcp.BigTable.Instance("exampleinstanceResourceResourceFromBigtableinstance", new()
{
    Clusters = new[]
    {
        new Gcp.BigTable.Inputs.InstanceClusterArgs
        {
            ClusterId = "string",
            AutoscalingConfig = new Gcp.BigTable.Inputs.InstanceClusterAutoscalingConfigArgs
            {
                CpuTarget = 0,
                MaxNodes = 0,
                MinNodes = 0,
                StorageTarget = 0,
            },
            KmsKeyName = "string",
            NumNodes = 0,
            State = "string",
            StorageType = "string",
            Zone = "string",
        },
    },
    DeletionProtection = false,
    DisplayName = "string",
    ForceDestroy = false,
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Project = "string",
});

example, err := bigtable.NewInstance(ctx, "exampleinstanceResourceResourceFromBigtableinstance", &bigtable.InstanceArgs{
	Clusters: bigtable.InstanceClusterArray{
		&bigtable.InstanceClusterArgs{
			ClusterId: pulumi.String("string"),
			AutoscalingConfig: &bigtable.InstanceClusterAutoscalingConfigArgs{
				CpuTarget:     pulumi.Int(0),
				MaxNodes:      pulumi.Int(0),
				MinNodes:      pulumi.Int(0),
				StorageTarget: pulumi.Int(0),
			},
			KmsKeyName:  pulumi.String("string"),
			NumNodes:    pulumi.Int(0),
			State:       pulumi.String("string"),
			StorageType: pulumi.String("string"),
			Zone:        pulumi.String("string"),
		},
	},
	DeletionProtection: pulumi.Bool(false),
	DisplayName:        pulumi.String("string"),
	ForceDestroy:       pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
})

var exampleinstanceResourceResourceFromBigtableinstance = new Instance("exampleinstanceResourceResourceFromBigtableinstance", InstanceArgs.builder()
    .clusters(InstanceClusterArgs.builder()
        .clusterId("string")
        .autoscalingConfig(InstanceClusterAutoscalingConfigArgs.builder()
            .cpuTarget(0)
            .maxNodes(0)
            .minNodes(0)
            .storageTarget(0)
            .build())
        .kmsKeyName("string")
        .numNodes(0)
        .state("string")
        .storageType("string")
        .zone("string")
        .build())
    .deletionProtection(false)
    .displayName("string")
    .forceDestroy(false)
    .labels(Map.of("string", "string"))
    .name("string")
    .project("string")
    .build());

exampleinstance_resource_resource_from_bigtableinstance = gcp.bigtable.Instance("exampleinstanceResourceResourceFromBigtableinstance",
    clusters=[{
        "cluster_id": "string",
        "autoscaling_config": {
            "cpu_target": 0,
            "max_nodes": 0,
            "min_nodes": 0,
            "storage_target": 0,
        },
        "kms_key_name": "string",
        "num_nodes": 0,
        "state": "string",
        "storage_type": "string",
        "zone": "string",
    }],
    deletion_protection=False,
    display_name="string",
    force_destroy=False,
    labels={
        "string": "string",
    },
    name="string",
    project="string")

const exampleinstanceResourceResourceFromBigtableinstance = new gcp.bigtable.Instance("exampleinstanceResourceResourceFromBigtableinstance", {
    clusters: [{
        clusterId: "string",
        autoscalingConfig: {
            cpuTarget: 0,
            maxNodes: 0,
            minNodes: 0,
            storageTarget: 0,
        },
        kmsKeyName: "string",
        numNodes: 0,
        state: "string",
        storageType: "string",
        zone: "string",
    }],
    deletionProtection: false,
    displayName: "string",
    forceDestroy: false,
    labels: {
        string: "string",
    },
    name: "string",
    project: "string",
});

type: gcp:bigtable:Instance
properties:
    clusters:
        - autoscalingConfig:
            cpuTarget: 0
            maxNodes: 0
            minNodes: 0
            storageTarget: 0
          clusterId: string
          kmsKeyName: string
          numNodes: 0
          state: string
          storageType: string
          zone: string
    deletionProtection: false
    displayName: string
    forceDestroy: false
    labels:
        string: string
    name: string
    project: string

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

Clusters List<InstanceCluster>

A block of cluster configuration options. This can be specified at least once, and up to as many as possible within 8 cloud regions. Removing the field entirely from the config will cause the provider to default to the backend value. See structure below.

DeletionProtection bool

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

DisplayName string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

ForceDestroy bool

Deleting a BigTable instance can be blocked if any backups are present in the instance. When force_destroy is set to true, the Provider will delete all backups found in the BigTable instance before attempting to delete the instance itself. Defaults to false.

InstanceType string

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION". It is recommended to leave this field unspecified since the distinction between "DEVELOPMENT" and "PRODUCTION" instances is going away, and all instances will become "PRODUCTION" instances. This means that new and existing "DEVELOPMENT" instances will be converted to "PRODUCTION" instances. It is recommended for users to use "PRODUCTION" instances in any case, since a 1-node "PRODUCTION" instance is functionally identical to a "DEVELOPMENT" instance, but without the accompanying restrictions.

Deprecated: It is recommended to leave this field unspecified since the distinction between "DEVELOPMENT" and "PRODUCTION" instances is going away, and all instances will become "PRODUCTION" instances. This means that new and existing "DEVELOPMENT" instances will be converted to "PRODUCTION" instances. It is recommended for users to use "PRODUCTION" instances in any case, since a 1-node "PRODUCTION" instance is functionally identical to a "DEVELOPMENT" instance, but without the accompanying restrictions.

Labels Dictionary<string, string>

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

Project string

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

Clusters []InstanceClusterArgs

DeletionProtection bool

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

DisplayName string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

ForceDestroy bool

InstanceType string

Labels map[string]string

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

Project string

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

clusters List<InstanceCluster>

deletionProtection Boolean

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

displayName String

The human-readable display name of the Bigtable instance. Defaults to the instance name.

forceDestroy Boolean

instanceType String

labels Map<String,String>

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

project String

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

clusters InstanceCluster[]

deletionProtection boolean

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

displayName string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

forceDestroy boolean

instanceType string

labels {[key: string]: string}

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

project string

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

clusters Sequence[InstanceClusterArgs]

deletion_protection bool

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

display_name str

The human-readable display name of the Bigtable instance. Defaults to the instance name.

force_destroy bool

instance_type str

labels Mapping[str, str]

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

project str

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

clusters List<Property Map>

deletionProtection Boolean

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

displayName String

The human-readable display name of the Bigtable instance. Defaults to the instance name.

forceDestroy Boolean

instanceType String

labels Map<String>

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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 Instance resource produces the following output properties:

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

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

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

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

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

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

Look up Existing Instance Resource

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        clusters: Optional[Sequence[InstanceClusterArgs]] = None,
        deletion_protection: Optional[bool] = None,
        display_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        force_destroy: Optional[bool] = None,
        instance_type: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None) -> Instance

func GetInstance(ctx *Context, name string, id IDInput, state *InstanceState, opts ...ResourceOption) (*Instance, error)

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

public static Instance get(String name, Output<String> id, InstanceState state, CustomResourceOptions options)

resources:  _:    type: gcp:bigtable:Instance    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:

Clusters List<InstanceCluster>

DeletionProtection bool

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

DisplayName string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

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.

ForceDestroy bool

InstanceType string

Labels Dictionary<string, string>

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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.

Clusters []InstanceClusterArgs

DeletionProtection bool

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

DisplayName string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

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.

ForceDestroy bool

InstanceType string

Labels map[string]string

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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.

clusters List<InstanceCluster>

deletionProtection Boolean

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

displayName String

The human-readable display name of the Bigtable instance. Defaults to the instance name.

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.

forceDestroy Boolean

instanceType String

labels Map<String,String>

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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.

clusters InstanceCluster[]

deletionProtection boolean

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

displayName string

The human-readable display name of the Bigtable instance. Defaults to the instance name.

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.

forceDestroy boolean

instanceType string

labels {[key: string]: string}

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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.

clusters Sequence[InstanceClusterArgs]

deletion_protection bool

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

display_name str

The human-readable display name of the Bigtable instance. Defaults to the instance name.

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.

force_destroy bool

instance_type str

labels Mapping[str, str]

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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.

clusters List<Property Map>

deletionProtection Boolean

Whether or not to allow this provider to destroy the instance. Unless this field is set to false in the statefile, a pulumi destroy or pulumi up that would delete the instance will fail.

displayName String

The human-readable display name of the Bigtable instance. Defaults to the instance name.

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.

forceDestroy Boolean

instanceType String

labels Map<String>

A set of key/value label pairs to assign to the resource. Label keys must follow the requirements at https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements.

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 name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance. Must be 6-33 characters and must only contain hyphens, lowercase letters and numbers.

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.

Supporting Types

InstanceCluster, InstanceClusterArgs

ClusterId string

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

AutoscalingConfig InstanceClusterAutoscalingConfig

Autoscaling config for the cluster, contains the following arguments:

KmsKeyName string

Describes the Cloud KMS encryption key that will be used to protect the destination Bigtable cluster. The requirements for this key are: 1) The Cloud Bigtable service account associated with the project that contains this cluster must be granted the cloudkms.cryptoKeyEncrypterDecrypter role on the CMEK key. 2) Only regional keys can be used and the region of the CMEK key must match the region of the cluster.

Note: Removing the field entirely from the config will cause the provider to default to the backend value.

!> Warning: Modifying this field will cause the provider to delete/recreate the entire resource.

!> Warning: Modifying the storage_type, zone or kms_key_name of an existing cluster (by cluster_id) will cause the provider to delete/recreate the entire gcp.bigtable.Instance resource. If these values are changing, use a new cluster_id.

NumNodes int

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

State string

describes the current state of the cluster.

StorageType string

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

Zone string

The zone to create the Cloud Bigtable cluster in. If it not specified, the provider zone is used. Each cluster must have a different zone in the same region. Zones that support Bigtable instances are noted on the Cloud Bigtable locations page.

ClusterId string

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

AutoscalingConfig InstanceClusterAutoscalingConfig

Autoscaling config for the cluster, contains the following arguments:

KmsKeyName string

Note: Removing the field entirely from the config will cause the provider to default to the backend value.

!> Warning: Modifying this field will cause the provider to delete/recreate the entire resource.

NumNodes int

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

State string

describes the current state of the cluster.

StorageType string

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

Zone string

clusterId String

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

autoscalingConfig InstanceClusterAutoscalingConfig

Autoscaling config for the cluster, contains the following arguments:

kmsKeyName String

Note: Removing the field entirely from the config will cause the provider to default to the backend value.

!> Warning: Modifying this field will cause the provider to delete/recreate the entire resource.

numNodes Integer

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

state String

describes the current state of the cluster.

storageType String

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

zone String

clusterId string

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

autoscalingConfig InstanceClusterAutoscalingConfig

Autoscaling config for the cluster, contains the following arguments:

kmsKeyName string

Note: Removing the field entirely from the config will cause the provider to default to the backend value.

!> Warning: Modifying this field will cause the provider to delete/recreate the entire resource.

numNodes number

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

state string

describes the current state of the cluster.

storageType string

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

zone string

cluster_id str

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

autoscaling_config InstanceClusterAutoscalingConfig

Autoscaling config for the cluster, contains the following arguments:

kms_key_name str

Note: Removing the field entirely from the config will cause the provider to default to the backend value.

!> Warning: Modifying this field will cause the provider to delete/recreate the entire resource.

num_nodes int

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

state str

describes the current state of the cluster.

storage_type str

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

zone str

clusterId String

The ID of the Cloud Bigtable cluster. Must be 6-30 characters and must only contain hyphens, lowercase letters and numbers.

autoscalingConfig Property Map

Autoscaling config for the cluster, contains the following arguments:

kmsKeyName String

Note: Removing the field entirely from the config will cause the provider to default to the backend value.

!> Warning: Modifying this field will cause the provider to delete/recreate the entire resource.

numNodes Number

The number of nodes in the cluster. If no value is set, Cloud Bigtable automatically allocates nodes based on your data footprint and optimized for 50% storage utilization.

state String

describes the current state of the cluster.

storageType String

The storage type to use. One of "SSD" or "HDD". Defaults to "SSD".

zone String

InstanceClusterAutoscalingConfig, InstanceClusterAutoscalingConfigArgs

CpuTarget int

The target CPU utilization for autoscaling, in percentage. Must be between 10 and 80.

MaxNodes int

The maximum number of nodes for autoscaling.

MinNodes int

The minimum number of nodes for autoscaling.

StorageTarget int

The target storage utilization for autoscaling, in GB, for each node in a cluster. This number is limited between 2560 (2.5TiB) and 5120 (5TiB) for a SSD cluster and between 8192 (8TiB) and 16384 (16 TiB) for an HDD cluster. If not set, whatever is already set for the cluster will not change, or if the cluster is just being created, it will use the default value of 2560 for SSD clusters and 8192 for HDD clusters.

!> Warning: Only one of autoscaling_config or num_nodes should be set for a cluster. If both are set, num_nodes is ignored. If none is set, autoscaling will be disabled and sized to the current node count.

CpuTarget int

The target CPU utilization for autoscaling, in percentage. Must be between 10 and 80.

MaxNodes int

The maximum number of nodes for autoscaling.

MinNodes int

The minimum number of nodes for autoscaling.

StorageTarget int

cpuTarget Integer

The target CPU utilization for autoscaling, in percentage. Must be between 10 and 80.

maxNodes Integer

The maximum number of nodes for autoscaling.

minNodes Integer

The minimum number of nodes for autoscaling.

storageTarget Integer

cpuTarget number

The target CPU utilization for autoscaling, in percentage. Must be between 10 and 80.

maxNodes number

The maximum number of nodes for autoscaling.

minNodes number

The minimum number of nodes for autoscaling.

storageTarget number

cpu_target int

The target CPU utilization for autoscaling, in percentage. Must be between 10 and 80.

max_nodes int

The maximum number of nodes for autoscaling.

min_nodes int

The minimum number of nodes for autoscaling.

storage_target int

cpuTarget Number

The target CPU utilization for autoscaling, in percentage. Must be between 10 and 80.

maxNodes Number

The maximum number of nodes for autoscaling.

minNodes Number

The minimum number of nodes for autoscaling.

storageTarget Number

Import

Bigtable Instances can be imported using any of these accepted formats:

projects/{{project}}/instances/{{name}}
{{project}}/{{name}}
{{name}}

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

$ pulumi import gcp:bigtable/instance:Instance default projects/{{project}}/instances/{{name}}

$ pulumi import gcp:bigtable/instance:Instance default {{project}}/{{name}}

$ pulumi import gcp:bigtable/instance:Instance default {{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.

Google Cloud v8.21.0 published on Wednesday, Mar 5, 2025 by Pulumi

pulumi/pulumi-gcp

gcp.bigtable.Instance

On this page

On this page

+—

subcategory: “Cloud Bigtable” description: |- Creates a Google Bigtable instance.

gcp.bigtable.Instance

Example Usage

Simple Instance

Replicated Instance

Create Instance Resource

Constructor syntax

Parameters

Constructor example

Instance Resource Properties

Inputs

Outputs

Look up Existing Instance Resource

Supporting Types

InstanceCluster, InstanceClusterArgs

InstanceClusterAutoscalingConfig, InstanceClusterAutoscalingConfigArgs

Import

Package Details

On this page

On this page