Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigtable
  5. Table
Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.bigtable.Table

Explore with Pulumi AI

gcp logo
Google Cloud v8.27.1 published on Friday, Apr 25, 2025 by Pulumi
pulumi/pulumi-gcp

    Creates a Google Cloud Bigtable table inside an instance. For more information see the official documentation and API.

    Example Usage

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

const instance = new gcp.bigtable.Instance("instance", {
    name: "tf-instance",
    clusters: [{
        clusterId: "tf-instance-cluster",
        zone: "us-central1-b",
        numNodes: 3,
        storageType: "HDD",
    }],
});
const table = new gcp.bigtable.Table("table", {
    name: "tf-table",
    instanceName: instance.name,
    splitKeys: [
        "a",
        "b",
        "c",
    ],
    columnFamilies: [
        {
            family: "family-first",
        },
        {
            family: "family-second",
            type: "intsum",
        },
        {
            family: "family-third",
            type: `        {
\x09\x09\x09\x09\x09"aggregateType": {
\x09\x09\x09\x09\x09\x09"max": {},
\x09\x09\x09\x09\x09\x09"inputType": {
\x09\x09\x09\x09\x09\x09\x09"int64Type": {
\x09\x09\x09\x09\x09\x09\x09\x09"encoding": {
\x09\x09\x09\x09\x09\x09\x09\x09\x09"bigEndianBytes": {}
\x09\x09\x09\x09\x09\x09\x09\x09}
\x09\x09\x09\x09\x09\x09\x09}
\x09\x09\x09\x09\x09\x09}
\x09\x09\x09\x09\x09}
\x09\x09\x09\x09}
`,
        },
    ],
    changeStreamRetention: "24h0m0s",
    automatedBackupPolicy: {
        retentionPeriod: "72h0m0s",
        frequency: "24h0m0s",
    },
});

    import pulumi
import pulumi_gcp as gcp

instance = gcp.bigtable.Instance("instance",
    name="tf-instance",
    clusters=[{
        "cluster_id": "tf-instance-cluster",
        "zone": "us-central1-b",
        "num_nodes": 3,
        "storage_type": "HDD",
    }])
table = gcp.bigtable.Table("table",
    name="tf-table",
    instance_name=instance.name,
    split_keys=[
        "a",
        "b",
        "c",
    ],
    column_families=[
        {
            "family": "family-first",
        },
        {
            "family": "family-second",
            "type": "intsum",
        },
        {
            "family": "family-third",
            "type": """        {
\x09\x09\x09\x09\x09"aggregateType": {
\x09\x09\x09\x09\x09\x09"max": {},
\x09\x09\x09\x09\x09\x09"inputType": {
\x09\x09\x09\x09\x09\x09\x09"int64Type": {
\x09\x09\x09\x09\x09\x09\x09\x09"encoding": {
\x09\x09\x09\x09\x09\x09\x09\x09\x09"bigEndianBytes": {}
\x09\x09\x09\x09\x09\x09\x09\x09}
\x09\x09\x09\x09\x09\x09\x09}
\x09\x09\x09\x09\x09\x09}
\x09\x09\x09\x09\x09}
\x09\x09\x09\x09}
""",
        },
    ],
    change_stream_retention="24h0m0s",
    automated_backup_policy={
        "retention_period": "72h0m0s",
        "frequency": "24h0m0s",
    })

    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 {
		instance, err := bigtable.NewInstance(ctx, "instance", &bigtable.InstanceArgs{
			Name: pulumi.String("tf-instance"),
			Clusters: bigtable.InstanceClusterArray{
				&bigtable.InstanceClusterArgs{
					ClusterId:   pulumi.String("tf-instance-cluster"),
					Zone:        pulumi.String("us-central1-b"),
					NumNodes:    pulumi.Int(3),
					StorageType: pulumi.String("HDD"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = bigtable.NewTable(ctx, "table", &bigtable.TableArgs{
			Name:         pulumi.String("tf-table"),
			InstanceName: instance.Name,
			SplitKeys: pulumi.StringArray{
				pulumi.String("a"),
				pulumi.String("b"),
				pulumi.String("c"),
			},
			ColumnFamilies: bigtable.TableColumnFamilyArray{
				&bigtable.TableColumnFamilyArgs{
					Family: pulumi.String("family-first"),
				},
				&bigtable.TableColumnFamilyArgs{
					Family: pulumi.String("family-second"),
					Type:   pulumi.String("intsum"),
				},
				&bigtable.TableColumnFamilyArgs{
					Family: pulumi.String("family-third"),
					Type: pulumi.String(`        {
					"aggregateType": {
						"max": {},
						"inputType": {
							"int64Type": {
								"encoding": {
									"bigEndianBytes": {}
								}
							}
						}
					}
				}
`),
				},
			},
			ChangeStreamRetention: pulumi.String("24h0m0s"),
			AutomatedBackupPolicy: &bigtable.TableAutomatedBackupPolicyArgs{
				RetentionPeriod: pulumi.String("72h0m0s"),
				Frequency:       pulumi.String("24h0m0s"),
			},
		})
		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 instance = new Gcp.BigTable.Instance("instance", new()
    {
        Name = "tf-instance",
        Clusters = new[]
        {
            new Gcp.BigTable.Inputs.InstanceClusterArgs
            {
                ClusterId = "tf-instance-cluster",
                Zone = "us-central1-b",
                NumNodes = 3,
                StorageType = "HDD",
            },
        },
    });

    var table = new Gcp.BigTable.Table("table", new()
    {
        Name = "tf-table",
        InstanceName = instance.Name,
        SplitKeys = new[]
        {
            "a",
            "b",
            "c",
        },
        ColumnFamilies = new[]
        {
            new Gcp.BigTable.Inputs.TableColumnFamilyArgs
            {
                Family = "family-first",
            },
            new Gcp.BigTable.Inputs.TableColumnFamilyArgs
            {
                Family = "family-second",
                Type = "intsum",
            },
            new Gcp.BigTable.Inputs.TableColumnFamilyArgs
            {
                Family = "family-third",
                Type = @"        {
					""aggregateType"": {
						""max"": {},
						""inputType"": {
							""int64Type"": {
								""encoding"": {
									""bigEndianBytes"": {}
								}
							}
						}
					}
				}
",
            },
        },
        ChangeStreamRetention = "24h0m0s",
        AutomatedBackupPolicy = new Gcp.BigTable.Inputs.TableAutomatedBackupPolicyArgs
        {
            RetentionPeriod = "72h0m0s",
            Frequency = "24h0m0s",
        },
    });

});

    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.Table;
import com.pulumi.gcp.bigtable.TableArgs;
import com.pulumi.gcp.bigtable.inputs.TableColumnFamilyArgs;
import com.pulumi.gcp.bigtable.inputs.TableAutomatedBackupPolicyArgs;
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 instance = new Instance("instance", InstanceArgs.builder()
            .name("tf-instance")
            .clusters(InstanceClusterArgs.builder()
                .clusterId("tf-instance-cluster")
                .zone("us-central1-b")
                .numNodes(3)
                .storageType("HDD")
                .build())
            .build());

        var table = new Table("table", TableArgs.builder()
            .name("tf-table")
            .instanceName(instance.name())
            .splitKeys(            
                "a",
                "b",
                "c")
            .columnFamilies(            
                TableColumnFamilyArgs.builder()
                    .family("family-first")
                    .build(),
                TableColumnFamilyArgs.builder()
                    .family("family-second")
                    .type("intsum")
                    .build(),
                TableColumnFamilyArgs.builder()
                    .family("family-third")
                    .type("""
        {
					"aggregateType": {
						"max": {},
						"inputType": {
							"int64Type": {
								"encoding": {
									"bigEndianBytes": {}
								}
							}
						}
					}
				}
                    """)
                    .build())
            .changeStreamRetention("24h0m0s")
            .automatedBackupPolicy(TableAutomatedBackupPolicyArgs.builder()
                .retentionPeriod("72h0m0s")
                .frequency("24h0m0s")
                .build())
            .build());

    }
}

    resources:
  instance:
    type: gcp:bigtable:Instance
    properties:
      name: tf-instance
      clusters:
        - clusterId: tf-instance-cluster
          zone: us-central1-b
          numNodes: 3
          storageType: HDD
  table:
    type: gcp:bigtable:Table
    properties:
      name: tf-table
      instanceName: ${instance.name}
      splitKeys:
        - a
        - b
        - c
      columnFamilies:
        - family: family-first
        - family: family-second
          type: intsum
        - family: family-third
          type: |2
                    {
            					"aggregateType": {
            						"max": {},
            						"inputType": {
            							"int64Type": {
            								"encoding": {
            									"bigEndianBytes": {}
            								}
            							}
            						}
            					}
            				}
      changeStreamRetention: 24h0m0s
      automatedBackupPolicy:
        retentionPeriod: 72h0m0s
        frequency: 24h0m0s

    Create Table Resource

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

    Constructor syntax

    new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
    @overload
def Table(resource_name: str,
          args: TableArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Table(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          instance_name: Optional[str] = None,
          automated_backup_policy: Optional[TableAutomatedBackupPolicyArgs] = None,
          change_stream_retention: Optional[str] = None,
          column_families: Optional[Sequence[TableColumnFamilyArgs]] = None,
          deletion_protection: Optional[str] = None,
          name: Optional[str] = None,
          project: Optional[str] = None,
          split_keys: Optional[Sequence[str]] = None)
    func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)
    public Table(string name, TableArgs args, CustomResourceOptions? opts = null)
    public Table(String name, TableArgs args)
public Table(String name, TableArgs args, CustomResourceOptions options)

    type: gcp:bigtable:Table
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 TableArgs
    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 TableArgs
    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 TableArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TableArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TableArgs
    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 exampletableResourceResourceFromBigtabletable = new Gcp.BigTable.Table("exampletableResourceResourceFromBigtabletable", new()
{
    InstanceName = "string",
    AutomatedBackupPolicy = new Gcp.BigTable.Inputs.TableAutomatedBackupPolicyArgs
    {
        Frequency = "string",
        RetentionPeriod = "string",
    },
    ChangeStreamRetention = "string",
    ColumnFamilies = new[]
    {
        new Gcp.BigTable.Inputs.TableColumnFamilyArgs
        {
            Family = "string",
            Type = "string",
        },
    },
    DeletionProtection = "string",
    Name = "string",
    Project = "string",
    SplitKeys = new[]
    {
        "string",
    },
});

    example, err := bigtable.NewTable(ctx, "exampletableResourceResourceFromBigtabletable", &bigtable.TableArgs{
	InstanceName: pulumi.String("string"),
	AutomatedBackupPolicy: &bigtable.TableAutomatedBackupPolicyArgs{
		Frequency:       pulumi.String("string"),
		RetentionPeriod: pulumi.String("string"),
	},
	ChangeStreamRetention: pulumi.String("string"),
	ColumnFamilies: bigtable.TableColumnFamilyArray{
		&bigtable.TableColumnFamilyArgs{
			Family: pulumi.String("string"),
			Type:   pulumi.String("string"),
		},
	},
	DeletionProtection: pulumi.String("string"),
	Name:               pulumi.String("string"),
	Project:            pulumi.String("string"),
	SplitKeys: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var exampletableResourceResourceFromBigtabletable = new com.pulumi.gcp.bigtable.Table("exampletableResourceResourceFromBigtabletable", com.pulumi.gcp.bigtable.TableArgs.builder()
    .instanceName("string")
    .automatedBackupPolicy(TableAutomatedBackupPolicyArgs.builder()
        .frequency("string")
        .retentionPeriod("string")
        .build())
    .changeStreamRetention("string")
    .columnFamilies(TableColumnFamilyArgs.builder()
        .family("string")
        .type("string")
        .build())
    .deletionProtection("string")
    .name("string")
    .project("string")
    .splitKeys("string")
    .build());

    exampletable_resource_resource_from_bigtabletable = gcp.bigtable.Table("exampletableResourceResourceFromBigtabletable",
    instance_name="string",
    automated_backup_policy={
        "frequency": "string",
        "retention_period": "string",
    },
    change_stream_retention="string",
    column_families=[{
        "family": "string",
        "type": "string",
    }],
    deletion_protection="string",
    name="string",
    project="string",
    split_keys=["string"])

    const exampletableResourceResourceFromBigtabletable = new gcp.bigtable.Table("exampletableResourceResourceFromBigtabletable", {
    instanceName: "string",
    automatedBackupPolicy: {
        frequency: "string",
        retentionPeriod: "string",
    },
    changeStreamRetention: "string",
    columnFamilies: [{
        family: "string",
        type: "string",
    }],
    deletionProtection: "string",
    name: "string",
    project: "string",
    splitKeys: ["string"],
});

    type: gcp:bigtable:Table
properties:
    automatedBackupPolicy:
        frequency: string
        retentionPeriod: string
    changeStreamRetention: string
    columnFamilies:
        - family: string
          type: string
    deletionProtection: string
    instanceName: string
    name: string
    project: string
    splitKeys:
        - string

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

    InstanceName string
    The name of the Bigtable instance.
    AutomatedBackupPolicy TableAutomatedBackupPolicy
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    ChangeStreamRetention string
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    ColumnFamilies List<TableColumnFamily>
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    DeletionProtection string
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    Name string
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    SplitKeys List<string>
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    InstanceName string
    The name of the Bigtable instance.
    AutomatedBackupPolicy TableAutomatedBackupPolicyArgs
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    ChangeStreamRetention string
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    ColumnFamilies []TableColumnFamilyArgs
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    DeletionProtection string
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    Name string
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    SplitKeys []string
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    instanceName String
    The name of the Bigtable instance.
    automatedBackupPolicy TableAutomatedBackupPolicy
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    changeStreamRetention String
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    columnFamilies List<TableColumnFamily>
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletionProtection String
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    name String
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    splitKeys List<String>
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    instanceName string
    The name of the Bigtable instance.
    automatedBackupPolicy TableAutomatedBackupPolicy
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    changeStreamRetention string
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    columnFamilies TableColumnFamily[]
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletionProtection string
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    name string
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    splitKeys string[]
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    instance_name str
    The name of the Bigtable instance.
    automated_backup_policy TableAutomatedBackupPolicyArgs
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    change_stream_retention str
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    column_families Sequence[TableColumnFamilyArgs]
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletion_protection str
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    name str
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    split_keys Sequence[str]
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    instanceName String
    The name of the Bigtable instance.
    automatedBackupPolicy Property Map
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    changeStreamRetention String
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    columnFamilies List<Property Map>
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletionProtection String
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    name String
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    splitKeys List<String>
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Table Resource

    Get an existing Table 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?: TableState, opts?: CustomResourceOptions): Table
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        automated_backup_policy: Optional[TableAutomatedBackupPolicyArgs] = None,
        change_stream_retention: Optional[str] = None,
        column_families: Optional[Sequence[TableColumnFamilyArgs]] = None,
        deletion_protection: Optional[str] = None,
        instance_name: Optional[str] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        split_keys: Optional[Sequence[str]] = None) -> Table
    func GetTable(ctx *Context, name string, id IDInput, state *TableState, opts ...ResourceOption) (*Table, error)
    public static Table Get(string name, Input<string> id, TableState? state, CustomResourceOptions? opts = null)
    public static Table get(String name, Output<String> id, TableState state, CustomResourceOptions options)
    resources:  _:    type: gcp:bigtable:Table    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:
    AutomatedBackupPolicy TableAutomatedBackupPolicy
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    ChangeStreamRetention string
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    ColumnFamilies List<TableColumnFamily>
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    DeletionProtection string
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    InstanceName string
    The name of the Bigtable instance.
    Name string
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    SplitKeys List<string>
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    AutomatedBackupPolicy TableAutomatedBackupPolicyArgs
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    ChangeStreamRetention string
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    ColumnFamilies []TableColumnFamilyArgs
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    DeletionProtection string
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    InstanceName string
    The name of the Bigtable instance.
    Name string
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    SplitKeys []string
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    automatedBackupPolicy TableAutomatedBackupPolicy
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    changeStreamRetention String
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    columnFamilies List<TableColumnFamily>
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletionProtection String
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    instanceName String
    The name of the Bigtable instance.
    name String
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    splitKeys List<String>
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    automatedBackupPolicy TableAutomatedBackupPolicy
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    changeStreamRetention string
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    columnFamilies TableColumnFamily[]
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletionProtection string
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    instanceName string
    The name of the Bigtable instance.
    name string
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    splitKeys string[]
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    automated_backup_policy TableAutomatedBackupPolicyArgs
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    change_stream_retention str
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    column_families Sequence[TableColumnFamilyArgs]
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletion_protection str
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    instance_name str
    The name of the Bigtable instance.
    name str
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    split_keys Sequence[str]
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.
    automatedBackupPolicy Property Map
    Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, omit this argument. To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency to "0". If this argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.

    changeStreamRetention String
    Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
    columnFamilies List<Property Map>
    A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
    deletionProtection String
    A field to make the table protected against data loss i.e. when set to PROTECTED, deleting the table, the column families in the table, and the instance containing the table would be prohibited. If not provided, deletion protection will be set to UNPROTECTED.
    instanceName String
    The name of the Bigtable instance.
    name String
    The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, 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.
    splitKeys List<String>
    A list of predefined keys to split the table on. !> Warning: Modifying the split_keys of an existing table will cause the provider to delete/recreate the entire gcp.bigtable.Table resource.

    Supporting Types

    TableAutomatedBackupPolicy, TableAutomatedBackupPolicyArgs

    Frequency string
    How frequently automated backups should occur.
    RetentionPeriod string
    How long the automated backups should be retained.
    Frequency string
    How frequently automated backups should occur.
    RetentionPeriod string
    How long the automated backups should be retained.
    frequency String
    How frequently automated backups should occur.
    retentionPeriod String
    How long the automated backups should be retained.
    frequency string
    How frequently automated backups should occur.
    retentionPeriod string
    How long the automated backups should be retained.
    frequency str
    How frequently automated backups should occur.
    retention_period str
    How long the automated backups should be retained.
    frequency String
    How frequently automated backups should occur.
    retentionPeriod String
    How long the automated backups should be retained.

    TableColumnFamily, TableColumnFamilyArgs

    Family string
    The name of the column family.
    Type string
    The type of the column family.
    Family string
    The name of the column family.
    Type string
    The type of the column family.
    family String
    The name of the column family.
    type String
    The type of the column family.
    family string
    The name of the column family.
    type string
    The type of the column family.
    family str
    The name of the column family.
    type str
    The type of the column family.
    family String
    The name of the column family.
    type String
    The type of the column family.

    Import

    -> Fields affected by import The following fields can’t be read and will show diffs if set in config when imported: split_keys

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

    • projects/{{project}}/instances/{{instance_name}}/tables/{{name}}

    • {{project}}/{{instance_name}}/{{name}}

    • {{instance_name}}/{{name}}

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

    $ pulumi import gcp:bigtable/table:Table default projects/{{project}}/instances/{{instance_name}}/tables/{{name}}

    $ pulumi import gcp:bigtable/table:Table default {{project}}/{{instance_name}}/{{name}}

    $ pulumi import gcp:bigtable/table:Table default {{instance_name}}/{{name}}

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

    Package Details

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