Table
data class TableArgs(val automatedBackupPolicy: Output<TableAutomatedBackupPolicyArgs>? = null, val changeStreamRetention: Output<String>? = null, val columnFamilies: Output<List<TableColumnFamilyArgs>>? = null, val deletionProtection: Output<String>? = null, val instanceName: Output<String>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val splitKeys: Output<List<String>>? = null) : ConvertibleToJava<TableArgs>
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",
},
});Content copied to clipboard
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",
})Content copied to clipboard
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",
},
});
});Content copied to clipboard
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
})
}Content copied to clipboard
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());
}
}Content copied to clipboard
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: 24h0m0sContent copied to clipboard
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 thepulumi importcommand, 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}}Content copied to clipboard
$ pulumi import gcp:bigtable/table:Table default {{project}}/{{instance_name}}/{{name}}Content copied to clipboard
$ pulumi import gcp:bigtable/table:Table default {{instance_name}}/{{name}}Content copied to clipboard
Constructors
Link copied to clipboard
constructor(automatedBackupPolicy: Output<TableAutomatedBackupPolicyArgs>? = null, changeStreamRetention: Output<String>? = null, columnFamilies: Output<List<TableColumnFamilyArgs>>? = null, deletionProtection: Output<String>? = null, instanceName: Output<String>? = null, name: Output<String>? = null, project: Output<String>? = null, splitKeys: Output<List<String>>? = null)
Properties
Link copied to clipboard
Defines an automated backup policy for a table, specified by Retention Period and Frequency. To create a table with automated backup disabled, either omit the automated_backup_policy argument, or set both Retention Period and Frequency properties to "0". To disable automated backup on an existing table that has automated backup enabled, set both Retention Period and Frequency properties to "0". When updating an existing table, to modify the Retention Period or Frequency properties of the resource's automated backup policy, set the respective property to a non-zero value. If the automated_backup_policy argument is not provided in the configuration on update, the resource's automated backup policy will not be modified.
-----Link copied to clipboard
Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.
Link copied to clipboard
A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.
Link copied to clipboard
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.
Link copied to clipboard
The name of the Bigtable instance.