Table

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

Create a Table Resource

new Table(name: string, args: TableArgs, opts?: CustomResourceOptions);

def Table(resource_name, opts=None, column_families=None, instance_name=None, name=None, project=None, split_keys=None, __props__=None);

func NewTable(ctx *Context, name string, args TableArgs, opts ...ResourceOption) (*Table, error)

public Table(string name, TableArgs args, CustomResourceOptions? opts = null)

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.
opts ResourceOptions: A bag of options that control this 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.

Table Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Table resource accepts the following input properties:

InstanceName string: The name of the Bigtable instance.
ColumnFamilies List<TableColumnFamilyArgs>: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
Name string: The name of the table.
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.
ColumnFamilies []TableColumnFamily: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
Name string: The name of the table.
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.
columnFamilies TableColumnFamily[]: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
name string: The name of the table.
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.
column_families List[TableColumnFamily]: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
name str: The name of the table.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
split_keys List[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.

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 str: The provider-assigned unique ID for this managed resource.

Look up an 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

static get(resource_name, id, opts=None, column_families=None, instance_name=None, name=None, project=None, split_keys=None, __props__=None);

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)

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.

The following state arguments are supported:

ColumnFamilies List<TableColumnFamilyArgs>: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
InstanceName string: The name of the Bigtable instance.
Name string: The name of the table.
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.

ColumnFamilies []TableColumnFamily: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
InstanceName string: The name of the Bigtable instance.
Name string: The name of the table.
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.

columnFamilies TableColumnFamily[]: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
instanceName string: The name of the Bigtable instance.
name string: The name of the table.
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.

column_families List[TableColumnFamily]: A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
instance_name str: The name of the Bigtable instance.
name str: The name of the table.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
split_keys List[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.

Supporting Types

TableColumnFamily

See the input and output API doc for this type.

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.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud