Module bigtable

@pulumi/gcp > bigtable

class Instance

extends CustomResource

Creates a Google Bigtable instance. For more information see the official documentation and API.

Example Usage - Production Instance

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

const production_instance = new gcp.bigtable.Instance("production-instance", {
    clusters: [{
        clusterId: "tf-instance-cluster",
        numNodes: 3,
        storageType: "HDD",
        zone: "us-central1-b",
    }],
});

Example Usage - Development Instance

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

const development_instance = new gcp.bigtable.Instance("development-instance", {
    clusters: [{
        clusterId: "tf-instance-cluster",
        storageType: "HDD",
        zone: "us-central1-b",
    }],
    instanceType: "DEVELOPMENT",
});

constructor

new Instance(name: string, args: InstanceArgs, opts?: pulumi.CustomResourceOptions)

Create a Instance resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InstanceState, opts?: pulumi.CustomResourceOptions): Instance

Get an existing Instance resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clusters

public clusters: pulumi.Output<{
    clusterId: string;
    numNodes: undefined | number;
    storageType: undefined | string;
    zone: string;
}[]>;

A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.

property displayName

public displayName: pulumi.Output<string>;

The human-readable display name of the Bigtable instance. Defaults to the instance name.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceType

public instanceType: pulumi.Output<string | undefined>;

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

property name

public name: pulumi.Output<string>;

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

property project

public project: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Table

extends CustomResource

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", {
    clusterId: "tf-instance-cluster",
    numNodes: 3,
    storageType: "HDD",
    zone: "us-central1-b",
});
const table = new gcp.bigtable.Table("table", {
    instanceName: instance.name,
    splitKeys: [
        "a",
        "b",
        "c",
    ],
});

constructor

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

Create a Table resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TableState, opts?: pulumi.CustomResourceOptions): Table

Get an existing Table resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property columnFamilies

public columnFamilies: pulumi.Output<{
    family: string;
}[] | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property instanceName

public instanceName: pulumi.Output<string>;

The name of the Bigtable instance.

property name

public name: pulumi.Output<string>;

The name of the table.

property project

public project: pulumi.Output<string>;

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

property splitKeys

public splitKeys: pulumi.Output<string[] | undefined>;

A list of predefined keys to split the table on.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface InstanceArgs

The set of arguments for constructing a Instance resource.

property clusters

clusters: pulumi.Input<pulumi.Input<{
    clusterId: pulumi.Input<string>;
    numNodes: pulumi.Input<number>;
    storageType: pulumi.Input<string>;
    zone: pulumi.Input<string>;
}>[]>;

A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.

property displayName

displayName?: pulumi.Input<string>;

The human-readable display name of the Bigtable instance. Defaults to the instance name.

property instanceType

instanceType?: pulumi.Input<string>;

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

property name

name?: pulumi.Input<string>;

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

property project

project?: pulumi.Input<string>;

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

interface InstanceState

Input properties used for looking up and filtering Instance resources.

property clusters

clusters?: pulumi.Input<pulumi.Input<{
    clusterId: pulumi.Input<string>;
    numNodes: pulumi.Input<number>;
    storageType: pulumi.Input<string>;
    zone: pulumi.Input<string>;
}>[]>;

A block of cluster configuration options. This can be specified 1 or 2 times. See structure below.

property displayName

displayName?: pulumi.Input<string>;

The human-readable display name of the Bigtable instance. Defaults to the instance name.

property instanceType

instanceType?: pulumi.Input<string>;

The instance type to create. One of "DEVELOPMENT" or "PRODUCTION". Defaults to "PRODUCTION".

property name

name?: pulumi.Input<string>;

The name (also called Instance Id in the Cloud Console) of the Cloud Bigtable instance.

property project

project?: pulumi.Input<string>;

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

interface TableArgs

The set of arguments for constructing a Table resource.

property columnFamilies

columnFamilies?: pulumi.Input<pulumi.Input<{
    family: pulumi.Input<string>;
}>[]>;

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

property instanceName

instanceName: pulumi.Input<string>;

The name of the Bigtable instance.

property name

name?: pulumi.Input<string>;

The name of the table.

property project

project?: pulumi.Input<string>;

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

property splitKeys

splitKeys?: pulumi.Input<pulumi.Input<string>[]>;

A list of predefined keys to split the table on.

interface TableState

Input properties used for looking up and filtering Table resources.

property columnFamilies

columnFamilies?: pulumi.Input<pulumi.Input<{
    family: pulumi.Input<string>;
}>[]>;

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

property instanceName

instanceName?: pulumi.Input<string>;

The name of the Bigtable instance.

property name

name?: pulumi.Input<string>;

The name of the table.

property project

project?: pulumi.Input<string>;

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

property splitKeys

splitKeys?: pulumi.Input<pulumi.Input<string>[]>;

A list of predefined keys to split the table on.