Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. bigtable
  5. Table
Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi
pulumi/pulumi-gcp

gcp.bigtable.Table

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.2.1 published on Wednesday, Nov 22, 2023 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

    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()
    {
        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()
    {
        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",
            },
        },
        ChangeStreamRetention = "24h0m0s",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/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{
			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{
			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"),
				},
			},
			ChangeStreamRetention: pulumi.String("24h0m0s"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    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 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()        
            .clusters(InstanceClusterArgs.builder()
                .clusterId("tf-instance-cluster")
                .zone("us-central1-b")
                .numNodes(3)
                .storageType("HDD")
                .build())
            .build());

        var table = new Table("table", TableArgs.builder()        
            .instanceName(instance.name())
            .splitKeys(            
                "a",
                "b",
                "c")
            .columnFamilies(            
                TableColumnFamilyArgs.builder()
                    .family("family-first")
                    .build(),
                TableColumnFamilyArgs.builder()
                    .family("family-second")
                    .build())
            .changeStreamRetention("24h0m0s")
            .build());

    }
}

    import pulumi
import pulumi_gcp as gcp

instance = gcp.bigtable.Instance("instance", clusters=[gcp.bigtable.InstanceClusterArgs(
    cluster_id="tf-instance-cluster",
    zone="us-central1-b",
    num_nodes=3,
    storage_type="HDD",
)])
table = gcp.bigtable.Table("table",
    instance_name=instance.name,
    split_keys=[
        "a",
        "b",
        "c",
    ],
    column_families=[
        gcp.bigtable.TableColumnFamilyArgs(
            family="family-first",
        ),
        gcp.bigtable.TableColumnFamilyArgs(
            family="family-second",
        ),
    ],
    change_stream_retention="24h0m0s")

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

const instance = new gcp.bigtable.Instance("instance", {clusters: [{
    clusterId: "tf-instance-cluster",
    zone: "us-central1-b",
    numNodes: 3,
    storageType: "HDD",
}]});
const table = new gcp.bigtable.Table("table", {
    instanceName: instance.name,
    splitKeys: [
        "a",
        "b",
        "c",
    ],
    columnFamilies: [
        {
            family: "family-first",
        },
        {
            family: "family-second",
        },
    ],
    changeStreamRetention: "24h0m0s",
});

    resources:
  instance:
    type: gcp:bigtable:Instance
    properties:
      clusters:
        - clusterId: tf-instance-cluster
          zone: us-central1-b
          numNodes: 3
          storageType: HDD
  table:
    type: gcp:bigtable:Table
    properties:
      instanceName: ${instance.name}
      splitKeys:
        - a
        - b
        - c
      columnFamilies:
        - family: family-first
        - family: family-second
      changeStreamRetention: 24h0m0s

    Create Table Resource

    new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);
    @overload
def Table(resource_name: str,
          opts: Optional[ResourceOptions] = 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)
@overload
def Table(resource_name: str,
          args: TableArgs,
          opts: Optional[ResourceOptions] = 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.
    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.

    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

    The Table resource accepts the following input properties:

    InstanceName string

    The name of the Bigtable instance.

    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.

    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.

    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.

    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.

    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.

    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,
        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)
    Resource lookup is not supported in YAML
    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:
    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.

    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.

    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.

    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.

    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.

    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

    TableColumnFamily, TableColumnFamilyArgs

    Family string

    The name of the column family.

    Family string

    The name of the column family.

    family String

    The name of the column family.

    family string

    The name of the column family.

    family str

    The name of the column family.

    family String

    The name 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 importedsplit_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}} In Terraform v1.5.0 and later, use an import block to import Bigtable Tables using one of the formats above. For exampletf import {

    id = “projects/{{project}}/instances/{{instance_name}}/tables/{{name}}”

    to = google_bigtable_table.default }

     $ pulumi import gcp:bigtable/table:Table When using the [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import), 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}}

    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 Classic v7.2.1 published on Wednesday, Nov 22, 2023 by Pulumi
    pulumi/pulumi-gcp