pulumi-gcp-kotlin/com.pulumi.gcp.bigtable.kotlin/TableArgs

TableArgs

data class TableArgs(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

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

Bigtable Tables can be imported using any of these accepted formats

$ 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}}

The following fields can't be read and will show diffs if set in config when imported- split_keys

Constructors

TableArgs

fun TableArgs(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)

Functions

toJava

open override fun toJava(): TableArgs

Properties

changeStreamRetention

val changeStreamRetention: Output<String>? = null

Duration to retain change stream data for the table. Set to 0 to disable. Must be between 1 and 7 days.

-----

columnFamilies

val columnFamilies: Output<List<TableColumnFamilyArgs>>? = null

A group of columns within a table which share a common configuration. This can be specified multiple times. Structure is documented below.

deletionProtection

val deletionProtection: Output<String>? = null

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

val instanceName: Output<String>? = null

The name of the Bigtable instance.

name

val name: Output<String>? = null

The name of the table. Must be 1-50 characters and must only contain hyphens, underscores, periods, letters and numbers.

project

val project: Output<String>? = null

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

splitKeys

val splitKeys: Output<List<String>>? = null

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.